Struct FunctionTool 

pub struct FunctionTool { /* private fields */ }

A closure-based tool.

Implementations

impl FunctionTool

pub fn new<F, Fut>( name: impl Into<String>, description: impl Into<String>, parameters_schema: Value, handler: F, ) -> Self

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

Creates a new function-based tool.

The handler is expected to return a JSON Value; the implementation wraps it in a ToolOutput.

pub fn read_only(self) -> Self

Marks the tool as read-only.

pub fn concurrency_safe(self) -> Self

Marks the tool as safe for concurrent execution.

pub fn long_running(self) -> Self

Marks the tool as long-running.

pub fn side_effects(self, effects: SideEffects) -> Self

Sets the side effects for this tool.

pub fn requires_approval(self, reason: impl Into<String>) -> Self

Marks the tool as requiring human approval.

Trait Implementations

impl Debug for FunctionTool

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Tool for FunctionTool

fn name(&self) -> &str

Returns the tool’s name (visible to the model).

fn description(&self) -> &str

Returns a human-readable description of the tool.

fn parameters_schema(&self) -> Value

Returns the JSON Schema for the tool’s parameters.

fn execute<'life0, 'async_trait>( &'life0 self, args: Value, ) -> Pin<Box<dyn Future<Output = ToolResult<ToolOutput>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Executes the tool with the given arguments.

fn is_read_only(&self) -> bool

Returns true if the tool is read-only (no side effects).

fn is_concurrency_safe(&self) -> bool

Returns true if the tool is safe to run concurrently.

fn is_long_running(&self) -> bool

Returns true if the tool is expected to run for a long time.

fn side_effects(&self) -> SideEffects

Returns the side effects the tool may produce.

fn requires_approval(&self) -> bool

Returns true if the tool requires human approval before execution.

fn approval_reason(&self) -> Option<String>

Returns the reason approval is needed, if applicable.

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

Returns the JSON Schema for the tool’s response (if any).

fn execute_with_ctx<'life0, 'life1, 'async_trait>( &'life0 self, _ctx: &'life1 dyn ToolContext, args: Value, ) -> Pin<Box<dyn Future<Output = ToolResult<ToolOutput>> + Send + 'async_trait>>

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

Executes the tool with the given ToolContext and arguments.

fn required_scopes(&self) -> &[&str]

Returns the scopes required to use this tool.

fn to_spec(&self) -> ToolSpec

Produces a ToolSpec for this tool.