Struct ToolSchema 

pub struct ToolSchema {
    pub name: String,
    pub description: String,
    pub parameters: Value,
    pub policy: ToolPolicy,
    pub metadata: RunMetadata,
}

The definition of a tool.

The model decides whether to call the tool and how to generate arguments from name / description / parameters; Provider implementations map those three fields to the vendor’s wire format. ToolPolicy and ToolSchema::metadata are framework-facing metadata and are not sent to providers unless a provider adapter explicitly supports such annotations.

Example

use molo::tool::ToolSchema;
use serde_json::json;

let schema = ToolSchema::new(
    "get_weather",
    "Get the weather for a given city",
    json!({
        "type": "object",
        "properties": {
            "city": { "type": "string", "description": "City name" }
        },
        "required": ["city"]
    }),
);

assert_eq!(schema.name, "get_weather");

Fields

name: String

Tool name (the basis on which the model selects a tool).

description: String

Tool description (the basis on which the model understands the tool’s purpose).

parameters: Value

JSON Schema for the arguments, preferably generated from a serde struct with schemars::schema_for!.

policy: ToolPolicy

Framework-facing policy declaration.

metadata: RunMetadata

Framework/application metadata.

Implementations

impl ToolSchema

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

Constructs a tool schema with default policy and no metadata.

pub fn with_policy(self, policy: ToolPolicy) -> Self

Sets framework-facing policy metadata.

pub fn with_metadata(self, metadata: RunMetadata) -> Self

Sets framework/application metadata.

Trait Implementations

impl Clone for ToolSchema

fn clone(&self) -> ToolSchema

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ToolSchema

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ToolSchema

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for ToolSchema

fn eq(&self, other: &ToolSchema) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl Serialize for ToolSchema

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for ToolSchema