Struct ToolParameterSchema

pub struct ToolParameterSchema {
    pub schema_type: String,
    pub description: Option<String>,
    pub properties: Option<HashMap<String, ToolParameterSchema>>,
    pub required: Option<Vec<String>>,
    pub items: Option<Box<ToolParameterSchema>>,
    pub enum_values: Option<Vec<Value>>,
    pub default: Option<Value>,
    pub additional: HashMap<String, Value>,
}

JSON Schema definition for tool parameters

Fields

schema_type: String

JSON Schema type (object, string, number, boolean, array, null)

description: Option<String>

Description of this parameter

properties: Option<HashMap<String, ToolParameterSchema>>

Properties for object types (nested schemas)

required: Option<Vec<String>>

Required property names for object types

items: Option<Box<ToolParameterSchema>>

Items schema for array types

enum_values: Option<Vec<Value>>

Enum values for restricted choices

default: Option<Value>

Default value

additional: HashMap<String, Value>

Additional schema properties (min, max, pattern, etc.)

Implementations

impl ToolParameterSchema

pub fn string(description: impl Into<String>) -> ToolParameterSchema

Create a simple string parameter

pub fn number(description: impl Into<String>) -> ToolParameterSchema

Create a number parameter

pub fn integer(description: impl Into<String>) -> ToolParameterSchema

Create an integer parameter

pub fn boolean(description: impl Into<String>) -> ToolParameterSchema

Create a boolean parameter

pub fn object( description: impl Into<String>, properties: HashMap<String, ToolParameterSchema>, required: Vec<String>, ) -> ToolParameterSchema

Create an object parameter with properties

pub fn array( description: impl Into<String>, items: ToolParameterSchema, ) -> ToolParameterSchema

Create an array parameter

Trait Implementations

impl Clone for ToolParameterSchema

fn clone(&self) -> ToolParameterSchema

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ToolParameterSchema

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ToolParameterSchema

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for ToolParameterSchema

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.