Class Nexus\Mcp\Schema\Tool\ToolAnnotations

`final`
`readonly`
`implements`	`JsonSerializable, Arrayable<array{title?: non-empty-string, readonlyHint?: bool, destructiveHint?: bool, idempotentHint?: bool, openWorldHint?: bool}>`

Additional properties describing a Tool to clients. NOTE: all properties in ToolAnnotations are hints. They are not guaranteed to provide a faithful description of tool behavior (including descriptive properties like title). Clients should never make tool use decisions based on ToolAnnotations received from untrusted servers.

Located at Schema/Tool/ToolAnnotations.php

Methods


					
	public

__construct(
	null|non-empty-string $title = null,
	null|bool $readOnlyHint = null,
	null|bool $destructiveHint = null,
	null|bool $idempotentHint = null,
	null|bool $openWorldHint = null,
)

Parameters

`$title`	A human-readable title for the tool.
`$readOnlyHint`	If true, the tool does not modify its environment.
`$destructiveHint`	If true, the tool may perform destructive updates to its environment. If false, the tool performs only additive updates.
`$idempotentHint`	If true, calling the tool repeatedly with the same arguments will have no additional effect on the its environment.
`$openWorldHint`	If true, this tool may interact with an “open world” of external entities. If false, the tool’s domain of interaction is closed. For example, the world of a web search tool is open, whereas that of a memory tool is not.


					
	public

toArray(): array

Implements

Nexus\Mcp\Schema\Arrayable::toArray()


					
	public

jsonSerialize(): template-type<self, Arrayable, 'T'>

Properties
`public`	`null\|non-empty-string`	`$title` A human-readable title for the tool. A human-readable title for the tool.	#
`public`	`null\|bool`	`$readOnlyHint` If true, the tool does not modify its environment. If true, the tool does not modify its environment.	#
`public`	`null\|bool`	`$destructiveHint` If true, the tool may perform destructive updates to its environment. If false, the tool performs only additive updates. If true, the tool may perform destructive updates to its environment. If false, the tool performs only additive updates.	#
`public`	`null\|bool`	`$idempotentHint` If true, calling the tool repeatedly with the same arguments will have no additional effect on the its environment. If true, calling the tool repeatedly with the same arguments will have no additional effect on the its environment.	#
`public`	`null\|bool`	`$openWorldHint` If true, this tool may interact with an “open world” of external entities. If false, the tool’s domain of interaction is closed. For example, the world of a web search tool is open, whereas that of a memory tool is not. If true, this tool may interact with an “open world” of external entities. If false, the tool’s domain of interaction is closed. For example, the world of a web search tool is open, whereas that of a memory tool is not.	#

Namespaces

Classes

Class Nexus\Mcp\Schema\Tool\ToolAnnotations

Parameters

Implements