Struct Tool 

pub struct Tool {
    pub name: String,
    pub description: String,
    pub parameters_schema: Value,
}

Tool definition for registration with a session.

Use the builder pattern to create tools:

use copilot_sdk::{Client, SessionConfig, Tool, ToolHandler, ToolResultObject};
use std::sync::Arc;

#[tokio::main]
async fn main() -> copilot_sdk::Result<()> {
let client = Client::builder().build()?;
client.start().await?;

let tool = Tool::new("get_weather")
    .description("Get weather for a city")
    .schema(serde_json::json!({
        "type": "object",
        "properties": { "city": { "type": "string" } },
        "required": ["city"]
    }));

let session = client.create_session(SessionConfig {
    tools: vec![tool.clone()],
    ..Default::default()
}).await?;

let handler: ToolHandler = Arc::new(|_name, args| {
    let city = args.get("city").and_then(|v| v.as_str()).unwrap_or("unknown");
    ToolResultObject::text(format!("Weather in {}: sunny", city))
});
session.register_tool_with_handler(tool, Some(handler)).await;
client.stop().await;

Fields

name: String

description: String

parameters_schema: Value

Implementations

impl Tool

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

Create a new tool with the given name.

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

Set the tool description.

pub fn schema(self, schema: Value) -> Self

Set the parameters JSON schema.

pub fn parameter( self, name: impl Into<String>, param_type: impl Into<String>, description: impl Into<String>, required: bool, ) -> Self

Add a parameter to the tool’s JSON schema.

Builds the schema incrementally using the builder pattern.

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.

impl Debug for Tool

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

Formats the value using the given formatter.

impl Serialize for Tool

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.