Struct Tool 

pub struct Tool {
    pub name: String,
    pub description: String,
    pub schema: Schema,
    pub timeout_sec: u32,
    pub detail_from_args: Option<Box<dyn FnMut(&[u8]) -> String>>,
    pub execute: Box<dyn FnMut(&[u8]) -> Result<ToolResult, String>>,
}

An LLM-callable tool. schema is a typed JSON Schema for parameters (same role as Go’s Parameters / Codex’s schemars-generated input schema).

Fields

name: String

description: String

schema: Schema

timeout_sec: u32

Host RPC wait for execute, in seconds. 0 = host default (30s).

detail_from_args: Option<Box<dyn FnMut(&[u8]) -> String>>

Optional one-line TUI detail from raw JSON args (before execute).

execute: Box<dyn FnMut(&[u8]) -> Result<ToolResult, String>>

Implementations

impl Tool

pub fn new( name: impl Into<String>, description: impl Into<String>, schema: impl Into<Schema>, execute: impl FnMut(&[u8]) -> Result<ToolResult, String> + 'static, ) -> Self

Examples found in repository

examples/full.rs (lines 9-22)

fn main() -> Result<(), phi::Error> {
    let mut m = phi::Extension::new("full", "0.1.0");

    m.register_tool(
        phi::Tool::new(
            "echo",
            "Echo the input back",
            phi::Schema::object()
                .property("text", phi::Schema::string())
                .required(["text"]),
            |args| {
                let text = String::from_utf8_lossy(args);
                Ok(phi::ToolResult {
                    content: format!("echo: {text}"),
                    ..Default::default()
                })
            },
        )
        .detail_from_args(|args| String::from_utf8_lossy(args).into_owned()),
    );

    m.register_command(
        "ask",
        phi::Command::new("Ask a yes/no question", |_args, ctx| {
            let reply = ctx.confirm("Confirm?", "Proceed with /tmp/x?");
            if reply.ok {
                ctx.notify("info", "Confirmed!");
            } else {
                ctx.notify("warning", "Declined.");
            }
            ctx.submit("follow-up from ask");
            Ok(())
        }),
    );

    m.run()
}

pub fn timeout_sec(self, secs: u32) -> Self

Sets how long the host waits for this tool’s result (1–3600; host clamps).

pub fn detail_from_args(self, f: impl FnMut(&[u8]) -> String + 'static) -> Self

Sets a one-line TUI detail formatter for raw JSON arguments.

Examples found in repository

examples/full.rs (line 23)

fn main() -> Result<(), phi::Error> {
    let mut m = phi::Extension::new("full", "0.1.0");

    m.register_tool(
        phi::Tool::new(
            "echo",
            "Echo the input back",
            phi::Schema::object()
                .property("text", phi::Schema::string())
                .required(["text"]),
            |args| {
                let text = String::from_utf8_lossy(args);
                Ok(phi::ToolResult {
                    content: format!("echo: {text}"),
                    ..Default::default()
                })
            },
        )
        .detail_from_args(|args| String::from_utf8_lossy(args).into_owned()),
    );

    m.register_command(
        "ask",
        phi::Command::new("Ask a yes/no question", |_args, ctx| {
            let reply = ctx.confirm("Confirm?", "Proceed with /tmp/x?");
            if reply.ok {
                ctx.notify("info", "Confirmed!");
            } else {
                ctx.notify("warning", "Declined.");
            }
            ctx.submit("follow-up from ask");
            Ok(())
        }),
    );

    m.run()
}