Struct ToolAnnotations 

pub struct ToolAnnotations {
    pub title: Option<String>,
    pub audience: Option<Vec<String>>,
    pub priority: Option<f64>,
    pub destructive_hint: Option<bool>,
    pub idempotent_hint: Option<bool>,
    pub open_world_hint: Option<bool>,
    pub read_only_hint: Option<bool>,
    pub custom: HashMap<String, Value>,
}

Tool-specific annotations for additional tool information

Fields

title: Option<String>

Title for display purposes - takes precedence over name for UI

audience: Option<Vec<String>>

Audience-specific information

priority: Option<f64>

Priority for ordering

destructive_hint: Option<bool>

If true, the tool may perform destructive updates to its environment

idempotent_hint: Option<bool>

If true, calling the tool repeatedly with same arguments has no additional effect

open_world_hint: Option<bool>

If true, this tool may interact with an “open world” of external entities

read_only_hint: Option<bool>

If true, the tool does not modify its environment

custom: HashMap<String, Value>

Additional custom annotations

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 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.