Struct ToolRegistry 

pub struct ToolRegistry { /* private fields */ }

Stable since 0.63.0

Tool registry for managing available tools

Implementations

impl ToolRegistry

pub fn new() -> ToolRegistry

Creates an empty tool registry.

pub fn set_mcp_manager(&self, mgr: Arc<McpManager>)

Attach an McpManager to this registry. Replaces any previous one.

pub fn mcp_manager(&self) -> Option<Arc<McpManager>>

Get the attached McpManager, if any.

pub fn register(&self, tool: impl AgentTool + 'static)

Register a tool

pub fn register_arc(&self, tool: Arc<dyn AgentTool>)

Register a tool that is already wrapped in an Arc. This is the primary path for extensions that produce Arc<dyn AgentTool>.

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

Get a tool by name

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

Unregister a tool by name. Returns true if the tool was present and removed.

pub fn names(&self) -> Vec<String>

List all registered tool names

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

Get all tool definitions

pub fn get_tools(&self) -> Vec<Arc<dyn AgentTool>>

Get all tools as a slice

pub fn has_all(&self, required: &[&str]) -> bool

Check whether all tools in required are registered.

Useful for validating program/module dependencies before execution.

Example

use oxicode_agent::ToolRegistry;
let registry = ToolRegistry::new();
assert!(!registry.has_all(&["read", "write"]));

pub fn missing<'a>(&self, required: &[&'a str]) -> Vec<&'a str>

Return the subset of required tool names that are not registered.

Example

use oxicode_agent::ToolRegistry;
let registry = ToolRegistry::new();
let missing = registry.missing(&["read", "exec", "nonexistent"]);
assert_eq!(missing, vec!["read", "exec", "nonexistent"]);

pub fn with_builtins() -> ToolRegistry

Create a registry with all built-in tools

Examples

use oxicode_agent::ToolRegistry;
let registry = ToolRegistry::with_builtins();
let tools = registry.names();
assert!(tools.contains(&"read".to_string()));
assert!(tools.contains(&"write".to_string()));
assert!(tools.contains(&"bash".to_string()));

pub fn with_builtins_cwd( cwd: PathBuf, disabled_tools: &[String], ) -> ToolRegistry

Create a registry with all built-in tools, using the given cwd.

Pass disabled_tools to selectively disable built-in tools (e.g. ["web_search", "github_search"] for a minimal setup).

pub fn extend_from(&self, other: &ToolRegistry)

Extend this registry with all tools from another registry.

Useful for composing tool sets from multiple sources (e.g., coding tools + kernel tools + browser tools).

Example

let base = ToolRegistry::new();
base.extend_from(&other_registry);

pub fn with_selected_tools(cwd: PathBuf, names: &[&str]) -> ToolRegistry

Create registry with selected builtins only.

Trait Implementations

impl Clone for ToolRegistry

fn clone(&self) -> ToolRegistry

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Default for ToolRegistry

fn default() -> ToolRegistry

Returns the “default value” for a type.