Struct ToolBox 

pub struct ToolBox { /* private fields */ }

A name-keyed registry of tools available to an agent.

ToolBox owns its tools behind Arc<Box<dyn ToolDyn>>, so cloning the box is cheap and the same set of tools can be shared across concurrent invocations. Tools are stored in a BTreeMap, so iteration order is stable and sorted by name.

Implementations

impl ToolBox

pub fn new() -> Self

Creates an empty ToolBox.

pub fn len(&self) -> usize

Returns the number of registered tools.

pub fn render_tools(&self, details: bool) -> Vec<String>

Renders the registered tool names, optionally with their descriptions.

When details is true each entry is formatted as `name`: "description"; otherwise only the bare name is returned. Useful when surfacing the tool list inside a system prompt.

pub fn extend(&mut self, rhs: Self)

Merges another ToolBox into self. Tools in rhs overwrite any existing entries that share a name.

pub fn has_tool(&self, tool: &String) -> bool

Returns whether a tool with the given name is registered.

pub fn mcp_tools(&self) -> Vec<Tool>

Renders every registered tool as an MCP rmcp::model::Tool descriptor.

pub fn openai_objects(&self) -> Vec<ChatCompletionTools>

Renders every registered tool as an OpenAI ChatCompletionTools entry, ready to be attached to a chat completion request.

pub fn add_tool<T: Tool + 'static>(&mut self, tool: T)

Registers a typed Tool. Equivalent to boxing it and calling Self::add_dyn_tool.

pub fn add_dyn_tool(&mut self, tool: Box<dyn ToolDyn>)

Registers an already-erased ToolDyn. The tool’s ToolDyn::name is used as the registry key, so adding a tool whose name collides with an existing one will replace the previous entry.

pub async fn invoke( &self, tool_name: String, arguments: String, ) -> Option<Result<String, LLMYError>>

Invokes a single tool by name with the given JSON-encoded arguments.

Returns None if no tool with that name is registered. Otherwise returns Some with the tool’s result (or an LLMYError from argument parsing or the tool itself).

pub async fn invoke_value( &self, tool_name: String, arguments: Value, ) -> Option<Result<String, LLMYError>>

pub async fn invoke_many( &self, calls: Vec<GeneralToolCall>, ) -> Vec<(GeneralToolCall, Option<Result<String, LLMYError>>)>

Concurrently invokes every call in calls, spawning each one onto a tokio::task::JoinSet.

Each result is paired with the original GeneralToolCall so the caller can correlate it back to a specific invocation. Use Self::invoke_many_sequential when ordering matters or when tools must not run in parallel.

pub async fn invoke_many_sequential( &self, calls: Vec<GeneralToolCall>, ) -> Vec<(GeneralToolCall, Option<Result<String, LLMYError>>)>

Sequentially invokes every call in calls, awaiting each one before starting the next. Preserves input order and avoids any concurrency between tools — pick this over Self::invoke_many when tools share non-Sync state or must observe one another’s side effects.

pub async fn agent_invoke_many( &self, calls: Vec<GeneralToolCall>, ) -> Vec<(GeneralToolCall, Option<Result<ChatCompletionRequestMessageRaw, LLMYError>>)>

Concurrent variant of Self::invoke_many that wraps each successful result in a [ChatCompletionRequestMessage] (a tool message tagged with the originating tool_id), ready to be appended to a conversation history.

pub async fn agent_invoke_many_sequential( &self, calls: Vec<GeneralToolCall>, ) -> Vec<(GeneralToolCall, Option<Result<ChatCompletionRequestMessageRaw, LLMYError>>)>

Sequential variant of Self::agent_invoke_many.

Trait Implementations

impl Clone for ToolBox

fn clone(&self) -> ToolBox

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ToolBox

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

Formats the value using the given formatter.

impl Default for ToolBox

fn default() -> ToolBox

Returns the “default value” for a type.