Struct ToolParameter 

pub struct ToolParameter {
    pub name: String,
    pub param_type: ToolParameterType,
    pub description: Option<String>,
    pub required: bool,
    pub default: Option<Value>,
    pub items: Option<Box<ToolParameterType>>,
    pub properties: Option<HashMap<String, ToolParameter>>,
}

Defines a parameter for a tool

Fields

name: String

Parameter name.

param_type: ToolParameterType

Parameter value type.

description: Option<String>

Human-readable description.

required: bool

Whether the caller must provide this parameter.

default: Option<Value>

Optional default value.

items: Option<Box<ToolParameterType>>

For array types, specifies the type of items

properties: Option<HashMap<String, ToolParameter>>

For object types, specifies nested properties

Implementations

impl ToolParameter

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

Define a new tool parameter with the provided name and type.

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

Add a human readable description that will surface in generated schemas.

pub fn required(self) -> Self

Mark the argument as required.

pub fn with_default(self, default: Value) -> Self

Provide a default value that will be used when the LLM omits the parameter.

pub fn with_items(self, item_type: ToolParameterType) -> Self

For array parameters, declare the type of the contained items.

pub fn with_properties(self, properties: HashMap<String, ToolParameter>) -> Self

For object parameters, describe the nested properties.

pub fn to_json_schema(&self) -> Value

Converts this parameter to a JSON Schema snippet suitable for native tool-calling.

The generated schema follows [JSON Schema draft-07] conventions accepted by all major providers (OpenAI, Anthropic, Grok, Gemini).

ToolParameterType	Schema produced
String	{"type":"string"}
Number	{"type":"number"}
Integer	{"type":"integer"}
Boolean	{"type":"boolean"}
Array	{"type":"array","items":{...}}
Object	{"type":"object","properties":{...},"required":[...]}

Example

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

let param = ToolParameter::new("query", ToolParameterType::String)
    .with_description("Search query string")
    .required();

let schema = param.to_json_schema();
assert_eq!(schema["type"], "string");
assert_eq!(schema["description"], "Search query string");

Trait Implementations

impl Clone for ToolParameter

fn clone(&self) -> ToolParameter

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ToolParameter

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ToolParameter

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for ToolParameter

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

where __S: Serializer,

Serialize this value into the given Serde serializer.