Struct ContextTool 

pub struct ContextTool { /* private fields */ }

A tool from a closure that receives the ToolContext.

Implementations

impl ContextTool

pub fn new<F, Fut>( name: impl Into<String>, description: impl Into<String>, parameters: Option<Value>, f: F, ) -> ContextTool

where F: Fn(Value, ToolContext) -> Fut + Send + Sync + 'static, Fut: Future<Output = Result<Value, ToolError>> + Send + 'static,

A tool named name running f(args, ctx). parameters is the JSON Schema of its arguments (None for none).

Trait Implementations

impl ToolFunction for ContextTool

fn name(&self) -> &str

The unique name of this tool.

fn description(&self) -> &str

Human-readable description of what this tool does.

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

JSON Schema for the tool’s input parameters, or None if parameterless.

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

where 'life0: 'async_trait, ContextTool: 'async_trait,

Execute the tool with the given arguments and return the result.

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

where 'life0: 'async_trait, ContextTool: 'async_trait,

Execute the tool knowing the session it runs in: its State, the call’s id, and a cancellation token (see ToolContext).

fn requires_confirmation(&self) -> bool

Whether this tool must be confirmed before it runs. Defaults to false.

fn confirmation_message(&self) -> Option<&str>

Optional hint shown when confirmation is requested.