Struct ToolAnnotations 

#[non_exhaustive]
pub struct ToolAnnotations {
    pub read_only: Option<bool>,
    pub destructive: Option<bool>,
    pub idempotent: Option<bool>,
    pub open_world: Option<bool>,
}

What a tool’s source says about its effects. Hints, not guarantees: MCP’s own wording, and a server can lie. None is “the source said nothing”, which is not the same as Some(false) — a tool with no read_only claim is a tool the consumer knows nothing about, not one that writes.

Owned here rather than borrowed from rmcp so this crate stays free of MCP; the bridge maps between the two.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

read_only: Option<bool>

The tool does not modify its environment.

destructive: Option<bool>

The tool may perform destructive updates (meaningful when not read-only).

idempotent: Option<bool>

Repeating a call with the same arguments has no further effect.

open_world: Option<bool>

The tool reaches an open world of external entities (a web search), as opposed to a closed one (a memory store).

Implementations

impl ToolAnnotations

pub fn new() -> Self

pub fn read_only(self, value: bool) -> Self

pub fn destructive(self, value: bool) -> Self

pub fn idempotent(self, value: bool) -> Self

pub fn open_world(self, value: bool) -> Self

pub fn is_empty(&self) -> bool

Whether the source said nothing at all.

Trait Implementations

impl Clone for ToolAnnotations

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for ToolAnnotations

impl Debug for ToolAnnotations

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

Formats the value using the given formatter.

impl Default for ToolAnnotations

fn default() -> Self

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 Eq for ToolAnnotations

impl PartialEq for ToolAnnotations

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

Equality operator ==.

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

Inequality operator !=.

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