Tool

Less than 1 minute

class Tool

Properties

what the tool does, shown to the model when it chooses a tool

public readonly string $description

Type: string

overrides the tool name, which otherwise defaults to the method name

public readonly string $name

Type: string

human-readable name for display in a client UI

public readonly string $title

Type: string

optional behavioural hints, treated as untrusted by clients

public readonly array $annotations

Type: array

JSON Schema describing the structured result, when the shape is known

public readonly array $outputSchema

Type: array

public __construct(string $description, string $name, string $title, array $annotations, array $outputSchema): void

Parameter	Type	Description
`$description`	string	what the tool does, shown to the model when it chooses a tool
`$name`	string	overrides the tool name, which otherwise defaults to the method name
`$title`	string	human-readable name for display in a client UI
`$annotations`	array	optional behavioural hints, treated as untrusted by clients
`$outputSchema`	array	JSON Schema describing the structured result, when the shape is known

Generated by Hazaar API Doc Generator on Sun, 23 Aug 2026 10:49:44 +0000