Struct ToolAnnotations 

pub struct ToolAnnotations {
    pub read_only_hint: bool,
    pub destructive_hint: bool,
    pub idempotent_hint: bool,
    pub needs_approval_hint: bool,
    pub supports_streaming_hint: bool,
}

Hints that describe behavioural properties of a tool.

These flags are advisory — they influence UI presentation and permission policies but do not enforce behaviour at runtime. For example, a permission policy may automatically require approval for tools that set destructive_hint to true.

Fields

read_only_hint: bool

The tool only reads data and has no side-effects.

destructive_hint: bool

The tool may perform destructive operations (e.g. file deletion).

idempotent_hint: bool

Repeated calls with the same input produce the same effect.

needs_approval_hint: bool

The tool should prompt for user approval before execution.

supports_streaming_hint: bool

The tool can stream partial results during execution.

Implementations

impl ToolAnnotations

pub fn new() -> Self

Builds the default advisory flags.

pub fn read_only() -> Self

Marks the tool as read-only.

pub fn destructive() -> Self

Marks the tool as destructive.

pub fn needs_approval() -> Self

Marks the tool as requiring approval.

pub fn streaming() -> Self

Marks the tool as supporting streaming.

pub fn with_read_only(self, read_only_hint: bool) -> Self

pub fn with_destructive(self, destructive_hint: bool) -> Self

pub fn with_idempotent(self, idempotent_hint: bool) -> Self

pub fn with_needs_approval(self, needs_approval_hint: bool) -> Self

pub fn with_supports_streaming(self, supports_streaming_hint: bool) -> Self

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

impl StructuralPartialEq for ToolAnnotations