Struct Tool 

pub struct Tool {
    pub name: String,
    pub description: Option<String>,
    pub schema: Option<Value>,
}

Represents a tool definition that can be exposed to an agent.

This structure is used by ToolBox implementations in their tools_definitions function to describe the available tools to the language model.

Note: While this struct defines a tool, actual tool invocation is handled by a ToolBox implementing the ToolBox trait. You must use a ToolBox to call any defined tool.

The name field is required, while description and schema are optional but highly recommended for effective tool use by the agent.

Fields

name: String

The tool name, which is typically the function name e.g., get_weather

description: Option<String>

The description of the tool that will be used by the LLM to understand the context/usage of this tool

schema: Option<Value>

The JSON schema for the parameters e.g.,

json!({
"type": "object",
"properties": {
   "city": {
       "type": "string",
       "description": "The city name"
   },
   "country": {
       "type": "string",
       "description": "The most likely country of this city name"
   },
   "unit": {
       "type": "string",
       "enum": ["C", "F"],
       "description": "The temperature unit for the country. C for Celsius, and F for Fahrenheit"
   }
},
"required": ["city", "country", "unit"],
})

Implementations

impl Tool

Constructor

pub fn new(name: impl Into<String>) -> Tool

impl Tool

pub fn with_description(self, description: impl Into<String>) -> Tool

pub fn with_schema(self, parameters: Value) -> Tool

Trait Implementations

impl Clone for Tool

fn clone(&self) -> Tool

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Tool

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Tool

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for Tool

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.