Struct ElicitRequestUrlParams 

pub struct ElicitRequestUrlParams {
    pub elicitation_id: String,
    pub message: String,
    pub meta: Option<ElicitUrlMeta>,
    pub task: Option<TaskMetadata>,
    pub url: String,
    /* private fields */
}

The parameters for a request to elicit information from the user via a URL in the client.

JSON schema

{
 "description": "The parameters for a request to elicit information from the user via a URL in the client.",
 "type": "object",
 "required": [
   "elicitationId",
   "message",
   "mode",
   "url"
 ],
 "properties": {
   "_meta": {
     "description": "See [General fields: _meta](https://modelcontextprotocol.io/specification/2025-11-25/basic/index#meta) for notes on _meta usage.",
     "type": "object",
     "properties": {
       "progressToken": {
         "description": "If specified, the caller is requesting out-of-band progress notifications for this request (as represented by notifications/progress). The value of this parameter is an opaque token that will be attached to any subsequent notifications. The receiver is not obligated to provide these notifications.",
         "$ref": "#/$defs/ProgressToken"
       }
     },
     "additionalProperties": {}
   },
   "elicitationId": {
     "description": "The ID of the elicitation, which must be unique within the context of the server.\nThe client MUST treat this ID as an opaque value.",
     "type": "string"
   },
   "message": {
     "description": "The message to present to the user explaining why the interaction is needed.",
     "type": "string"
   },
   "mode": {
     "description": "The elicitation mode.",
     "type": "string",
     "const": "url"
   },
   "task": {
     "description": "If specified, the caller is requesting task-augmented execution for this request.\nThe request will return a CreateTaskResult immediately, and the actual result can be\nretrieved later via tasks/result.\n\nTask augmentation is subject to capability negotiation - receivers MUST declare support\nfor task augmentation of specific request types in their capabilities.",
     "$ref": "#/$defs/TaskMetadata"
   },
   "url": {
     "description": "The URL that the user should navigate to.",
     "type": "string",
     "format": "uri"
   }
 }
}

Fields

elicitation_id: String

The ID of the elicitation, which must be unique within the context of the server. The client MUST treat this ID as an opaque value.

message: String

The message to present to the user explaining why the interaction is needed.

meta: Option<ElicitUrlMeta>

task: Option<TaskMetadata>

If specified, the caller is requesting task-augmented execution for this request. The request will return a CreateTaskResult immediately, and the actual result can be retrieved later via tasks/result. Task augmentation is subject to capability negotiation - receivers MUST declare support for task augmentation of specific request types in their capabilities.

url: String

The URL that the user should navigate to.

Implementations

impl ElicitRequestUrlParams

pub fn new( elicitation_id: String, message: String, url: String, meta: Option<ElicitUrlMeta>, task: Option<TaskMetadata>, ) -> Self

pub fn mode(&self) -> &String

pub fn mode_value() -> &'static str

returns “url”

pub fn mode_name() -> &'static str

👎Deprecated since 0.8.0: Use mode_value() instead.

impl ElicitRequestUrlParams

pub fn with_task(self, task: TaskMetadata) -> Self

Set task metadata , requesting task-augmented execution for this request

Trait Implementations

impl Clone for ElicitRequestUrlParams

fn clone(&self) -> ElicitRequestUrlParams

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ElicitRequestUrlParams

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ElicitRequestUrlParams

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<ElicitRequestUrlParams> for ElicitRequestParams

fn from(value: ElicitRequestUrlParams) -> Self

Converts to this type from the input type.

impl Serialize for ElicitRequestUrlParams

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.