Skip to main content

McpServerElicitationRequestParams

Enum McpServerElicitationRequestParams 

Source
pub enum McpServerElicitationRequestParams {
    Form {
        message: String,
        meta: Option<Value>,
        requested_schema: McpElicitationSchema,
        server_name: String,
        thread_id: String,
        turn_id: Option<String>,
    },
    OpenaiForm {
        message: String,
        meta: Option<Value>,
        requested_schema: Value,
        server_name: String,
        thread_id: String,
        turn_id: Option<String>,
    },
    Url {
        elicitation_id: String,
        message: String,
        meta: Option<Value>,
        server_name: String,
        thread_id: String,
        turn_id: Option<String>,
        url: String,
    },
}
Expand description

McpServerElicitationRequestParams

JSON schema
{
 "title": "McpServerElicitationRequestParams",
 "oneOf": [
   {
     "type": "object",
     "required": [
       "message",
       "mode",
       "requestedSchema",
       "serverName",
       "threadId"
     ],
     "properties": {
       "serverName": {
         "type": "string"
       },
       "threadId": {
         "type": "string"
       },
       "turnId": {
         "description": "Active Codex turn when this elicitation was observed, if app-server could correlate one.\n\nThis is nullable because MCP models elicitation as a standalone server-to-client request identified by the MCP server request id. It may be triggered during a turn, but turn context is app-server correlation rather than part of the protocol identity of the elicitation itself.",
         "type": [
           "string",
           "null"
         ]
       },
       "_meta": true,
       "message": {
         "type": "string"
       },
       "mode": {
         "type": "string",
         "enum": [
           "form"
         ]
       },
       "requestedSchema": {
         "$ref": "#/definitions/McpElicitationSchema"
       }
     }
   },
   {
     "type": "object",
     "required": [
       "message",
       "mode",
       "requestedSchema",
       "serverName",
       "threadId"
     ],
     "properties": {
       "serverName": {
         "type": "string"
       },
       "threadId": {
         "type": "string"
       },
       "turnId": {
         "description": "Active Codex turn when this elicitation was observed, if app-server could correlate one.\n\nThis is nullable because MCP models elicitation as a standalone server-to-client request identified by the MCP server request id. It may be triggered during a turn, but turn context is app-server correlation rather than part of the protocol identity of the elicitation itself.",
         "type": [
           "string",
           "null"
         ]
       },
       "_meta": true,
       "message": {
         "type": "string"
       },
       "mode": {
         "type": "string",
         "enum": [
           "openai/form"
         ]
       },
       "requestedSchema": true
     }
   },
   {
     "type": "object",
     "required": [
       "elicitationId",
       "message",
       "mode",
       "serverName",
       "threadId",
       "url"
     ],
     "properties": {
       "serverName": {
         "type": "string"
       },
       "threadId": {
         "type": "string"
       },
       "turnId": {
         "description": "Active Codex turn when this elicitation was observed, if app-server could correlate one.\n\nThis is nullable because MCP models elicitation as a standalone server-to-client request identified by the MCP server request id. It may be triggered during a turn, but turn context is app-server correlation rather than part of the protocol identity of the elicitation itself.",
         "type": [
           "string",
           "null"
         ]
       },
       "_meta": true,
       "elicitationId": {
         "type": "string"
       },
       "message": {
         "type": "string"
       },
       "mode": {
         "type": "string",
         "enum": [
           "url"
         ]
       },
       "url": {
         "type": "string"
       }
     }
   }
 ]
}

Variants§

§

Form

Fields

§message: String
§requested_schema: McpElicitationSchema
§server_name: String
§thread_id: String
§turn_id: Option<String>

Active Codex turn when this elicitation was observed, if app-server could correlate one.

This is nullable because MCP models elicitation as a standalone server-to-client request identified by the MCP server request id. It may be triggered during a turn, but turn context is app-server correlation rather than part of the protocol identity of the elicitation itself.

§

OpenaiForm

Fields

§message: String
§requested_schema: Value
§server_name: String
§thread_id: String
§turn_id: Option<String>

Active Codex turn when this elicitation was observed, if app-server could correlate one.

This is nullable because MCP models elicitation as a standalone server-to-client request identified by the MCP server request id. It may be triggered during a turn, but turn context is app-server correlation rather than part of the protocol identity of the elicitation itself.

§

Url

Fields

§elicitation_id: String
§message: String
§server_name: String
§thread_id: String
§turn_id: Option<String>

Active Codex turn when this elicitation was observed, if app-server could correlate one.

This is nullable because MCP models elicitation as a standalone server-to-client request identified by the MCP server request id. It may be triggered during a turn, but turn context is app-server correlation rather than part of the protocol identity of the elicitation itself.

Trait Implementations§

Source§

impl Clone for McpServerElicitationRequestParams

Source§

fn clone(&self) -> McpServerElicitationRequestParams

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for McpServerElicitationRequestParams

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'de> Deserialize<'de> for McpServerElicitationRequestParams

Source§

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

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Serialize for McpServerElicitationRequestParams

Source§

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

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> FromRef<T> for T
where T: Clone,

§

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.
§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,