Enum ElicitRequestParams 

#[non_exhaustive]
pub enum ElicitRequestParams {
    FormElicitationParams {
        meta: Option<RequestMetaObject>,
        message: String,
        requested_schema: ElicitationSchema,
    },
    UrlElicitationParams {
        meta: Option<RequestMetaObject>,
        message: String,
        url: String,
        elicitation_id: String,
    },
}

Parameters for creating an elicitation request to gather user input.

This structure contains everything needed to request interactive input from a user:

• A human-readable message explaining what information is needed
• A type-safe schema defining the expected structure of the response

Example

1. Form-based elicitation request

use rmcp::model::*;

let params = ElicitRequestParams::FormElicitationParams {
   meta: None,
    message: "Please provide your email".to_string(),
    requested_schema: ElicitationSchema::builder()
        .required_email("email")
        .build()
        .unwrap(),
};

2. URL-based elicitation request

use rmcp::model::*;
let params = ElicitRequestParams::UrlElicitationParams {
    meta: None,
    message: "Please provide your feedback at the following URL".to_string(),
    url: "https://example.com/feedback".to_string(),
    elicitation_id: "unique-id-123".to_string(),
};

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

FormElicitationParams

Fields

meta: Option<RequestMetaObject>

Protocol-level metadata for this request (SEP-1319)

message: String

Human-readable message explaining what input is needed from the user. This should be clear and provide sufficient context for the user to understand what information they need to provide.

requested_schema: ElicitationSchema

Type-safe schema defining the expected structure and validation rules for the user’s response. This enforces the MCP 2025-06-18 specification that elicitation schemas must be objects with primitive-typed properties.

UrlElicitationParams

Fields

meta: Option<RequestMetaObject>

Protocol-level metadata for this request (SEP-1319)

message: String

Human-readable message explaining what input is needed from the user. This should be clear and provide sufficient context for the user to understand what information they need to provide.

url: String

The URL where the user can provide the requested information. The client should direct the user to this URL to complete the elicitation.

elicitation_id: String

The unique identifier for this elicitation request.

Trait Implementations

impl Clone for ElicitRequestParams

fn clone(&self) -> ElicitRequestParams

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ElicitRequestParams

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ElicitRequestParams

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for ElicitRequestParams

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 ElicitRequestParams

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

Equality operator ==.

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

Inequality operator !=.

impl RequestParamsMeta for ElicitRequestParams

fn meta(&self) -> Option<&RequestMetaObject>

Get a reference to the meta field

fn meta_mut(&mut self) -> &mut Option<RequestMetaObject>

Get a mutable reference to the meta field

fn set_meta(&mut self, meta: RequestMetaObject)

Set the meta field

fn progress_token(&self) -> Option<ProgressToken>

Get the progress token from meta, if present

fn set_progress_token(&mut self, token: ProgressToken)

Set a progress token in meta

fn traceparent(&self) -> Option<&str>

Get the W3C traceparent value from meta, if present (SEP-414)

fn set_traceparent(&mut self, value: &str)

Set the W3C traceparent value in meta (SEP-414)

fn tracestate(&self) -> Option<&str>

Get the W3C tracestate value from meta, if present (SEP-414)

fn set_tracestate(&mut self, value: &str)

Set the W3C tracestate value in meta (SEP-414)

fn baggage(&self) -> Option<&str>

Get the W3C baggage value from meta, if present (SEP-414)

fn set_baggage(&mut self, value: &str)

Set the W3C baggage value in meta (SEP-414)

fn meta_or_default(&mut self) -> &mut RequestMetaObject

Get a mutable reference to meta, inserting an empty one if absent.

impl Serialize for ElicitRequestParams

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 ElicitRequestParams

impl TryFrom<ElicitRequestParamsWire> for ElicitRequestParams

type Error = Error

The type returned in the event of a conversion error.

fn try_from( value: ElicitRequestParamsWire, ) -> Result<ElicitRequestParams, <ElicitRequestParams as TryFrom<ElicitRequestParamsWire>>::Error>

Performs the conversion.