Struct FunctionTool 

pub struct FunctionTool { /* private fields */ }

Convenience wrapper: turns any async function into a Tool.

Example

let tool = FunctionTool::new(
    "add",
    "Add two numbers",
    serde_json::json!({
        "type": "object",
        "properties": {
            "a": { "type": "number" },
            "b": { "type": "number" }
        },
        "required": ["a", "b"]
    }),
    |input| Box::pin(async move {
        let a = input["a"].as_f64().unwrap_or(0.0);
        let b = input["b"].as_f64().unwrap_or(0.0);
        Ok(serde_json::json!(a + b))
    }),
);

Implementations

impl FunctionTool

pub fn new( name: impl Into<String>, description: impl Into<String>, parameters: Value, func: impl Fn(Value) -> Pin<Box<dyn Future<Output = Result<Value, PeError>> + Send>> + Send + Sync + 'static, ) -> Self

Create a new function tool.

parameters is the JSON Schema for the tool’s input — passed to the LLM.

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

Tool name — must be unique within a super::ToolRegistry. Sent to the LLM in the tools list.

fn description(&self) -> &str

Human-readable description of what this tool does. The LLM reads this to decide when to call the tool.

fn schema(&self) -> ToolSchema

JSON Schema for this tool’s input parameters. InjectedState and InjectedStore parameters MUST be excluded.

fn execute(&self, input: Value) -> ToolFuture

Execute the tool with the given input. Called by super::ToolNode.

fn execute_structured(&self, input: Value) -> ToolResultFuture

Execute with structured result metadata.