Struct DynamicTool 

pub struct DynamicTool { /* private fields */ }

A dynamically-constructed tool from a definition and execution function.

This is useful for wrapping external tool definitions (e.g., from extensions or plugins) into the AgentTool interface without requiring a dedicated struct.

Implementations

impl DynamicTool

pub fn new( name: impl Into<String>, label: impl Into<String>, description: impl Into<String>, parameters: Value, execute_fn: impl Fn(&str, Value, Option<Receiver<()>>) -> Pin<Box<dyn Future<Output = Result<AgentToolResult, ToolError>> + Send>> + Send + Sync + 'static, ) -> Self

Create a new dynamic tool from components.

pub fn from_definition( def: ToolDefinition, execute_fn: impl Fn(&str, Value, Option<Receiver<()>>) -> Pin<Box<dyn Future<Output = Result<AgentToolResult, ToolError>> + Send>> + Send + Sync + 'static, ) -> Self

Create a DynamicTool from a ToolDefinition with a simple execution function.

Trait Implementations

impl AgentTool for DynamicTool

fn name(&self) -> &str

Tool name (used in function calls)

fn label(&self) -> &str

Human-readable label

fn description(&self) -> &str

Description for the model

fn parameters_schema(&self) -> Value

JSON Schema for parameters

fn execute<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, tool_call_id: &'life1 str, params: Value, signal: Option<Receiver<()>>, _ctx: &'life2 ToolContext, ) -> Pin<Box<dyn Future<Output = Result<AgentToolResult, ToolError>> + Send + 'async_trait>>

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

Execute the tool with the given tool call ID and parameters.

fn essential(&self) -> bool

Whether this tool is essential (cannot be disabled). Essential tools: read, write, edit, bash, grep, find, ls Optional tools: web_search, github, subagent, etc.

fn on_progress(&self, _callback: ProgressCallback)

Called with progress updates during execution. Tools can override this to emit streaming updates.

fn to_definition(&self) -> ToolDefinition

Convert to ToolDefinition