#[non_exhaustive]pub struct InitializeRequestParams {
pub meta: Option<RequestMetaObject>,
pub protocol_version: ProtocolVersion,
pub capabilities: ClientCapabilities,
pub client_info: Implementation,
}Expand description
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)§
This struct is marked as 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: ProtocolVersionThe MCP protocol version this client supports
capabilities: ClientCapabilitiesThe capabilities this client supports (sampling, roots, etc.)
client_info: ImplementationInformation about the client implementation
Implementations§
Source§impl InitializeRequestParams
impl InitializeRequestParams
Sourcepub fn new(
capabilities: ClientCapabilities,
client_info: Implementation,
) -> 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§
Source§impl ClientHandler for InitializeRequestParams
Do nothing, with a specific client config.
impl ClientHandler for InitializeRequestParams
Do nothing, with a specific client config.
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
Source§fn create_elicitation(
&self,
request: ElicitRequestParams,
context: RequestContext<RoleClient>,
) -> impl Future<Output = Result<ElicitResult, 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. Read more
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
Source§impl Clone for InitializeRequestParams
impl Clone for InitializeRequestParams
Source§fn clone(&self) -> InitializeRequestParams
fn clone(&self) -> InitializeRequestParams
Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from
source. Read moreSource§impl Debug for InitializeRequestParams
impl Debug for InitializeRequestParams
Source§impl Default for InitializeRequestParams
impl Default for InitializeRequestParams
Source§fn default() -> InitializeRequestParams
fn default() -> InitializeRequestParams
Returns the “default value” for a type. Read more
Source§impl<'de> Deserialize<'de> for InitializeRequestParams
impl<'de> Deserialize<'de> for InitializeRequestParams
Source§fn deserialize<__D>(
__deserializer: __D,
) -> Result<InitializeRequestParams, <__D as Deserializer<'de>>::Error>where
__D: Deserializer<'de>,
fn deserialize<__D>(
__deserializer: __D,
) -> Result<InitializeRequestParams, <__D as Deserializer<'de>>::Error>where
__D: Deserializer<'de>,
Deserialize this value from the given Serde deserializer. Read more
Source§impl JsonSchema for InitializeRequestParams
impl JsonSchema for InitializeRequestParams
Source§fn schema_id() -> Cow<'static, str>
fn schema_id() -> Cow<'static, str>
Returns a string that uniquely identifies the schema produced by this type. Read more
Source§fn json_schema(generator: &mut SchemaGenerator) -> Schema
fn json_schema(generator: &mut SchemaGenerator) -> Schema
Generates a JSON Schema for this type. Read more
Source§fn inline_schema() -> bool
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. Read moreSource§impl PartialEq for InitializeRequestParams
impl PartialEq for InitializeRequestParams
Source§impl RequestParamsMeta for InitializeRequestParams
impl RequestParamsMeta for InitializeRequestParams
Source§fn meta(&self) -> Option<&RequestMetaObject>
fn meta(&self) -> Option<&RequestMetaObject>
Get a reference to the meta field
Source§fn meta_mut(&mut self) -> &mut Option<RequestMetaObject>
fn meta_mut(&mut self) -> &mut Option<RequestMetaObject>
Get a mutable reference to the meta field
Source§fn set_meta(&mut self, meta: RequestMetaObject)
fn set_meta(&mut self, meta: RequestMetaObject)
Set the meta field
Source§fn progress_token(&self) -> Option<ProgressToken>
fn progress_token(&self) -> Option<ProgressToken>
Get the progress token from meta, if present
Source§fn set_progress_token(&mut self, token: ProgressToken)
fn set_progress_token(&mut self, token: ProgressToken)
Set a progress token in meta
Source§fn traceparent(&self) -> Option<&str>
fn traceparent(&self) -> Option<&str>
Get the W3C
traceparent value from meta, if present (SEP-414)Source§fn set_traceparent(&mut self, value: &str)
fn set_traceparent(&mut self, value: &str)
Set the W3C
traceparent value in meta (SEP-414)Source§fn tracestate(&self) -> Option<&str>
fn tracestate(&self) -> Option<&str>
Get the W3C
tracestate value from meta, if present (SEP-414)Source§fn set_tracestate(&mut self, value: &str)
fn set_tracestate(&mut self, value: &str)
Set the W3C
tracestate value in meta (SEP-414)Source§fn set_baggage(&mut self, value: &str)
fn set_baggage(&mut self, value: &str)
Set the W3C
baggage value in meta (SEP-414)Source§fn meta_or_default(&mut self) -> &mut RequestMetaObject
fn meta_or_default(&mut self) -> &mut RequestMetaObject
Get a mutable reference to meta, inserting an empty one if absent.
Source§impl Serialize for InitializeRequestParams
impl Serialize for InitializeRequestParams
Source§fn serialize<__S>(
&self,
__serializer: __S,
) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>where
__S: Serializer,
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. Read more
impl StructuralPartialEq for InitializeRequestParams
Auto Trait Implementations§
impl Freeze for InitializeRequestParams
impl RefUnwindSafe for InitializeRequestParams
impl Send for InitializeRequestParams
impl Sync for InitializeRequestParams
impl Unpin for InitializeRequestParams
impl UnsafeUnpin for InitializeRequestParams
impl UnwindSafe for InitializeRequestParams
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
Source§impl<S> ClientServiceExt for Swhere
S: Service<RoleClient>,
impl<S> ClientServiceExt for Swhere
S: Service<RoleClient>,
fn serve_with_lifecycle<T, E, A>( self, transport: T, lifecycle: ClientLifecycleMode, ) -> impl Future<Output = Result<RunningService<RoleClient, Self>, ClientInitializeError>> + MaybeSendFuture
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> DeserializeOwned for Twhere
T: for<'de> Deserialize<'de>,
Source§impl<R, S> DynService<R> for Swhere
R: ServiceRole,
S: Service<R>,
impl<R, S> DynService<R> for Swhere
R: ServiceRole,
S: Service<R>,
fn handle_request( &self, request: <R as ServiceRole>::PeerReq, context: RequestContext<R>, ) -> Pin<Box<dyn Future<Output = Result<<R as ServiceRole>::Resp, ErrorData>> + Send + '_>>
fn handle_notification( &self, notification: <R as ServiceRole>::PeerNot, context: NotificationContext<R>, ) -> Pin<Box<dyn Future<Output = Result<(), ErrorData>> + Send + '_>>
fn get_info(&self) -> <R as ServiceRole>::Info
Source§fn supported_protocol_versions(&self) -> Cow<'static, [ProtocolVersion]>
fn supported_protocol_versions(&self) -> Cow<'static, [ProtocolVersion]>
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
Source§fn in_current_span(self) -> Instrumented<Self> ⓘ
fn in_current_span(self) -> Instrumented<Self> ⓘ
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
Converts
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
Converts
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreCreates a shared type from an unshared type.
Source§impl<T> PolicyExt for Twhere
T: ?Sized,
impl<T> PolicyExt for Twhere
T: ?Sized,
impl<T> Read<Exclusive, BecauseExclusive> for Twhere
T: ?Sized,
Source§impl<H> Service<RoleClient> for Hwhere
H: ClientHandler,
impl<H> Service<RoleClient> for Hwhere
H: ClientHandler,
async fn handle_request( &self, request: <RoleClient as ServiceRole>::PeerReq, context: RequestContext<RoleClient>, ) -> Result<<RoleClient as ServiceRole>::Resp, ErrorData>
async fn handle_notification( &self, notification: <RoleClient as ServiceRole>::PeerNot, context: NotificationContext<RoleClient>, ) -> Result<(), ErrorData>
fn get_info(&self) -> <RoleClient as ServiceRole>::Info
Source§fn supported_protocol_versions(&self) -> Cow<'static, [ProtocolVersion]>
fn supported_protocol_versions(&self) -> Cow<'static, [ProtocolVersion]>
The protocol versions this service can speak, bounding what
initialize
negotiation may agree to. Read moreSource§impl<S> ServiceExt<RoleClient> for Swhere
S: Service<RoleClient>,
impl<S> ServiceExt<RoleClient> for Swhere
S: Service<RoleClient>,
fn serve_with_ct<T, E, A>( self, transport: T, ct: CancellationToken, ) -> impl Future<Output = Result<RunningService<RoleClient, S>, ClientInitializeError>> + MaybeSendFuture
Source§fn into_dyn(self) -> Box<dyn DynService<R>>
fn into_dyn(self) -> Box<dyn DynService<R>>
Convert this service to a dynamic boxed service Read more