Struct ElicitUrlParams 

pub struct ElicitUrlParams {
    pub mode: Option<ElicitMode>,
    pub elicitation_id: String,
    pub message: String,
    pub url: String,
    pub meta: Option<RequestMeta>,
}

Parameters for URL-based elicitation request.

URL-based elicitation allows servers to direct users to an external URL (e.g., an OAuth flow or payment page) and receive completion notification.

Example

use tower_mcp_types::protocol::{ElicitUrlParams, ElicitMode};

let params = ElicitUrlParams {
    mode: Some(ElicitMode::Url),
    elicitation_id: "auth-flow-123".to_string(),
    message: "Please sign in to continue".to_string(),
    url: "https://example.com/auth?session=abc".to_string(),
    meta: None,
};

assert_eq!(params.url, "https://example.com/auth?session=abc");

Fields

mode: Option<ElicitMode>

The elicitation mode (defaults to url if not specified)

elicitation_id: String

Unique ID for this elicitation (opaque to client)

message: String

Message explaining why the user needs to navigate to the URL

url: String

The URL the user should navigate to

meta: Option<RequestMeta>

Request metadata including progress token

Trait Implementations

impl Clone for ElicitUrlParams

fn clone(&self) -> ElicitUrlParams

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ElicitUrlParams

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ElicitUrlParams

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for ElicitUrlParams

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.