Struct ToolOutputSchema

pub struct ToolOutputSchema {
    pub properties: Option<HashMap<String, Map<String, Value>>>,
    pub required: Vec<String>,
    /* private fields */
}

An optional JSON Schema object defining the structure of the tool’s output returned in the structuredContent field of a CallToolResult.

JSON schema

{
 "description": "An optional JSON Schema object defining the structure of the tool's output returned in\nthe structuredContent field of a CallToolResult.",
 "type": "object",
 "required": [
   "type"
 ],
 "properties": {
   "properties": {
     "type": "object",
     "additionalProperties": {
       "type": "object",
       "additionalProperties": true
     }
   },
   "required": {
     "type": "array",
     "items": {
       "type": "string"
     }
   },
   "type": {
     "type": "string",
     "const": "object"
   }
 }
}

Fields

properties: Option<HashMap<String, Map<String, Value>>>

required: Vec<String>

Implementations

impl ToolOutputSchema

pub fn new( required: Vec<String>, properties: Option<HashMap<String, Map<String, Value>>>, ) -> ToolOutputSchema

pub fn type_(&self) -> &String

pub fn type_name() -> String

Trait Implementations

impl Clone for ToolOutputSchema

fn clone(&self) -> ToolOutputSchema

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ToolOutputSchema

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ToolOutputSchema

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for ToolOutputSchema

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.