Struct ToolSpec 

pub struct ToolSpec {
    pub name: String,
    pub description: String,
    pub input_schema: Value,
}

A tool’s name, purpose, and argument schema.

Fields

name: String

The name a model calls it by — what crate::effect::Effect::Tool and a crate::message::ContentBlock::ToolUse carry.

description: String

What it does — this is the text a model reads to decide whether to call it, so it is prompt, not documentation. Say when to use the tool, not only what it does: trigger conditions measurably raise the rate at which a model reaches for the right one.

input_schema: Value

JSON Schema for the arguments.

inputSchema on the wire (MCP’s spelling), input_schema also accepted so hand-written JSON in either convention loads.

Implementations

impl ToolSpec

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

A fully described tool. For one with nothing to configure, see Self::no_args.

pub fn no_args(name: impl Into<String>, description: impl Into<String>) -> Self

A tool taking no arguments.

pub fn required_args(&self) -> Vec<&str>

The argument names the schema marks required.

Trait Implementations

impl Clone for ToolSpec

fn clone(&self) -> ToolSpec

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ToolSpec

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ToolSpec

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for ToolSpec

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for ToolSpec

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 ToolSpec