Google Cloud Agent Registry V1 Client - Class Annotations (0.2.0)

Reference documentation and code samples for the Google Cloud Agent Registry V1 Client class Annotations.

Annotations describing the characteristics and behavior of a tool or operation.

Generated from protobuf message google.cloud.agentregistry.v1.McpServer.Tool.Annotations

Namespace

Google \ Cloud \ AgentRegistry \ V1 \ McpServer \ Tool

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ title`	`string` Output only. A human-readable title for the tool.
`↳ destructive_hint`	`bool` Output only. If true, the tool may perform destructive updates to its environment. If false, the tool performs only additive updates. NOTE: This property is meaningful only when `read_only_hint == false` Default: true
`↳ idempotent_hint`	`bool` Output only. If true, calling the tool repeatedly with the same arguments will have no additional effect on its environment. NOTE: This property is meaningful only when `read_only_hint == false` Default: false
`↳ open_world_hint`	`bool` Output only. 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. Default: true
`↳ read_only_hint`	`bool` Output only. If true, the tool does not modify its environment. Default: false

getTitle

Output only. A human-readable title for the tool.

Returns
Type	Description
`string`

setTitle

Output only. A human-readable title for the tool.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getDestructiveHint

Output only. If true, the tool may perform destructive updates to its environment. If false, the tool performs only additive updates. NOTE: This property is meaningful only when read_only_hint == false Default: true

Returns
Type	Description
`bool`

setDestructiveHint

Parameter
Name	Description
`var`	`bool`

Returns
Type	Description
`$this`

getIdempotentHint

Output only. If true, calling the tool repeatedly with the same arguments will have no additional effect on its environment. NOTE: This property is meaningful only when read_only_hint == false Default: false

Returns
Type	Description
`bool`

setIdempotentHint

Parameter
Name	Description
`var`	`bool`

Returns
Type	Description
`$this`

getOpenWorldHint

Output only. 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. Default: true

Returns
Type	Description
`bool`

setOpenWorldHint

Parameter
Name	Description
`var`	`bool`

Returns
Type	Description
`$this`

getReadOnlyHint

Output only. If true, the tool does not modify its environment.

Default: false

Returns
Type	Description
`bool`

setReadOnlyHint