Struct ToolAnnotations

pub struct ToolAnnotations {
    pub destructive_hint: Option<bool>,
    pub idempotent_hint: Option<bool>,
    pub open_world_hint: Option<bool>,
    pub read_only_hint: Option<bool>,
    pub title: Option<String>,
}

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.

JSON schema

{
 "description": "Additional properties describing a Tool to clients.\n\nNOTE: all properties in ToolAnnotations are **hints**.\nThey are not guaranteed to provide a faithful description of\ntool behavior (including descriptive properties like title).\n\nClients should never make tool use decisions based on ToolAnnotations\nreceived from untrusted servers.",
 "type": "object",
 "properties": {
   "destructiveHint": {
     "description": "If true, the tool may perform destructive updates to its environment.\nIf false, the tool performs only additive updates.\n\n(This property is meaningful only when readOnlyHint == false)\n\nDefault: true",
     "type": "boolean"
   },
   "idempotentHint": {
     "description": "If true, calling the tool repeatedly with the same arguments\nwill have no additional effect on the its environment.\n\n(This property is meaningful only when readOnlyHint == false)\n\nDefault: false",
     "type": "boolean"
   },
   "openWorldHint": {
     "description": "If true, this tool may interact with an \"open world\" of external\nentities. If false, the tool's domain of interaction is closed.\nFor example, the world of a web search tool is open, whereas that\nof a memory tool is not.\n\nDefault: true",
     "type": "boolean"
   },
   "readOnlyHint": {
     "description": "If true, the tool does not modify its environment.\n\nDefault: false",
     "type": "boolean"
   },
   "title": {
     "description": "A human-readable title for the tool.",
     "type": "string"
   }
 }
}

Fields

destructive_hint: Option<bool>

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

idempotent_hint: Option<bool>

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

open_world_hint: Option<bool>

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: Option<bool>

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

title: Option<String>

A human-readable title for the tool.

Trait Implementations

impl Clone for ToolAnnotations

fn clone(&self) -> ToolAnnotations

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ToolAnnotations

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for ToolAnnotations

fn default() -> ToolAnnotations

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ToolAnnotations

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for ToolAnnotations

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.