Struct ToolInputSchema 

pub struct ToolInputSchema {
    pub schema_type: String,
    pub properties: Option<HashMap<String, Value>>,
    pub required: Option<Vec<String>>,
    pub additional_properties: Option<bool>,
}

Defines the structure of the arguments a tool accepts, as a JSON Schema object.

Fields

schema_type: String

The type of the schema, which must be “object” for tool inputs.

properties: Option<HashMap<String, Value>>

A map defining the properties (parameters) the tool accepts.

required: Option<Vec<String>>

A list of property names that are required.

additional_properties: Option<bool>

Whether additional, unspecified properties are allowed.

Implementations

impl ToolInputSchema

pub fn empty() -> Self

Creates a new, empty input schema that accepts no parameters.

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

Creates a new schema with a given set of properties.

pub fn with_required_properties( properties: HashMap<String, Value>, required: Vec<String>, ) -> Self

Creates a new schema with a given set of properties and a list of required properties.

pub fn add_property(self, name: String, property: Value) -> Self

Adds a property to the schema using a builder pattern.

Example

let schema = ToolInputSchema::empty()
    .add_property("name".to_string(), json!({ "type": "string" }));

pub fn require_property(self, name: String) -> Self

Marks a property as required using a builder pattern.

Example

let schema = ToolInputSchema::empty()
    .add_property("name".to_string(), json!({ "type": "string" }))
    .require_property("name".to_string());

Trait Implementations

impl Clone for ToolInputSchema

fn clone(&self) -> ToolInputSchema

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ToolInputSchema

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

Formats the value using the given formatter.

impl Default for ToolInputSchema

fn default() -> Self

Creates a default ToolInputSchema that accepts an empty object.

impl<'de> Deserialize<'de> for ToolInputSchema

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for ToolInputSchema

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

where __S: Serializer,

Serialize this value into the given Serde serializer.