Struct ElicitationSchema 

#[non_exhaustive]
pub struct ElicitationSchema {
    pub schema: Option<Cow<'static, str>>,
    pub type_: ObjectTypeConst,
    pub title: Option<Cow<'static, str>>,
    pub properties: BTreeMap<String, PrimitiveSchemaDefinition>,
    pub property_order: Option<Vec<String>>,
    pub required: Option<Vec<String>>,
    pub description: Option<Cow<'static, str>>,
}

Type-safe elicitation schema for requesting structured user input.

This enforces the MCP 2025-06-18 specification that elicitation schemas must be objects with primitive-typed properties.

Example

use rmcp::model::*;

let schema = ElicitationSchema::builder()
    .required_email("email")
    .required_integer("age", 0, 150)
    .optional_bool("newsletter", false)
    .build();

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

schema: Option<Cow<'static, str>>

Optional JSON Schema dialect identifier (the $schema keyword).

The 2025-11-25 protocol revision allows a requestedSchema to declare its dialect. It is preserved verbatim so a declared dialect survives a decode/re-encode round-trip instead of being silently dropped.

type_: ObjectTypeConst

Always “object” for elicitation schemas

title: Option<Cow<'static, str>>

Optional title for the schema

properties: BTreeMap<String, PrimitiveSchemaDefinition>

Property definitions (must be primitive types)

property_order: Option<Vec<String>>

Property names in wire order. Schemas constructed from a BTreeMap use the map’s sorted key order.

required: Option<Vec<String>>

List of required property names

description: Option<Cow<'static, str>>

Optional description of what this schema represents

Implementations

impl ElicitationSchema

pub fn new( properties: BTreeMap<String, PrimitiveSchemaDefinition>, ) -> ElicitationSchema

Create a new elicitation schema with the given properties

pub fn from_json_schema( schema: Map<String, Value>, ) -> Result<ElicitationSchema, Error>

Convert from a JSON Schema object (typically generated by schemars)

This allows converting from JsonObject to ElicitationSchema, which is useful when working with automatically generated schemas from types.

Example

use rmcp::model::*;

let json_schema = schema_for_type::<MyType>();
let elicitation_schema = ElicitationSchema::from_json_schema(json_schema)?;

Errors

Returns a serde_json::Error if the JSON object cannot be deserialized into a valid ElicitationSchema.

pub fn from_type<T>() -> Result<ElicitationSchema, Error>

where T: JsonSchema,

Generate an ElicitationSchema from a Rust type that implements JsonSchema

This is a convenience method that combines schema generation and conversion. It uses the same schema generation settings as the rest of the MCP SDK.

Example

use rmcp::model::*;
use schemars::JsonSchema;
use serde::{Deserialize, Serialize};

#[derive(JsonSchema, Serialize, Deserialize)]
struct UserInput {
    name: String,
    age: u32,
}

let schema = ElicitationSchema::from_type::<UserInput>()?;

Errors

Returns a serde_json::Error if the generated schema cannot be converted to a valid ElicitationSchema.

pub fn with_required(self, required: Vec<String>) -> ElicitationSchema

Set the required fields

pub fn with_title( self, title: impl Into<Cow<'static, str>>, ) -> ElicitationSchema

Set the title

pub fn with_description( self, description: impl Into<Cow<'static, str>>, ) -> ElicitationSchema

Set the description

pub fn with_schema( self, schema: impl Into<Cow<'static, str>>, ) -> ElicitationSchema

Set the JSON Schema dialect identifier (the $schema keyword).

pub fn builder() -> ElicitationSchemaBuilder

Create a builder for constructing elicitation schemas fluently

Trait Implementations

impl Clone for ElicitationSchema

fn clone(&self) -> ElicitationSchema

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ElicitationSchema

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ElicitationSchema

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<ElicitationSchemaWire> for ElicitationSchema

fn from(schema: ElicitationSchemaWire) -> ElicitationSchema

Converts to this type from the input type.

impl JsonSchema for ElicitationSchema

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

impl PartialEq for ElicitationSchema

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for ElicitationSchema

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.

impl StructuralPartialEq for ElicitationSchema