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( &self, client_details: InitializeRequestParams, ) -> SdkResult<()>

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<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = SdkResult<()>> + Send + 'async_trait>>

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

Main runtime loop, processes incoming messages and handles requests

fn sender<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = &RwLock<Option<MessageDispatcher<ClientMessage>>>> + Send + 'async_trait>>

where MessageDispatcher<ClientMessage>: McpDispatch<ClientMessage, MessageFromServer>, 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 get_client_info(&self) -> Option<InitializeRequestParams>

👎Deprecated since 0.2.0: Use client_info() instead.

fn get_server_info(&self) -> &InitializeResult

👎Deprecated since 0.2.0: Use server_info() instead.

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 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 list_roots<'life0, 'async_trait>( &'life0 self, params: Option<ListRootsRequestParams>, ) -> 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 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,

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 send_prompt_list_changed<'life0, 'async_trait>( &'life0 self, params: Option<PromptListChangedNotificationParams>, ) -> 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 that the list of prompts it offers has changed. This may be issued by servers without any previous subscription from the client.

fn send_resource_list_changed<'life0, 'async_trait>( &'life0 self, params: Option<ResourceListChangedNotificationParams>, ) -> 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 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 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,

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 send_tool_list_changed<'life0, 'async_trait>( &'life0 self, params: Option<ToolListChangedNotificationParams>, ) -> 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 that the list of tools it offers has changed. This may be issued by servers without any previous subscription from the client.

fn ping<'life0, 'async_trait>( &'life0 self, 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 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,

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 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 assert_client_capabilities( &self, request_method: &String, ) -> Result<(), RpcError>

Asserts that client capabilities are available for a given server request.

fn assert_server_notification_capabilities( &self, notification_method: &String, ) -> Result<(), RpcError>

fn assert_server_request_capabilities( &self, request_method: &String, ) -> Result<(), RpcError>