Struct ToolMetadata 

pub struct ToolMetadata {
    pub name: String,
    pub description: String,
    pub parameters: Vec<ToolParameter>,
    pub protocol_metadata: HashMap<String, Value>,
}

Metadata about a tool

Fields

name: String

Tool name.

description: String

Human-readable description.

parameters: Vec<ToolParameter>

Parameter schema entries.

protocol_metadata: HashMap<String, Value>

Additional metadata specific to the protocol

Implementations

impl ToolMetadata

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

Create metadata with the supplied identifier and description.

pub fn with_parameter(self, param: ToolParameter) -> Self

Append a parameter definition to the tool metadata.

pub fn with_protocol_metadata( self, key: impl Into<String>, value: Value, ) -> Self

Add protocol specific metadata (e.g. MCP capability flags).

pub fn to_tool_definition(&self) -> ToolDefinition

Builds a ToolDefinition (JSON Schema) from this metadata.

The resulting ToolDefinition is ready to be passed to ClientWrapper::send_message as part of the tools slice. Parameters marked required are collected into the JSON Schema "required" array automatically.

Example

use cloudllm::tool_protocol::{ToolMetadata, ToolParameter, ToolParameterType};

let meta = ToolMetadata::new("calculator", "Evaluates a math expression")
    .with_parameter(
        ToolParameter::new("expression", ToolParameterType::String)
            .with_description("The expression to evaluate")
            .required(),
    );

let def = meta.to_tool_definition();
assert_eq!(def.name, "calculator");
let schema = &def.parameters_schema;
assert_eq!(schema["type"], "object");
assert!(schema["properties"]["expression"].is_object());

Trait Implementations

impl Clone for ToolMetadata

fn clone(&self) -> ToolMetadata

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ToolMetadata

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ToolMetadata

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for ToolMetadata

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

where __S: Serializer,

Serialize this value into the given Serde serializer.