Struct ElicitFormSchema 

pub struct ElicitFormSchema {
    pub schema_type: String,
    pub properties: HashMap<String, PrimitiveSchemaDefinition>,
    pub required: Vec<String>,
}

Restricted JSON Schema for elicitation forms.

Based on JSON Schema 2020-12, but restricted to a flat object with primitive-typed properties. Complex types (arrays, nested objects) are not supported – only string, integer, number, boolean, and enum fields.

The schema is validated by the client before submitting the form response. Required fields must be present, and each value must match its declared type.

Use the builder methods to construct a schema with string, integer, number, boolean, and enum fields, optionally with default values.

Example

use tower_mcp_types::protocol::ElicitFormSchema;

let schema = ElicitFormSchema::new()
    .string_field("name", Some("Your full name"), true)
    .string_field_with_default("greeting", Some("How to greet"), false, "Hello")
    .integer_field("age", Some("Your age"), false)
    .enum_field(
        "role",
        Some("Select your role"),
        vec!["admin".into(), "user".into(), "guest".into()],
        true,
    )
    .enum_field_with_default(
        "theme",
        Some("Color theme"),
        false,
        &["light", "dark", "auto"],
        "auto",
    )
    .boolean_field("subscribe", Some("Subscribe to updates"), false);

assert_eq!(schema.required, vec!["name", "role"]);
assert_eq!(schema.properties.len(), 6);

Fields

schema_type: String

Must be “object”

properties: HashMap<String, PrimitiveSchemaDefinition>

Map of property names to their schema definitions

required: Vec<String>

List of required property names

Implementations

impl ElicitFormSchema

pub fn new() -> ElicitFormSchema

Create a new form schema

pub fn string_field( self, name: &str, description: Option<&str>, required: bool, ) -> ElicitFormSchema

Add a string field

pub fn string_field_with_default( self, name: &str, description: Option<&str>, required: bool, default: &str, ) -> ElicitFormSchema

Add a string field with a default value

pub fn integer_field( self, name: &str, description: Option<&str>, required: bool, ) -> ElicitFormSchema

Add an integer field

pub fn integer_field_with_default( self, name: &str, description: Option<&str>, required: bool, default: i64, ) -> ElicitFormSchema

Add an integer field with a default value

pub fn number_field( self, name: &str, description: Option<&str>, required: bool, ) -> ElicitFormSchema

Add a number field

pub fn number_field_with_default( self, name: &str, description: Option<&str>, required: bool, default: f64, ) -> ElicitFormSchema

Add a number field with a default value

pub fn boolean_field( self, name: &str, description: Option<&str>, required: bool, ) -> ElicitFormSchema

Add a boolean field

pub fn boolean_field_with_default( self, name: &str, description: Option<&str>, required: bool, default: bool, ) -> ElicitFormSchema

Add a boolean field with a default value

pub fn enum_field( self, name: &str, description: Option<&str>, options: Vec<String>, required: bool, ) -> ElicitFormSchema

Add a single-select enum field

pub fn enum_field_with_default( self, name: &str, description: Option<&str>, required: bool, options: &[&str], default: &str, ) -> ElicitFormSchema

Add a single-select enum field with a default value

pub fn raw_field( self, name: &str, schema: Value, required: bool, ) -> ElicitFormSchema

Add a raw JSON schema field

Use this for advanced schema features not covered by the typed builders.

Trait Implementations

impl Clone for ElicitFormSchema

fn clone(&self) -> ElicitFormSchema

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ElicitFormSchema

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

Formats the value using the given formatter.

impl Default for ElicitFormSchema

fn default() -> ElicitFormSchema

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ElicitFormSchema

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for ElicitFormSchema

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.