Tool

adk_rust

Trait Tool 

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

    // Provided methods
    fn enhanced_description(&self) -> String { ... }
    fn is_long_running(&self) -> bool { ... }
    fn parameters_schema(&self) -> Option<Value> { ... }
    fn response_schema(&self) -> Option<Value> { ... }
}
Expand description

Core traits and types.

Always available regardless of feature flags. Includes:

  • Agent - The fundamental trait for all agents
  • Tool / Toolset - For extending agents with capabilities
  • Session / State - For managing conversation context
  • Event - For streaming agent responses
  • AdkError / Result - Unified error handling

Required Methods§

Source

fn name(&self) -> &str

Source

fn description(&self) -> &str

Source

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

Provided Methods§

Source

fn enhanced_description(&self) -> String

Returns an enhanced description that may include additional notes. For long-running tools, this includes a warning not to call the tool again if it has already returned a pending status. Default implementation returns the base description.

Source

fn is_long_running(&self) -> bool

Indicates whether the tool is a long-running operation. Long-running tools typically return a task ID immediately and complete the operation asynchronously.

Source

fn parameters_schema(&self) -> Option<Value>

Source

fn response_schema(&self) -> Option<Value>

Implementors§