pub trait Tool<M: InputSender>: Send + Sync {
// Required methods
fn name(&self) -> &str;
fn description(&self) -> &str;
fn parameters(&self) -> Value;
fn execute<'life0, 'life1, 'async_trait>(
&'life0 self,
args: Value,
id: ToolCallId,
call_id: Option<ProviderCallId>,
context: &'life1 ToolContext<M>,
) -> Pin<Box<dyn Future<Output = Result<(), Box<dyn Error + Send + Sync>>> + Send + 'async_trait>>
where Self: 'async_trait,
'life0: 'async_trait,
'life1: 'async_trait;
// Provided methods
fn supports_sync(&self) -> bool { ... }
fn is_passive(&self) -> bool { ... }
fn display_script(&self) -> Option<&str> { ... }
fn execute_synchronous<'life0, 'life1, 'life2, 'life3, 'life4, 'async_trait>(
&'life0 self,
_args: &'life1 Value,
_id: &'life2 ToolCallId<str>,
_call_id: Option<&'life3 ProviderCallId<str>>,
_context: &'life4 ToolContext<M>,
) -> Pin<Box<dyn Future<Output = Option<ToolResult>> + Send + 'async_trait>>
where Self: 'async_trait,
'life0: 'async_trait,
'life1: 'async_trait,
'life2: 'async_trait,
'life3: 'async_trait,
'life4: 'async_trait { ... }
}Required Methods§
fn name(&self) -> &str
fn description(&self) -> &str
fn parameters(&self) -> Value
fn execute<'life0, 'life1, 'async_trait>(
&'life0 self,
args: Value,
id: ToolCallId,
call_id: Option<ProviderCallId>,
context: &'life1 ToolContext<M>,
) -> Pin<Box<dyn Future<Output = Result<(), Box<dyn Error + Send + Sync>>> + Send + 'async_trait>>where
Self: 'async_trait,
'life0: 'async_trait,
'life1: 'async_trait,
Provided Methods§
fn supports_sync(&self) -> bool
Sourcefn is_passive(&self) -> bool
fn is_passive(&self) -> bool
Whether a dispatched call to this tool represents waiting rather than in-flight work (e.g. the sleep tools). While a thread’s last history entry is an unanswered call to a non-passive tool, deferrable synthetic events are held back so they don’t interrupt the running call; calls to passive tools may be interrupted freely.
Sourcefn display_script(&self) -> Option<&str>
fn display_script(&self) -> Option<&str>
Optional Rhai script for pretty-printing this tool call.
Sourcefn execute_synchronous<'life0, 'life1, 'life2, 'life3, 'life4, 'async_trait>(
&'life0 self,
_args: &'life1 Value,
_id: &'life2 ToolCallId<str>,
_call_id: Option<&'life3 ProviderCallId<str>>,
_context: &'life4 ToolContext<M>,
) -> Pin<Box<dyn Future<Output = Option<ToolResult>> + Send + 'async_trait>>where
Self: 'async_trait,
'life0: 'async_trait,
'life1: 'async_trait,
'life2: 'async_trait,
'life3: 'async_trait,
'life4: 'async_trait,
fn execute_synchronous<'life0, 'life1, 'life2, 'life3, 'life4, 'async_trait>(
&'life0 self,
_args: &'life1 Value,
_id: &'life2 ToolCallId<str>,
_call_id: Option<&'life3 ProviderCallId<str>>,
_context: &'life4 ToolContext<M>,
) -> Pin<Box<dyn Future<Output = Option<ToolResult>> + Send + 'async_trait>>where
Self: 'async_trait,
'life0: 'async_trait,
'life1: 'async_trait,
'life2: 'async_trait,
'life3: 'async_trait,
'life4: 'async_trait,
Execute the tool synchronously, returning results that should be
injected into the conversation history immediately. When this returns
Some, execute will not be called — the returned messages are
processed inline and the completion loop continues. This avoids race
conditions where a concurrent event can make the tool call appear
cancelled even though it already launched.
Dyn Compatibility§
This trait is dyn compatible.
In older versions of Rust, dyn compatibility was called "object safety".