Struct ToolDefinition 

pub struct ToolDefinition {
    pub name: ToolName,
    pub description: String,
    pub parameters: Value,
    pub annotations: ToolAnnotations,
}

A tool the model may call: its name, description and argument schema, sent to the model, and what the tool does to the world (ToolAnnotations), which stays with the host.

Fields

name: ToolName

Tool name exposed to the model. It must match the registered tool name.

description: String

Human-readable description sent to the model.

parameters: Value

JSON Schema describing tool arguments.

annotations: ToolAnnotations

What calling the tool does to the world, for the host’s policies (approval, plan mode, running calls side by side). Never sent to the model; written only when something is stated.

Implementations

impl ToolDefinition

pub fn new( name: ToolName, description: impl Into<String>, parameters: Value, ) -> Self

A tool the model may call by name, with arguments matching the JSON Schema parameters, and no annotations.

pub fn with_annotations(self, annotations: ToolAnnotations) -> Self

The same definition with annotations.

Trait Implementations

impl Clone for ToolDefinition

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 ToolDefinition

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ToolDefinition

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for ToolDefinition

impl From<ToolDefinition> for ResponsesToolDefinition

fn from(value: ToolDefinition) -> Self

Converts to this type from the input type.

impl PartialEq for ToolDefinition

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for ToolDefinition

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 ToolDefinition