Struct ElicitationSessionScope 

#[non_exhaustive]
pub struct ElicitationSessionScope {
    pub session_id: SessionId,
    pub tool_call_id: Option<ToolCallId>,
}

UNSTABLE

This capability is not part of the spec yet, and may be removed or changed at any point.

Session-scoped elicitation, optionally tied to a specific tool call.

When tool_call_id is set, the elicitation is tied to a specific tool call. This is useful when an agent receives an elicitation from an MCP server during a tool call and needs to redirect it to the user.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

session_id: SessionId

The session this elicitation is tied to.

tool_call_id: Option<ToolCallId>

Optional tool call within the session.

Implementations

impl ElicitationSessionScope

pub fn new(session_id: impl Into<SessionId>) -> ElicitationSessionScope

pub fn tool_call_id( self, tool_call_id: impl IntoOption<ToolCallId>, ) -> ElicitationSessionScope

Trait Implementations

impl Clone for ElicitationSessionScope

fn clone(&self) -> ElicitationSessionScope

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ElicitationSessionScope

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ElicitationSessionScope

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for ElicitationSessionScope

impl From<ElicitationSessionScope> for ElicitationScope

fn from(scope: ElicitationSessionScope) -> ElicitationScope

Converts to this type from the input type.

impl IntoV2 for ElicitationSessionScope

Available on crate feature unstable_elicitation only.

type Output = ElicitationSessionScope

The corresponding v2 draft type.

fn into_v2( self, ) -> Result<<ElicitationSessionScope as IntoV2>::Output, ProtocolConversionError>

Converts this value into the corresponding v2 draft type.

impl JsonSchema for ElicitationSessionScope

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 ElicitationSessionScope

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for ElicitationSessionScope

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 ElicitationSessionScope