Struct ToolSchema 

pub struct ToolSchema {
    pub name: String,
    pub description: String,
    pub params: Vec<ParamSchema>,
    pub examples: Vec<Example>,
    pub map_positionals: bool,
}

Schema describing a tool’s interface.

Fields

name: String

Tool name.

description: String

Short description.

params: Vec<ParamSchema>

Parameter definitions.

examples: Vec<Example>

Usage examples.

map_positionals: bool

Map remaining positional args to named params by schema order. Only for MCP/external tools that expect named JSON params. Builtins handle their own positionals and should leave this false.

Implementations

impl ToolSchema

pub fn new( name: impl Into<String>, description: impl Into<String>, ) -> ToolSchema

Create a new tool schema.

pub fn with_positional_mapping(self) -> ToolSchema

Enable positional->named parameter mapping for MCP/external tools.

pub fn param(self, param: ParamSchema) -> ToolSchema

Add a parameter to the schema.

pub fn example( self, description: impl Into<String>, code: impl Into<String>, ) -> ToolSchema

Add an example to the schema.

Trait Implementations

impl Clone for ToolSchema

fn clone(&self) -> ToolSchema

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ToolSchema

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ToolSchema

fn deserialize<__D>( __deserializer: __D, ) -> Result<ToolSchema, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for ToolSchema

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.