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>,
}

Provides additional, optional metadata about a tool.

These annotations offer hints to clients and LLMs about the tool’s behavior, helping them make more informed decisions about when and how to use the tool.

Fields

title: Option<String>

A user-friendly title for the tool, which may be used in UIs instead of the programmatic name.

audience: Option<Vec<String>>

Specifies the intended audience for the tool (e.g., “developer”, “admin”).

priority: Option<f64>

A numeric value indicating the tool’s priority, useful for sorting or ranking.

destructive_hint: Option<bool>

If true, hints that the tool may perform destructive actions (e.g., deleting data).

idempotent_hint: Option<bool>

If true, hints that calling the tool multiple times with the same arguments will not have additional effects.

open_world_hint: Option<bool>

If true, hints that the tool may interact with external systems or the real world.

read_only_hint: Option<bool>

If true, hints that the tool does not modify any state and only reads data.

custom: HashMap<String, Value>

A map for any other custom annotations not defined in the specification.

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.