Struct Tool 

pub struct Tool { /* private fields */ }

A named asynchronous function with a JSON input schema.

Use tool() to build a tool incrementally or Tool::new to supply a schema directly. Clones share the handler through Arc. The handler is responsible for validating arguments; the schema is sent to the model as its description.

Implementations

impl Tool

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

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

Creates a tool and normalizes its input schema.

Accepted schema forms:

• A full object containing type and properties is passed through unchanged.
• A property map such as {"query": "string"} makes each property required.
• Extended properties may include optional, required, and default. Explicit required: true wins; otherwise optional: true, required: false, or a default makes the property optional. The two flags are removed afterward.

Type aliases include str, int, i32/i64/u32/u64, float/f32/f64, bool, list/vec, and dict/map. Unknown names become string. Non-object schema inputs produce an empty object schema. The handler still validates arguments.

Example

use open_agent::Tool;
use serde_json::json;

let search = Tool::new(
    "search",
    "Search documents",
    json!({
        "query": "string",
        "limit": {"type": "integer", "default": 10}
    }),
    |args| async move {
        let limit = args["limit"].as_u64().unwrap_or(10);
        Ok(json!({"query": args["query"], "limit": limit}))
    },
);

pub async fn execute(&self, arguments: Value) -> Result<Value>

Runs the handler with the supplied JSON arguments.

The handler validates arguments; this method does not enforce the input schema.

Errors

Propagates the handler’s error unchanged. Automatic execution converts that error to a tool-result JSON object so the model can respond to it.

pub fn to_openai_format(&self) -> Value

Returns the tool name, description, and schema in OpenAI function-calling format.

The returned JSON contains no handler. Anthropic translation extracts the same metadata when building its request.

pub fn name(&self) -> &str

Returns the tool’s name.

pub fn description(&self) -> &str

Returns the tool’s description.

pub fn input_schema(&self) -> &Value

Returns a reference to the tool’s input schema.

Trait Implementations

impl Clone for Tool

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Tool

Shows tool metadata and omits the handler.

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

Formats the value using the given formatter.