Struct ToolDefinition 

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

A provider-neutral tool definition.

parameters is a JSON Schema object; every major LLM API takes that shape, under whatever key it calls it.

Fields

name: &'static str

The tool name the model calls.

description: String

What the tool does, as the model sees it.

parameters: Value

JSON Schema for the tool’s arguments.

Implementations

impl ToolDefinition

pub fn to_anthropic_value(&self) -> Value

Renders the definition in Anthropic’s Messages API shape: {name, description, input_schema}.

Named for the provider because the key is: Anthropic calls the schema input_schema, OpenAI nests it under function.parameters, and Gemini wants parameters with a restricted subset of JSON Schema. The struct’s own fields are the provider-neutral form; reach for those, or for ag_ui::Tool via From under the ag-ui feature, when the target is anything else.

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 From<ToolDefinition> for Tool

Offers a toolkit tool definition on an AG-UI run.

fn from(definition: ToolDefinition) -> Self

Converts to this type from the input type.

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 StructuralPartialEq for ToolDefinition