Struct ToolDefinition 

pub struct ToolDefinition { /* private fields */ }

Tool definition including schema for language models.

Used to provide language models with information about available Tools.

Implementations

impl ToolDefinition

pub fn new<T: Tool>(tool: &T) -> Self

Creates a tool definition for a given tool type.

The description comes from Tool::description, which by default reads the rustdoc on the tool’s Arguments type.

pub fn from_parts( name: Cow<'static, str>, description: Cow<'static, str>, schema: Value, ) -> Result<Self, InvalidSchema>

Creates a tool definition from raw parts.

This is useful for creating definitions from external sources like MCP servers.

Errors

Returns InvalidSchema if the value is not a JSON schema — that is, anything other than an object or a boolean. The schema often comes from a remote server, so this is a rejection to report, not a bug to panic on.

pub fn name(&self) -> &str

Returns the tool’s name.

pub fn description(&self) -> &str

Returns the tool’s description.

pub fn arguments_openai_schema(&self) -> Value

Return an OpenAI-compatible JSON schema for the tool’s arguments.

This schema would have an object type at the root, as required by OpenAI.

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 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