Struct TypedTool 

pub struct TypedTool<T>
where
    T: DeserializeOwned + JsonSchema + Send + Sync + 'static,
{ /* private fields */ }

Type-safe function tool with auto-generated JSON Schema.

Unlike super::SimpleTool which takes raw serde_json::Value arguments and requires a manually written schema, TypedTool auto-generates the JSON Schema from a struct that derives [schemars::JsonSchema] and deserializes the arguments into that struct before calling the handler.

Example

use schemars::JsonSchema;
use serde::Deserialize;

#[derive(Deserialize, JsonSchema)]
struct WeatherArgs {
    /// The city to get weather for
    city: String,
}

let tool = TypedTool::new::<WeatherArgs>(
    "get_weather",
    "Get current weather for a city",
    |args: WeatherArgs| async move {
        Ok(serde_json::json!({ "temp": 22, "city": args.city }))
    },
);

Implementations

impl<T> TypedTool<T>

where T: DeserializeOwned + JsonSchema + Send + Sync + 'static,

pub fn new<F, Fut>( name: impl Into<String>, description: impl Into<String>, handler: F, ) -> TypedTool<T>

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

Create a new typed function tool with auto-generated schema.

The JSON Schema is derived from T’s [JsonSchema] implementation, including any doc-comment descriptions on fields.

Trait Implementations

impl<T> ToolFunction for TypedTool<T>

where T: DeserializeOwned + JsonSchema + Send + Sync + 'static,

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, TypedTool<T>: 'async_trait,

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

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.