Reference documentation and code samples for the Agent Registry V1 API class Google::Cloud::AgentRegistry::V1::McpServer::Tool::Annotations.
Annotations describing the characteristics and behavior of a tool or operation.
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#destructive_hint
def destructive_hint() -> ::Boolean
Returns
-
(::Boolean) — 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 == falseDefault: true
#idempotent_hint
def idempotent_hint() -> ::Boolean
Returns
-
(::Boolean) — 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 == falseDefault: false
#open_world_hint
def open_world_hint() -> ::Boolean
Returns
- (::Boolean) — 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
def read_only_hint() -> ::Boolean
Returns
- (::Boolean) — Output only. If true, the tool does not modify its environment. Default: false
#title
def title() -> ::String
Returns
- (::String) — Output only. A human-readable title for the tool.