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

Additional metadata about a tool to help clients decide how to display or control its use.

Fields

title: Option<String>

A human-readable title for the tool.

read_only_hint: Option<bool>

If true, the tool does not modify its environment.

destructive_hint: Option<bool>

If true, the tool may perform destructive updates.

idempotent_hint: Option<bool>

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

open_world_hint: Option<bool>

If true, the tool interacts with the external world.

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<'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 JsonSchema for ToolAnnotations

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

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