Struct Tool 

pub struct Tool { /* private fields */ }

A callable tool that can be registered on a client or request.

Use Tool::new to start building, chain .description() and .handler(), where .handler() is fallible and validates the schema at build time.

Example

use rai_sdk::{JsonSchema, Tool};
use serde::Deserialize;

#[derive(Deserialize, JsonSchema)]
#[schemars(crate = "rai_sdk::schemars")]
struct GetUserInfo {
    user_id: String,
}

let _tool = Tool::new("get_user_info")
    .description("Load a user's profile")
    .handler(|input: GetUserInfo, _ctx: rai_sdk::ToolContext| async move {
        Ok(serde_json::json!({ "user_id": input.user_id, "email": "user@example.com" }))
    })?;

Implementations

impl Tool

pub fn new(name: impl Into<String>) -> Self

Start a new tool definition.

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

Describe when the model should use this tool.

pub fn json_schema(self, input_schema: Value) -> Self

Override the inferred input schema with a custom JSON Schema.

pub fn handler<Args, Output, F, Fut>(self, handler: F) -> Result<Self>

where Args: DeserializeOwned + JsonSchema + Send + 'static, Output: Serialize + Send + 'static, F: Fn(Args, ToolContext) -> Fut + Send + Sync + 'static, Fut: Future<Output = Result<Output>> + Send + 'static,

Attach an async handler and infer the input schema from Args.

This is fallible — the schema is validated at build time and an error is returned if it is invalid.

Trait Implementations

impl Clone for Tool

fn clone(&self) -> Tool

Returns a duplicate of the value.

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

Performs copy-assignment from source.