Trait Tool 

pub trait Tool: Send + Sync {
    // Required methods
    fn name(&self) -> &str;
    fn description(&self) -> &str;
    fn parameters_schema(&self) -> Value;
    fn execute<'life0, 'life1, 'async_trait>(
        &'life0 self,
        args: Value,
        ctx: &'life1 mut AgentContext,
    ) -> Pin<Box<dyn Future<Output = Result<ToolOutput, ToolError>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait,
             'life1: 'async_trait;

    // Provided methods
    fn is_system(&self) -> bool { ... }
    fn is_read_only(&self) -> bool { ... }
    fn execute_readonly<'life0, 'life1, 'async_trait>(
        &'life0 self,
        args: Value,
        ctx: &'life1 AgentContext,
    ) -> Pin<Box<dyn Future<Output = Result<ToolOutput, ToolError>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait,
             'life1: 'async_trait { ... }
    fn to_def(&self) -> ToolDef { ... }
}

A tool that an agent can invoke.

Required Methods

fn name(&self) -> &str

fn description(&self) -> &str

fn parameters_schema(&self) -> Value

fn execute<'life0, 'life1, 'async_trait>( &'life0 self, args: Value, ctx: &'life1 mut AgentContext, ) -> Pin<Box<dyn Future<Output = Result<ToolOutput, ToolError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Provided Methods

fn is_system(&self) -> bool

fn is_read_only(&self) -> bool

fn execute_readonly<'life0, 'life1, 'async_trait>( &'life0 self, args: Value, ctx: &'life1 AgentContext, ) -> Pin<Box<dyn Future<Output = Result<ToolOutput, ToolError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Execute without mutable context (for parallel read-only dispatch). Default: delegates to execute with a cloned context. Override for true read-only tools to avoid the clone.

fn to_def(&self) -> ToolDef

Implementors