Struct ToolDefinition 

pub struct ToolDefinition {
    pub name: &'static str,
    pub description: &'static str,
    pub parameters: &'static str,
}

Definition of a tool that can be called by an LLM.

This struct holds the metadata about a tool: its name, description, and JSON Schema for parameters. It’s used for:

• Generating OpenAI/Anthropic-compatible tool specifications
• Validating input arguments
• Documentation

Example

use vex_llm::ToolDefinition;

const SEARCH_TOOL: ToolDefinition = ToolDefinition {
    name: "web_search",
    description: "Search the web for information",
    parameters: r#"{"type": "object", "properties": {"query": {"type": "string"}}}"#,
};

Fields

name: &'static str

Name of the tool (used in function calling) Must be unique within a registry

description: &'static str

Human-readable description of what the tool does

parameters: &'static str

JSON Schema for the tool’s parameters

Implementations

impl ToolDefinition

pub const fn new( name: &'static str, description: &'static str, parameters: &'static str, ) -> Self

Create a new tool definition

pub fn to_openai_format(&self) -> Value

Convert to OpenAI-compatible tool format

pub fn to_anthropic_format(&self) -> Value

Convert to Anthropic Claude-compatible 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

Formats the value using the given formatter.

impl Deserialize<'static> for ToolDefinition

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

where __D: Deserializer<'static>,

Deserialize this value from the given Serde deserializer.

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.