Struct ToolRegistry 

pub struct ToolRegistry { /* private fields */ }

Registry of tools available to an agent.

Stores tools in a HashMap for O(1) lookup by name and supports aliases (e.g., "bash_exec" → "exec") that are resolved transparently but not exposed in definitions() or list().

Implementations

impl ToolRegistry

pub fn new() -> Self

Create an empty tool registry.

pub fn set_gate(&mut self, gate: Arc<dyn ToolGate>)

Check every call with gate before it runs. Clones of the registry keep it.

pub fn gate(&self) -> Option<&Arc<dyn ToolGate>>

The gate calls pass, if any.

pub fn set_truncate_on_overflow(&mut self, enabled: bool)

When true, oversized output is truncated and dropped. Default: false (the full output is saved to a temp file and the agent gets a truncated preview with the file’s path). Those files are deleted when the registry and all its clones are dropped.

pub fn register(&mut self, tool: Arc<dyn Tool>)

Register a tool (replaces existing tool with same name).

pub fn remove(&mut self, name: &str) -> bool

Remove a tool by name. Returns true if the tool was present.

pub fn strip_prefixes(&mut self, prefixes: &[&str])

Remove every tool whose name starts with one of prefixes. Aliases pointing at removed tools are also dropped.

pub fn alias(&mut self, alias: &str, target: &str)

Register an alias so that lookups for alias resolve to target. Aliases are not exposed in definitions() or list().

pub fn get(&self, name: &str) -> Option<&Arc<dyn Tool>>

Look up a tool by name (checks aliases if direct lookup fails). Always resolves any registered tool, even if not in the active set.

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

Returns true if a tool with the given name is registered (without logging).

pub fn retain(&mut self, f: impl FnMut(&str) -> bool)

Keep only tools whose name satisfies the predicate.

pub fn list(&self) -> Vec<&str>

List all registered tool names (sorted).

pub fn list_with_descriptions(&self) -> Vec<(&str, &str)>

List all registered tools with their names and descriptions (sorted by name).

pub async fn execute( &self, call: &ToolCall, working_dir: Option<&PathBuf>, cancel_token: &CancellationToken, ) -> ToolResult

Execute a tool call from the LLM.

Looks up the tool by name, builds a ToolContext, and runs it. Returns a ToolResult::Failure if the tool is not found or if execution errors. If the tool defines timeout_secs, the call is wrapped in a timeout. Tools without a timeout are cancelled immediately when cancel_token fires.

pub async fn execute_with_progress( &self, call: &ToolCall, working_dir: Option<&PathBuf>, cancel_token: &CancellationToken, progress_tx: UnboundedSender<String>, ) -> ToolResult

Like Self::execute but attaches a progress channel so tools can stream incremental output (e.g. stdout lines from bash).

pub async fn execute_in_context( &self, call: &ToolCall, ctx: ToolContext<'_>, ) -> ToolResult

Execute with parent configuration and optional progress reporting.

pub fn is_concurrent(&self, call: &ToolCall) -> bool

Whether call may run alongside other calls. Unknown tools fail at once, so they count as concurrent.

pub fn supports_background(&self, call: &ToolCall) -> bool

pub fn humanize(&self, call: &ToolCall) -> String

Human-readable summary of a tool call’s arguments.

pub fn definitions(&self) -> Vec<ToolDefinition>

Generate LLM tool definitions for all registered tools.

Trait Implementations

impl Clone for ToolRegistry

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Default for ToolRegistry

fn default() -> Self

Returns the “default value” for a type.