Struct ToolDefinition 

pub struct ToolDefinition {
    pub name: String,
    pub description: String,
    pub parameters_json_schema: Value,
    pub strict: Option<bool>,
    pub outer_typed_dict_key: Option<String>,
}

Complete tool definition sent to the model.

This contains all the information a language model needs to understand and call a tool, including its name, description, and parameter schema.

Fields

name: String

Tool name (must be a valid identifier).

description: String

Human-readable description of what the tool does.

parameters_json_schema: Value

JSON Schema for the tool’s parameters.

strict: Option<bool>

Whether to use strict mode for schema validation (OpenAI feature).

outer_typed_dict_key: Option<String>

Key for outer typed dict (pydantic-ai compatibility).

Implementations

impl ToolDefinition

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

Create a new tool definition.

pub fn with_parameters(self, schema: impl Into<Value>) -> ToolDefinition

Set the parameters schema.

pub fn with_strict(self, strict: bool) -> ToolDefinition

Set strict mode.

pub fn with_outer_typed_dict_key(self, key: impl Into<String>) -> ToolDefinition

Set the outer typed dict key.

pub fn name(&self) -> &str

Get the tool name.

pub fn description(&self) -> &str

Get the tool description.

pub fn parameters(&self) -> &Value

Get the parameters schema.

pub fn is_strict(&self) -> bool

Check if strict mode is enabled.

pub fn to_openai_function(&self) -> Value

Convert to OpenAI function format.

pub fn to_anthropic_tool(&self) -> Value

Convert to Anthropic tool format.

Trait Implementations

impl Clone for ToolDefinition

fn clone(&self) -> ToolDefinition

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<(), Error>

Formats the value using the given formatter.

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

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for ToolDefinition

fn eq(&self, other: &ToolDefinition) -> 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 ToolDefinition

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.

impl StructuralPartialEq for ToolDefinition