Struct ToolOutputSchema 

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

An optional JSON Schema object defining the structure of the tool’s output returned in the structuredContent field of a CallToolResult. Defaults to JSON Schema 2020-12 when no explicit $schema is provided. Currently restricted to type: “object” at the root level.

JSON schema

{
 "description": "An optional JSON Schema object defining the structure of the tool's output returned in\nthe structuredContent field of a CallToolResult.\n\nDefaults to JSON Schema 2020-12 when no explicit $schema is provided.\nCurrently restricted to type: \"object\" at the root level.",
 "type": "object",
 "required": [
   "type"
 ],
 "properties": {
   "$schema": {
     "type": "string"
   },
   "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>

schema: Option<String>

Implementations

impl ToolOutputSchema

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

pub fn type_(&self) -> &String

pub fn type_value() -> String

returns “object”

pub fn type_name() -> String

👎Deprecated since 0.8.0: Use type_value() instead.

Trait Implementations

impl Clone for ToolOutputSchema

fn clone(&self) -> ToolOutputSchema

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ToolOutputSchema

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

Formats the value using the given formatter.

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

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::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::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.