Struct InitializeRequestParams 

#[non_exhaustive]
pub struct InitializeRequestParams {
    pub meta: Option<RequestMetaObject>,
    pub protocol_version: ProtocolVersion,
    pub capabilities: ClientCapabilities,
    pub client_info: Implementation,
}

Available on crate features mcp and tools only.

Parameters sent by a client when initializing a connection to an MCP server.

This contains the client’s protocol version, capabilities, and implementation information, allowing the server to understand what the client supports.

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.

meta: Option<RequestMetaObject>

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

protocol_version: ProtocolVersion

The MCP protocol version this client supports

capabilities: ClientCapabilities

The capabilities this client supports (sampling, roots, etc.)

client_info: Implementation

Information about the client implementation

Implementations

impl InitializeRequestParams

pub fn new( capabilities: ClientCapabilities, client_info: Implementation, ) -> InitializeRequestParams

Create a new InitializeRequestParams.

pub fn with_protocol_version( self, protocol_version: ProtocolVersion, ) -> InitializeRequestParams

Trait Implementations

impl ClientHandler for InitializeRequestParams

Do nothing, with a specific client info.

fn get_info(&self) -> InitializeRequestParams

fn ping( &self, context: RequestContext<RoleClient>, ) -> impl Future<Output = Result<(), ErrorData>> + MaybeSendFuture

fn create_message( &self, params: CreateMessageRequestParams, context: RequestContext<RoleClient>, ) -> impl Future<Output = Result<CreateMessageResult, ErrorData>> + MaybeSendFuture

fn list_roots( &self, context: RequestContext<RoleClient>, ) -> impl Future<Output = Result<ListRootsResult, ErrorData>> + MaybeSendFuture

fn create_elicitation( &self, request: ElicitRequestParams, context: RequestContext<RoleClient>, ) -> impl Future<Output = Result<ElicitResult, ErrorData>> + MaybeSendFuture

Handle an elicitation request from a server asking for user input.

fn on_custom_request( &self, request: CustomRequest, context: RequestContext<RoleClient>, ) -> impl Future<Output = Result<CustomResult, ErrorData>> + MaybeSendFuture

fn on_cancelled( &self, params: CancelledNotificationParam, context: NotificationContext<RoleClient>, ) -> impl Future<Output = ()> + MaybeSendFuture

fn on_progress( &self, params: ProgressNotificationParam, context: NotificationContext<RoleClient>, ) -> impl Future<Output = ()> + MaybeSendFuture

fn on_logging_message( &self, params: LoggingMessageNotificationParam, context: NotificationContext<RoleClient>, ) -> impl Future<Output = ()> + MaybeSendFuture

fn on_resource_updated( &self, params: ResourceUpdatedNotificationParam, context: NotificationContext<RoleClient>, ) -> impl Future<Output = ()> + MaybeSendFuture

fn on_resource_list_changed( &self, context: NotificationContext<RoleClient>, ) -> impl Future<Output = ()> + MaybeSendFuture

fn on_tool_list_changed( &self, context: NotificationContext<RoleClient>, ) -> impl Future<Output = ()> + MaybeSendFuture

fn on_prompt_list_changed( &self, context: NotificationContext<RoleClient>, ) -> impl Future<Output = ()> + MaybeSendFuture

fn on_subscriptions_acknowledged( &self, params: SubscriptionsAcknowledgedNotificationParams, context: NotificationContext<RoleClient>, ) -> impl Future<Output = ()> + MaybeSendFuture

fn on_task_status( &self, params: TaskStatusNotificationParams, context: NotificationContext<RoleClient>, ) -> impl Future<Output = ()> + MaybeSendFuture

fn on_custom_notification( &self, notification: CustomNotification, context: NotificationContext<RoleClient>, ) -> impl Future<Output = ()> + MaybeSendFuture

impl Clone for InitializeRequestParams

fn clone(&self) -> InitializeRequestParams

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for InitializeRequestParams

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

Formats the value using the given formatter.

impl Default for InitializeRequestParams

fn default() -> InitializeRequestParams

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for InitializeRequestParams

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for InitializeRequestParams

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 InitializeRequestParams

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

Equality operator ==.

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

Inequality operator !=.

impl RequestParamsMeta for InitializeRequestParams

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 InitializeRequestParams

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 InitializeRequestParams