Skip to main content

ToolRegistry

Struct ToolRegistry 

Source
pub struct ToolRegistry { /* private fields */ }
Expand description

Registry for external tools.

ToolRegistry stores registered tools and provides methods for invoking them with proper process lifecycle management.

§Example

use forge_agent::workflow::tools::{Tool, ToolRegistry, ToolInvocation};

let mut registry = ToolRegistry::new();

// Register magellan
let magellan = Tool::new("magellan", "/usr/bin/magellan")
    .default_args(vec!["--db".to_string(), ".forge/graph.db".to_string()])
    .description("Graph-based code indexer");
registry.register(magellan)?;

// Check registration
assert!(registry.is_registered("magellan"));

// List all tools
let tools = registry.list_tools();
assert!(tools.contains(&"magellan"));

Implementations§

Source§

impl ToolRegistry

Source

pub fn new() -> Self

Creates a new empty ToolRegistry.

§Example
use forge_agent::workflow::tools::ToolRegistry;

let registry = ToolRegistry::new();
assert_eq!(registry.len(), 0);
Source

pub fn register(&mut self, tool: Tool) -> Result<(), ToolError>

Registers a tool in the registry.

§Arguments
  • tool - Tool to register
§Returns
  • Ok(()) if registration succeeded
  • Err(ToolError::AlreadyRegistered) if tool with same name exists
§Example
use forge_agent::workflow::tools::{Tool, ToolRegistry};

let mut registry = ToolRegistry::new();
let tool = Tool::new("magellan", "/usr/bin/magellan");
registry.register(tool)?;
Source

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

Gets a tool by name.

§Arguments
  • name - Tool name to look up
§Returns
  • Some(&Tool) if tool exists
  • None if tool not found
§Example
use forge_agent::workflow::tools::{Tool, ToolRegistry};

let mut registry = ToolRegistry::new();
registry.register(Tool::new("magellan", "/usr/bin/magellan")).unwrap();

let tool = registry.get("magellan");
assert!(tool.is_some());
assert_eq!(tool.unwrap().name, "magellan");
Source

pub async fn invoke( &self, invocation: &ToolInvocation, ) -> Result<ToolInvocationResult, ToolError>

Invokes a tool with the given invocation parameters.

§Arguments
  • invocation - Tool invocation request
§Returns
  • Ok(ToolInvocationResult) with result and optional process guard
  • Err(ToolError) if tool not found or execution fails
§Example
use forge_agent::workflow::tools::{ToolRegistry, ToolInvocation, Tool};

let mut registry = ToolRegistry::new();
registry.register(Tool::new("echo", "/bin/echo")).unwrap();

let invocation = ToolInvocation::new("echo")
    .args(vec!["hello".to_string(), "world".to_string()]);

let result = registry.invoke(&invocation).await?;
assert!(result.result.success);
Source

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

Lists all registered tool names.

§Returns

Vector of tool names

§Example
use forge_agent::workflow::tools::{Tool, ToolRegistry};

let mut registry = ToolRegistry::new();
registry.register(Tool::new("magellan", "/usr/bin/magellan")).unwrap();
registry.register(Tool::new("cargo", "/usr/bin/cargo")).unwrap();

let tools = registry.list_tools();
assert_eq!(tools.len(), 2);
Source

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

Checks if a tool is registered.

§Arguments
  • name - Tool name to check
§Returns
  • true if tool is registered
  • false if tool is not registered
§Example
use forge_agent::workflow::tools::{Tool, ToolRegistry};

let mut registry = ToolRegistry::new();
registry.register(Tool::new("magellan", "/usr/bin/magellan")).unwrap();

assert!(registry.is_registered("magellan"));
assert!(!registry.is_registered("cargo"));
Source

pub fn len(&self) -> usize

Returns the number of registered tools.

§Example
use forge_agent::workflow::tools::{Tool, ToolRegistry};

let mut registry = ToolRegistry::new();
assert_eq!(registry.len(), 0);

registry.register(Tool::new("magellan", "/usr/bin/magellan")).unwrap();
assert_eq!(registry.len(), 1);
Source

pub fn is_empty(&self) -> bool

Returns true if the registry is empty.

§Example
use forge_agent::workflow::tools::ToolRegistry;

let registry = ToolRegistry::new();
assert!(registry.is_empty());
Source

pub fn with_standard_tools() -> Self

Creates a ToolRegistry with standard tools pre-registered.

This method attempts to discover and register commonly-used tools:

  • magellan (graph-based code indexer)
  • cargo (Rust package manager)
  • splice (precision code editor)

Tools that are not found are logged but don’t cause failure (graceful degradation).

§Returns

A ToolRegistry with discovered tools registered

§Example
use forge_agent::workflow::tools::ToolRegistry;

let registry = ToolRegistry::with_standard_tools();
// registry may have magellan, cargo, splice if they were found

Trait Implementations§

Source§

impl Clone for ToolRegistry

Source§

fn clone(&self) -> ToolRegistry

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Default for ToolRegistry

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more