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

Source-neutral tool behavior hints. These hints describe expected behavior; they do not enforce permissions or retry safety.

Examples

use tools_kit::declaration::ToolAnnotations;
let hints = ToolAnnotations { read_only_hint: Some(true), ..Default::default() };
assert_eq!(hints.read_only_hint, Some(true));

Fields

title: Option<String>

Optional model-visible title.

read_only_hint: Option<bool>

Whether execution is expected to avoid environmental mutation.

destructive_hint: Option<bool>

Whether execution may perform destructive changes.

idempotent_hint: Option<bool>

Whether repeating the same invocation is expected to be safe.

open_world_hint: Option<bool>

Whether execution may interact with entities outside a closed domain.

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