Struct McpSchema 

pub struct McpSchema(/* private fields */);

Typed JSON Schema value used by generated MCP tool metadata.

This wrapper keeps schema-producing APIs distinct from arbitrary tool-call JSON while still exposing the underlying serde_json::Value for tests, protocol handoff, and last-mile schema extension.

Implementations

impl McpSchema

pub fn new(schema: Value) -> Self

pub fn any() -> Self

pub fn impossible() -> Self

pub fn typed(schema_type: McpSchemaType) -> Self

pub fn null() -> Self

pub fn boolean() -> Self

pub fn integer() -> Self

pub fn number() -> Self

pub fn string() -> Self

pub fn array(item_schema: McpSchema) -> Self

pub fn object() -> Self

pub fn any_of<I>(schemas: I) -> Self

where I: IntoIterator<Item = McpSchema>,

pub fn one_of<I>(schemas: I) -> Self

where I: IntoIterator<Item = McpSchema>,

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

pub fn with_extension(self, key: impl Into<String>, value: Value) -> Self

pub fn with_format(self, format: McpStringFormat) -> Self

pub fn with_minimum(self, minimum: impl Into<McpSchemaNumber>) -> Self

pub fn with_min_items(self, min_items: usize) -> Self

pub fn with_max_items(self, max_items: usize) -> Self

pub fn with_unique_items(self, unique_items: bool) -> Self

pub fn with_default(self, value: impl Into<Value>) -> Self

pub fn with_const(self, value: impl Into<Value>) -> Self

pub fn with_enum_values<I, V>(self, values: I) -> Self

where I: IntoIterator<Item = V>, V: Into<Value>,

pub fn with_items(self, item_schema: McpSchema) -> Self

pub fn with_prefix_items<I>(self, item_schemas: I) -> Self

where I: IntoIterator<Item = McpSchema>,

pub fn with_properties(self, properties: McpSchemaProperties) -> Self

pub fn with_required<I, S>(self, required: I) -> Self

where I: IntoIterator<Item = S>, S: Into<String>,

pub fn with_additional_properties( self, additional_properties: impl Into<McpAdditionalProperties>, ) -> Self

pub fn with_not(self, schema: McpSchema) -> Self

pub fn set_description(&mut self, description: impl Into<String>)

pub fn set_extension(&mut self, key: impl Into<String>, value: Value)

pub fn set_format(&mut self, format: McpStringFormat)

pub fn set_minimum(&mut self, minimum: impl Into<McpSchemaNumber>)

pub fn set_min_items(&mut self, min_items: usize)

pub fn set_max_items(&mut self, max_items: usize)

pub fn set_unique_items(&mut self, unique_items: bool)

pub fn set_default(&mut self, value: impl Into<Value>)

pub fn set_const(&mut self, value: impl Into<Value>)

pub fn set_enum_values<I, V>(&mut self, values: I)

where I: IntoIterator<Item = V>, V: Into<Value>,

pub fn set_items(&mut self, item_schema: McpSchema)

pub fn set_prefix_items<I>(&mut self, item_schemas: I)

where I: IntoIterator<Item = McpSchema>,

pub fn set_properties(&mut self, properties: McpSchemaProperties)

pub fn set_required<I, S>(&mut self, required: I)

where I: IntoIterator<Item = S>, S: Into<String>,

pub fn set_additional_properties( &mut self, additional_properties: impl Into<McpAdditionalProperties>, )

pub fn set_any_of<I>(&mut self, schemas: I)

where I: IntoIterator<Item = McpSchema>,

pub fn set_one_of<I>(&mut self, schemas: I)

where I: IntoIterator<Item = McpSchema>,

pub fn set_not(&mut self, schema: McpSchema)

pub fn as_value(&self) -> &Value

pub fn as_object_mut(&mut self) -> Option<&mut Map<String, Value>>

pub fn into_value(self) -> Value

Trait Implementations

impl Clone for McpSchema

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for McpSchema

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

Formats the value using the given formatter.

impl Eq for McpSchema

impl From<McpSchema> for McpAdditionalProperties

fn from(schema: McpSchema) -> Self

Converts to this type from the input type.

impl<I> Index<I> for McpSchema

where Value: Index<I>,

type Output = <Value as Index<I>>::Output

The returned type after indexing.

fn index(&self, index: I) -> &Self::Output

Performs the indexing (container[index]) operation.

impl PartialEq for McpSchema

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for McpSchema