Struct ElicitationSchemaBuilder 

pub struct ElicitationSchemaBuilder {
    pub properties: BTreeMap<String, PrimitiveSchemaDefinition>,
    pub required: Vec<String>,
    pub title: Option<Cow<'static, str>>,
    pub description: Option<Cow<'static, str>>,
}

Fluent builder for constructing elicitation schemas.

Example

use rmcp::model::*;

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

Fields

properties: BTreeMap<String, PrimitiveSchemaDefinition>

required: Vec<String>

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

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

Implementations

impl ElicitationSchemaBuilder

pub fn new() -> ElicitationSchemaBuilder

Create a new builder

pub fn property( self, name: impl Into<String>, schema: PrimitiveSchemaDefinition, ) -> ElicitationSchemaBuilder

Add a property to the schema

pub fn required_property( self, name: impl Into<String>, schema: PrimitiveSchemaDefinition, ) -> ElicitationSchemaBuilder

Add a required property to the schema

pub fn string_property( self, name: impl Into<String>, f: impl FnOnce(StringSchema) -> StringSchema, ) -> ElicitationSchemaBuilder

Add a string property with custom builder (required)

pub fn required_string_property( self, name: impl Into<String>, f: impl FnOnce(StringSchema) -> StringSchema, ) -> ElicitationSchemaBuilder

Add a required string property with custom builder

pub fn number_property( self, name: impl Into<String>, f: impl FnOnce(NumberSchema) -> NumberSchema, ) -> ElicitationSchemaBuilder

Add a number property with custom builder

pub fn required_number_property( self, name: impl Into<String>, f: impl FnOnce(NumberSchema) -> NumberSchema, ) -> ElicitationSchemaBuilder

Add a required number property with custom builder

pub fn integer_property( self, name: impl Into<String>, f: impl FnOnce(IntegerSchema) -> IntegerSchema, ) -> ElicitationSchemaBuilder

Add an integer property with custom builder

pub fn required_integer_property( self, name: impl Into<String>, f: impl FnOnce(IntegerSchema) -> IntegerSchema, ) -> ElicitationSchemaBuilder

Add a required integer property with custom builder

pub fn bool_property( self, name: impl Into<String>, f: impl FnOnce(BooleanSchema) -> BooleanSchema, ) -> ElicitationSchemaBuilder

Add a boolean property with custom builder

pub fn required_bool_property( self, name: impl Into<String>, f: impl FnOnce(BooleanSchema) -> BooleanSchema, ) -> ElicitationSchemaBuilder

Add a required boolean property with custom builder

pub fn required_string( self, name: impl Into<String>, ) -> ElicitationSchemaBuilder

Add a required string property

pub fn optional_string( self, name: impl Into<String>, ) -> ElicitationSchemaBuilder

Add an optional string property

pub fn required_email(self, name: impl Into<String>) -> ElicitationSchemaBuilder

Add a required email property

pub fn optional_email(self, name: impl Into<String>) -> ElicitationSchemaBuilder

Add an optional email property

pub fn required_string_with( self, name: impl Into<String>, f: impl FnOnce(StringSchema) -> StringSchema, ) -> ElicitationSchemaBuilder

Add a required string property with custom builder

pub fn optional_string_with( self, name: impl Into<String>, f: impl FnOnce(StringSchema) -> StringSchema, ) -> ElicitationSchemaBuilder

Add an optional string property with custom builder

pub fn required_number( self, name: impl Into<String>, min: f64, max: f64, ) -> ElicitationSchemaBuilder

Add a required number property with range

pub fn optional_number( self, name: impl Into<String>, min: f64, max: f64, ) -> ElicitationSchemaBuilder

Add an optional number property with range

pub fn required_number_with( self, name: impl Into<String>, f: impl FnOnce(NumberSchema) -> NumberSchema, ) -> ElicitationSchemaBuilder

Add a required number property with custom builder

pub fn optional_number_with( self, name: impl Into<String>, f: impl FnOnce(NumberSchema) -> NumberSchema, ) -> ElicitationSchemaBuilder

Add an optional number property with custom builder

pub fn required_integer( self, name: impl Into<String>, min: i64, max: i64, ) -> ElicitationSchemaBuilder

Add a required integer property with range

pub fn optional_integer( self, name: impl Into<String>, min: i64, max: i64, ) -> ElicitationSchemaBuilder

Add an optional integer property with range

pub fn required_integer_with( self, name: impl Into<String>, f: impl FnOnce(IntegerSchema) -> IntegerSchema, ) -> ElicitationSchemaBuilder

Add a required integer property with custom builder

pub fn optional_integer_with( self, name: impl Into<String>, f: impl FnOnce(IntegerSchema) -> IntegerSchema, ) -> ElicitationSchemaBuilder

Add an optional integer property with custom builder

pub fn required_bool(self, name: impl Into<String>) -> ElicitationSchemaBuilder

Add a required boolean property

pub fn optional_bool( self, name: impl Into<String>, default: bool, ) -> ElicitationSchemaBuilder

Add an optional boolean property with default value

pub fn required_bool_with( self, name: impl Into<String>, f: impl FnOnce(BooleanSchema) -> BooleanSchema, ) -> ElicitationSchemaBuilder

Add a required boolean property with custom builder

pub fn optional_bool_with( self, name: impl Into<String>, f: impl FnOnce(BooleanSchema) -> BooleanSchema, ) -> ElicitationSchemaBuilder

Add an optional boolean property with custom builder

pub fn required_enum_schema( self, name: impl Into<String>, enum_schema: EnumSchema, ) -> ElicitationSchemaBuilder

Add a required enum property using EnumSchema

pub fn optional_enum_schema( self, name: impl Into<String>, enum_schema: EnumSchema, ) -> ElicitationSchemaBuilder

Add an optional enum property using EnumSchema

pub fn mark_required(self, name: impl Into<String>) -> ElicitationSchemaBuilder

Mark an existing property as required

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

Set the schema title

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

Set the schema description

pub fn build(self) -> Result<ElicitationSchema, &'static str>

Build the elicitation schema with validation

Errors

Returns an error if:

• Required fields reference non-existent properties
• No properties are defined (empty schema)

pub fn build_unchecked(self) -> ElicitationSchema

Build the elicitation schema without validation (panics on invalid schema)

Panics

Panics if required fields reference non-existent properties

Trait Implementations

impl Debug for ElicitationSchemaBuilder

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

Formats the value using the given formatter.

impl Default for ElicitationSchemaBuilder

fn default() -> ElicitationSchemaBuilder

Returns the “default value” for a type.