Struct ToolSet 

pub struct ToolSet { /* private fields */ }

A struct that holds a set of tools.

Tools are stored in an IndexMap keyed by name, so iteration (definitions, documents, schemas) follows registration order and the tool list sent to providers is deterministic across processes. Re-registering an existing name replaces the implementation but keeps its original position.

Implementations

impl ToolSet

pub fn from_tools(tools: Vec<impl ToolDyn + 'static>) -> Self

Create a new ToolSet from a list of tools

pub fn from_tools_boxed(tools: Vec<Box<dyn ToolDyn + 'static>>) -> Self

Create a new ToolSet from boxed dynamically-dispatched tools.

pub fn builder() -> ToolSetBuilder

Create a toolset builder

pub fn contains(&self, toolname: &str) -> bool

Check if the toolset contains a tool with the given name

pub fn add_tool(&mut self, tool: impl ToolDyn + 'static) -> String

Add a tool to the toolset, returning the registered key used for it.

pub fn add_tool_boxed(&mut self, tool: Box<dyn ToolDyn>) -> String

Adds a boxed tool to the toolset. Useful for situations when dynamic dispatch is required. Returns the registered key used for the tool.

pub fn delete_tool(&mut self, tool_name: &str)

Remove a tool by name. Missing tools are ignored.

pub fn add_tools(&mut self, toolset: ToolSet)

Merge another toolset into this one. Tools keep toolset’s registration order; names that already exist are replaced in place.

pub fn get_tool_definitions(&self) -> Result<Vec<ToolDefinition>, ToolSetError>

Return definitions for all tools currently registered in the set, in registration order.

pub async fn call( &self, toolname: &str, args: String, ) -> Result<String, ToolSetError>

Call a tool with the given name and arguments

pub async fn call_with_extensions( &self, toolname: &str, args: String, extensions: &ToolCallExtensions, ) -> Result<String, ToolSetError>

Call a tool with the given name, arguments, and per-call runtime extensions.

The extensions are threaded through to Tool::call_with_extensions, allowing tools to access caller-provided values (auth tokens, session IDs, etc.).

pub async fn call_structured( &self, toolname: &str, args: String, extensions: &ToolCallExtensions, ) -> ToolExecutionResult

Call a tool by name, returning the structured ToolExecutionResult.

The structured counterpart of call: a failure is carried as ToolOutcome::Error inside the result rather than a Result::Err, and an unknown tool name resolves to a NotFound outcome. This is the path the agent loop drives so hooks and telemetry observe the structured outcome.

pub async fn documents(&self) -> Result<Vec<Document>, ToolSetError>

Get the documents of all the tools in the toolset

pub fn schemas(&self) -> Result<Vec<ToolSchema>, EmbedError>

Convert tools in self to objects of type ToolSchema. This is necessary because when adding tools to the EmbeddingBuilder because all documents added to the builder must all be of the same type.

Trait Implementations

impl Default for ToolSet

fn default() -> ToolSet

Returns the “default value” for a type.