Struct ServerRuntime 

pub struct ServerRuntime { /* private fields */ }

Struct representing the runtime core of the MCP server, handling transport and client details

Trait Implementations

impl McpServer for ServerRuntime

fn set_client_details<'life0, 'async_trait>( &'life0 self, client_details: InitializeRequestParams, ) -> Pin<Box<dyn Future<Output = SdkResult<()>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Set the client details, storing them in client_details

fn server_info(&self) -> &InitializeResult

Returns the server’s details, including server capability, instructions, protocol_version , server_info and optional meta data

fn client_info(&self) -> Option<InitializeRequestParams>

Returns the client information if available, after successful initialization , otherwise returns None

fn start<'async_trait>( self: Arc<Self>, ) -> Pin<Box<dyn Future<Output = SdkResult<()>> + Send + 'async_trait>>

where Self: 'async_trait,

Main runtime loop, processes incoming messages and handles requests

fn task_store(&self) -> Option<Arc<ServerTaskStore>>

Returns the server-side task store, if available.

fn client_task_store(&self) -> Option<Arc<ClientTaskStore>>

Returns the client-side task store, if available.

fn update_auth_info<'life0, 'async_trait>( &'life0 self, new_auth_info: Option<AuthInfo>, ) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

fn auth_info<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = RwLockReadGuard<'_, Option<AuthInfo>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

fn auth_info_cloned<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Option<AuthInfo>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

fn wait_for_initialization<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

fn send<'life0, 'async_trait>( &'life0 self, message: MessageFromServer, request_id: Option<RequestId>, request_timeout: Option<Duration>, ) -> Pin<Box<dyn Future<Output = SdkResult<Option<ClientMessage>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

fn send_batch<'life0, 'async_trait>( &'life0 self, messages: Vec<ServerMessage>, request_timeout: Option<Duration>, ) -> Pin<Box<dyn Future<Output = SdkResult<Option<Vec<ClientMessage>>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

fn stderr_message<'life0, 'async_trait>( &'life0 self, message: String, ) -> Pin<Box<dyn Future<Output = SdkResult<()>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Sends a message to the standard error output (stderr) asynchronously.

fn session_id(&self) -> Option<SessionId>

fn client_supports_sampling(&self) -> Option<bool>

Checks if the client supports sampling.

fn client_supports_root_list(&self) -> Option<bool>

Checks if the client supports listing roots.

fn client_supports_experimental(&self) -> Option<bool>

Checks if the client has experimental capabilities available.

fn is_initialized(&self) -> bool

Checks whether the server has been initialized with client

fn client_version(&self) -> Option<Implementation>

Returns the client’s name and version information once initialization is complete. This method retrieves the client details, if available, after successful initialization.

fn capabilities(&self) -> &ServerCapabilities

Returns the server’s capabilities.

fn request<'life0, 'async_trait>( &'life0 self, request: RequestFromServer, timeout: Option<Duration>, ) -> Pin<Box<dyn Future<Output = SdkResult<ResultFromClient>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Sends a request to the client and processes the response.

fn request_elicitation<'life0, 'async_trait>( &'life0 self, params: ElicitRequestParams, ) -> Pin<Box<dyn Future<Output = SdkResult<ElicitResult>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Sends an elicitation request to the client to prompt user input and returns the received response.

fn request_elicitation_task<'life0, 'async_trait>( &'life0 self, params: ElicitRequestParams, ) -> Pin<Box<dyn Future<Output = SdkResult<CreateTaskResult>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

fn request_root_list<'life0, 'async_trait>( &'life0 self, params: Option<RequestParams>, ) -> Pin<Box<dyn Future<Output = SdkResult<ListRootsResult>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Request a list of root URIs from the client. Roots allow servers to ask for specific directories or files to operate on. A common example for roots is providing a set of repositories or directories a server should operate on. This request is typically used when the server needs to understand the file system structure or access specific locations that the client has permission to read from

fn ping<'life0, 'async_trait>( &'life0 self, params: Option<RequestParams>, timeout: Option<Duration>, ) -> Pin<Box<dyn Future<Output = SdkResult<Result>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

A ping request to check that the other party is still alive. The receiver must promptly respond, or else may be disconnected.

fn request_message_creation<'life0, 'async_trait>( &'life0 self, params: CreateMessageRequestParams, ) -> Pin<Box<dyn Future<Output = SdkResult<CreateMessageResult>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

A request from the server to sample an LLM via the client. The client has full discretion over which model to select. The client should also inform the user before beginning sampling, to allow them to inspect the request (human in the loop) and decide whether to approve it.

fn request_get_task<'life0, 'async_trait>( &'life0 self, params: GetTaskParams, ) -> Pin<Box<dyn Future<Output = SdkResult<GetTaskResult>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Send a request to retrieve the state of a task.

fn request_get_task_payload<'life0, 'async_trait>( &'life0 self, params: GetTaskPayloadParams, ) -> Pin<Box<dyn Future<Output = SdkResult<ClientTaskResult>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Send a request to retrieve the result of a completed task.

fn request_task_cancellation<'life0, 'async_trait>( &'life0 self, params: CancelTaskParams, ) -> Pin<Box<dyn Future<Output = SdkResult<CancelTaskResult>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Send a request to cancel a task.

fn request_task_list<'life0, 'async_trait>( &'life0 self, params: Option<PaginatedRequestParams>, ) -> Pin<Box<dyn Future<Output = SdkResult<ListTasksResult>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

A request to retrieve a list of tasks.

fn request_custom<'life0, 'async_trait>( &'life0 self, params: CustomRequest, ) -> Pin<Box<dyn Future<Output = SdkResult<GenericResult>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Send a custom request with a custom method name and params

fn send_notification<'life0, 'async_trait>( &'life0 self, notification: NotificationFromServer, ) -> Pin<Box<dyn Future<Output = SdkResult<()>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Sends a notification. This is a one-way message that is not expected to return any response. The method asynchronously sends the notification using the transport layer and does not wait for any acknowledgement or result.

fn notify_log_message<'life0, 'async_trait>( &'life0 self, params: LoggingMessageNotificationParams, ) -> Pin<Box<dyn Future<Output = SdkResult<()>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Send log message notification from server to client. If no logging/setLevel request has been sent from the client, the server MAY decide which messages to send automatically.

fn notify_prompt_list_changed<'life0, 'async_trait>( &'life0 self, params: Option<NotificationParams>, ) -> Pin<Box<dyn Future<Output = SdkResult<()>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Send an optional notification from the server to the client, informing it that the list of prompts it offers has changed. This may be issued by servers without any previous subscription from the client.

fn notify_resource_list_changed<'life0, 'async_trait>( &'life0 self, params: Option<NotificationParams>, ) -> Pin<Box<dyn Future<Output = SdkResult<()>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Send an optional notification from the server to the client, informing it that the list of resources it can read from has changed. This may be issued by servers without any previous subscription from the client.

fn notify_resource_updated<'life0, 'async_trait>( &'life0 self, params: ResourceUpdatedNotificationParams, ) -> Pin<Box<dyn Future<Output = SdkResult<()>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Send a notification from the server to the client, informing it that a resource has changed and may need to be read again. This should only be sent if the client previously sent a resources/subscribe request.

fn notify_tool_list_changed<'life0, 'async_trait>( &'life0 self, params: Option<NotificationParams>, ) -> Pin<Box<dyn Future<Output = SdkResult<()>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Send an optional notification from the server to the client, informing it that the list of tools it offers has changed. This may be issued by servers without any previous subscription from the client.

fn notify_cancellation<'life0, 'async_trait>( &'life0 self, params: CancelledNotificationParams, ) -> Pin<Box<dyn Future<Output = SdkResult<()>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

This notification can be sent to indicate that it is cancelling a previously-issued request. The request SHOULD still be in-flight, but due to communication latency, it is always possible that this notification MAY arrive after the request has already finished. This notification indicates that the result will be unused, so any associated processing SHOULD cease. A client MUST NOT attempt to cancel its initialize request. For task cancellation, use the tasks/cancel request instead of this notification.

fn notify_progress<'life0, 'async_trait>( &'life0 self, params: ProgressNotificationParams, ) -> Pin<Box<dyn Future<Output = SdkResult<()>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Send an out-of-band notification used to inform the receiver of a progress update for a long-running request.

fn notify_task_status<'life0, 'async_trait>( &'life0 self, params: TaskStatusNotificationParams, ) -> Pin<Box<dyn Future<Output = SdkResult<()>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Send an optional notification from the receiver to the requestor, informing them that a task’s status has changed. Receivers are not required to send these notifications.

fn notify_elicitation_completed<'life0, 'async_trait>( &'life0 self, params: ElicitCompleteParams, ) -> Pin<Box<dyn Future<Output = SdkResult<()>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

An optional notification from the server to the client, informing it of a completion of a out-of-band elicitation request.

fn notify_custom<'life0, 'async_trait>( &'life0 self, params: CustomNotification, ) -> Pin<Box<dyn Future<Output = SdkResult<()>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Send a custom notification

fn list_roots<'life0, 'async_trait>( &'life0 self, params: Option<RequestParams>, ) -> Pin<Box<dyn Future<Output = SdkResult<ListRootsResult>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

👎Deprecated since 0.8.0:

Use request_root_list() instead.

fn elicit_input<'life0, 'async_trait>( &'life0 self, params: ElicitRequestParams, ) -> Pin<Box<dyn Future<Output = SdkResult<ElicitResult>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

👎Deprecated since 0.8.0:

Use request_elicitation() instead.

fn create_message<'life0, 'async_trait>( &'life0 self, params: CreateMessageRequestParams, ) -> Pin<Box<dyn Future<Output = SdkResult<CreateMessageResult>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

👎Deprecated since 0.8.0:

Use request_message_creation() instead.

fn send_tool_list_changed<'life0, 'async_trait>( &'life0 self, params: Option<NotificationParams>, ) -> Pin<Box<dyn Future<Output = SdkResult<()>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

👎Deprecated since 0.8.0:

Use notify_tool_list_changed() instead.

fn send_resource_updated<'life0, 'async_trait>( &'life0 self, params: ResourceUpdatedNotificationParams, ) -> Pin<Box<dyn Future<Output = SdkResult<()>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

👎Deprecated since 0.8.0:

Use notify_resource_updated() instead.

fn send_resource_list_changed<'life0, 'async_trait>( &'life0 self, params: Option<NotificationParams>, ) -> Pin<Box<dyn Future<Output = SdkResult<()>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

👎Deprecated since 0.8.0:

Use notify_resource_list_changed() instead.

fn send_prompt_list_changed<'life0, 'async_trait>( &'life0 self, params: Option<NotificationParams>, ) -> Pin<Box<dyn Future<Output = SdkResult<()>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

👎Deprecated since 0.8.0:

Use notify_prompt_list_changed() instead.

fn send_logging_message<'life0, 'async_trait>( &'life0 self, params: LoggingMessageNotificationParams, ) -> Pin<Box<dyn Future<Output = SdkResult<()>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

👎Deprecated since 0.8.0:

Use notify_log_message() instead.