Skip to main content

Tool

robit_agent::tool

Trait Tool 

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

    // Provided method
    fn supports_async(&self) -> bool { ... }
}
Expand description

A tool that can be called by the LLM and executed by the Agent.

Required Methods§

Source

fn name(&self) -> &str

Tool name — LLM calls the tool by this name.

Source

fn description(&self) -> &str

Tool description — injected into system prompt for LLM understanding.

Source

fn parameters_schema(&self) -> Value

JSON Schema for tool parameters — LLM generates arguments based on this.

Source

fn requires_confirmation(&self) -> bool

Whether this tool requires user confirmation before execution.

Source

fn execute<'life0, 'life1, 'async_trait>( &'life0 self, args: Value, ctx: &'life1 ToolContext, ) -> Pin<Box<dyn Future<Output = Result<ToolResult>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Execute the tool with parsed arguments. Returns ToolResult for LLM consumption.

Provided Methods§

Source

fn supports_async(&self) -> bool

Whether this tool is capable of running asynchronously (returning a pending placeholder and finishing its work in the background).

This is advisory only - used by frontends/Agent for UI hints (e.g. showing a “task in progress” affordance). Whether a given invocation actually runs async is decided at runtime inside execute (e.g. based on the provider protocol or input size), by calling ctx.async_runner.submit(..) and returning ToolResult::pending(..). Tools that never run async should leave the default false.

Dyn Compatibility§

This trait is dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety".

Implementors§