Struct ToolInfo 

pub struct ToolInfo {
    pub name: String,
    pub description: String,
    pub parameters: Value,
    pub execution_mode: ExecutionMode,
}

Metadata describing a tool available for LLM function calling.

This information is typically sent to the LLM to describe what tools are available and how to call them.

Fields

name: String

Unique name identifying the tool.

description: String

Human-readable description of what the tool does.

Per Claude’s tool-use guidance, the description is the single most important factor for tool-calling performance. Write a detailed description (3-4+ sentences) covering what the tool does, when it should (and should not) be used, what each parameter means, and any caveats or limitations. Registering a tool with a missing or very short description logs a warning (see register_tool).

parameters: Value

JSON Schema describing the tool’s parameters.

Defaults to {"type": "object", "properties": {}} when no schema is provided (see ToolInfo::new).

execution_mode: ExecutionMode

How this tool may be scheduled relative to other calls in the same batch (see ExecutionMode). Internal execution metadata — never sent to the LLM.

Implementations

impl ToolInfo

pub fn new( name: impl Into<String>, description: impl Into<String>, parameters: Option<Value>, ) -> Self

Creates a new ToolInfo with the default Sequential execution mode.

When parameters is None, the empty-object JSON Schema {"type": "object", "properties": {}} is used so providers always receive a valid schema.

pub fn with_execution_mode(self, mode: ExecutionMode) -> Self

Sets the execution mode, typically to opt a read-only tool into parallel scheduling (see ExecutionMode).

Trait Implementations

impl Clone for ToolInfo

fn clone(&self) -> ToolInfo

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ToolInfo

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

Formats the value using the given formatter.

impl From<ToolInfo> for AgentValue

fn from(info: ToolInfo) -> Self

Converts to this type from the input type.