Struct ToolAnnotations 

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

Tool annotations (hints for LLMs about tool behavior)

NOTE: All properties are hints. They are not guaranteed to provide a faithful description of tool behavior. Clients should never make tool use decisions based on annotations from untrusted servers.

Fields

title: Option<String>

Human-readable title for the tool

read_only_hint: Option<bool>

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

destructive_hint: Option<bool>

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

idempotent_hint: Option<bool>

If true, calling the tool repeatedly with the same arguments will have no additional effect on its environment. (Only meaningful when readOnlyHint is 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. Default: true

Trait Implementations

impl Clone for ToolAnnotations

fn clone(&self) -> ToolAnnotations

Returns a duplicate 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 PartialEq for ToolAnnotations

fn eq(&self, other: &ToolAnnotations) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

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.

impl StructuralPartialEq for ToolAnnotations