Interface McpServer.Tool.AnnotationsOrBuilder (0.2.0)

public static interface McpServer.Tool.AnnotationsOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getDestructiveHint()

public abstract boolean 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

bool destructive_hint = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`boolean`	The destructiveHint.

getIdempotentHint()

public abstract boolean 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

bool idempotent_hint = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`boolean`	The idempotentHint.

getOpenWorldHint()

public abstract boolean 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

bool open_world_hint = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`boolean`	The openWorldHint.

getReadOnlyHint()

public abstract boolean getReadOnlyHint()

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

bool read_only_hint = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`boolean`	The readOnlyHint.

getTitle()

public abstract String getTitle()

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

string title = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`String`	The title.

getTitleBytes()

public abstract ByteString getTitleBytes()