Struct Tool 

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

Stable since 0.63.0

Tool definition with JSON Schema parameters

Fields

name: String

Tool name

description: String

Human-readable description

parameters: Value

JSON Schema for parameters

Implementations

impl Tool

pub fn new( name: impl Into<String>, description: impl Into<String>, parameters: Value, ) -> Tool

Create a new tool with the given name, description, and JSON Schema.

Examples

use oxicode_ai::Tool;
let tool = Tool::new(
    "read_file",
    "Read contents from a file",
    serde_json::json!({
        "type": "object",
        "properties": {
            "path": {
                "type": "string",
                "description": "File path to read"
            }
        },
        "required": ["path"]
    }),
);

pub fn with_string_param( name: impl Into<String>, description: impl Into<String>, param_name: impl Into<String>, param_description: impl Into<String>, ) -> Tool

Create a simple tool with a single string parameter

Examples

use oxicode_ai::Tool;
let tool = Tool::with_string_param(
    "get_weather",
    "Get current weather",
    "location",
    "City name",
);
assert_eq!(tool.name, "get_weather");

pub fn validate(&self, args: &Value) -> Result<Value, ToolValidationError>

Validate arguments against the tool’s JSON Schema

Examples

use oxicode_ai::Tool;
let tool = Tool::with_string_param(
    "get_weather",
    "Get weather",
    "location",
    "City",
);
let result = tool.validate(&serde_json::json!({"location": "London"}));
assert!(result.is_ok());

pub fn requires_parameters(&self) -> bool

Check if this tool requires parameters

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<(), Error>

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Tool

fn deserialize<__D>( __deserializer: __D, ) -> Result<Tool, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for Tool

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.