ServerMessage

Enum ServerMessage 

Source
pub enum ServerMessage {
    Request(ServerJsonrpcRequest),
    Notification(ServerJsonrpcNotification),
    Response(ServerJsonrpcResponse),
    Error(JsonrpcError),
}
Expand description

“Similar to JsonrpcMessage, but with the variants restricted to client-side messages.” ServerMessage represents a message sent by an MCP Server and received by an MCP Client.

Variants§

Implementations§

Source§

impl ServerMessage

Source

pub fn as_response(self) -> Result<ServerJsonrpcResponse, RpcError>

Converts the current message into a ServerJsonrpcResponse if it’s of the correct type.

This function checks if the current message is of type Response. If so, it returns the ServerJsonrpcResponse wrapped in a Result::Ok. If the message is not a Response, it returns an error with a descriptive message indicating the mismatch in expected message types.

§Returns
  • Ok(ServerJsonrpcResponse) if the message is a valid Response.
  • Err(RpcError) if the message type is invalid
Source

pub fn as_request(self) -> Result<ServerJsonrpcRequest, RpcError>

Converts the current message into a ServerJsonrpcRequest if it’s of the correct type.

This function checks if the current message is of type Request. If so, it returns the ServerJsonrpcRequest wrapped in a Result::Ok. If the message is not a Request, it returns an error with a descriptive message indicating the mismatch in expected message types.

§Returns
  • Ok(ServerJsonrpcRequest) if the message is a valid Request.
  • Err(RpcError) if the message type is invalid
Source

pub fn as_notification(self) -> Result<ServerJsonrpcNotification, RpcError>

Converts the current message into a ServerJsonrpcNotification if it’s of the correct type.

This function checks if the current message is of type Notification. If so, it returns the ServerJsonrpcNotification wrapped in a Result::Ok. If the message is not a Notification, it returns an error with a descriptive message indicating the mismatch in expected message types.

§Returns
  • Ok(ServerJsonrpcNotification) if the message is a valid Notification.
  • Err(RpcError) if the message type is invalid
Source

pub fn as_error(self) -> Result<JsonrpcError, RpcError>

Converts the current message into a JsonrpcError if it’s of the correct type.

This function checks if the current message is of type Error. If so, it returns the JsonrpcError wrapped in a Result::Ok. If the message is not a Error, it returns an error with a descriptive message indicating the mismatch in expected message types.

§Returns
  • Ok(JsonrpcError) if the message is a valid Error.
  • Err(RpcError) if the message type is invalid

Trait Implementations§

Source§

impl Clone for ServerMessage

Source§

fn clone(&self) -> ServerMessage

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for ServerMessage

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'de> Deserialize<'de> for ServerMessage

Source§

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

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Display for ServerMessage

Source§

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

Formats the value using the given formatter. Read more
Source§

impl From<ServerJsonrpcNotification> for ServerMessage

Source§

fn from(value: ServerJsonrpcNotification) -> ServerMessage

Converts to this type from the input type.
Source§

impl From<ServerJsonrpcRequest> for ServerMessage

Source§

fn from(value: ServerJsonrpcRequest) -> ServerMessage

Converts to this type from the input type.
Source§

impl From<ServerJsonrpcResponse> for ServerMessage

Source§

fn from(value: ServerJsonrpcResponse) -> ServerMessage

Converts to this type from the input type.
Source§

impl From<ServerMessage> for ServerMessages

Source§

fn from(value: ServerMessage) -> ServerMessages

Converts to this type from the input type.
Source§

impl FromMessage<CallToolResult> for ServerMessage

Source§

impl FromMessage<CancelledNotification> for ServerMessage

Source§

impl FromMessage<CompleteResult> for ServerMessage

Source§

impl FromMessage<CreateMessageRequest> for ServerMessage

Source§

impl FromMessage<ElicitRequest> for ServerMessage

Source§

impl FromMessage<GetPromptResult> for ServerMessage

Source§

impl FromMessage<InitializeResult> for ServerMessage

Source§

impl FromMessage<ListPromptsResult> for ServerMessage

Source§

impl FromMessage<ListResourceTemplatesResult> for ServerMessage

Source§

impl FromMessage<ListResourcesResult> for ServerMessage

Source§

impl FromMessage<ListRootsRequest> for ServerMessage

Source§

impl FromMessage<ListToolsResult> for ServerMessage

Source§

impl FromMessage<LoggingMessageNotification> for ServerMessage

Source§

impl FromMessage<MessageFromServer> for ServerMessage

Source§

impl FromMessage<PingRequest> for ServerMessage

Source§

impl FromMessage<ProgressNotification> for ServerMessage

Source§

impl FromMessage<PromptListChangedNotification> for ServerMessage

Source§

impl FromMessage<ReadResourceResult> for ServerMessage

Source§

impl FromMessage<ResourceListChangedNotification> for ServerMessage

Source§

impl FromMessage<ResourceUpdatedNotification> for ServerMessage

Source§

impl FromMessage<Result> for ServerMessage

Source§

impl FromMessage<ToolListChangedNotification> for ServerMessage

Source§

impl FromStr for ServerMessage

Source§

type Err = RpcError

The associated error which can be returned from parsing.
Source§

fn from_str(s: &str) -> Result<ServerMessage, <ServerMessage as FromStr>::Err>

Parses a string s to return a value of this type. Read more
Source§

impl McpDispatch<ClientMessages, ServerMessages, ClientMessage, ServerMessage> for MessageDispatcher<ClientMessage>

Source§

fn send_message<'life0, 'async_trait>( &'life0 self, messages: ServerMessages, request_timeout: Option<Duration>, ) -> Pin<Box<dyn Future<Output = Result<Option<ClientMessages>, TransportError>> + Send + 'async_trait>>
where 'life0: 'async_trait, MessageDispatcher<ClientMessage>: 'async_trait,

Sends a message from the server to the client and awaits a response if applicable.

Serializes the ServerMessages to JSON, writes it to the transport, and waits for a ClientMessages response if the message is a request. Notifications and responses return Ok(None).

§Arguments
  • messages - The client message to send, coulld be a single message or batch.
§Returns

A TransportResult containing Some(ClientMessages) for requests with a response, or None for notifications/responses, or an error if the operation fails.

§Errors

Returns a TransportError if serialization, writing, or timeout occurs.

Source§

fn write_str<'life0, 'life1, 'async_trait>( &'life0 self, payload: &'life1 str, ) -> Pin<Box<dyn Future<Output = Result<(), TransportError>> + Send + 'async_trait>>
where 'life0: 'async_trait, 'life1: 'async_trait, MessageDispatcher<ClientMessage>: 'async_trait,

Writes a string payload to the underlying asynchronous writable stream, appending a newline character and flushing the stream afterward.

Source§

fn send<'life0, 'async_trait>( &'life0 self, message: ServerMessage, request_timeout: Option<Duration>, ) -> Pin<Box<dyn Future<Output = Result<Option<ClientMessage>, TransportError>> + Send + 'async_trait>>
where 'life0: 'async_trait, MessageDispatcher<ClientMessage>: 'async_trait,

Source§

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

Source§

impl McpDispatch<ClientMessages, ServerMessages, ClientMessage, ServerMessage> for SseTransport<ClientMessage>

Source§

fn send_message<'life0, 'async_trait>( &'life0 self, message: ServerMessages, request_timeout: Option<Duration>, ) -> Pin<Box<dyn Future<Output = Result<Option<ClientMessages>, TransportError>> + Send + 'async_trait>>
where 'life0: 'async_trait, SseTransport<ClientMessage>: 'async_trait,

Sends a raw message represented by type S and optionally includes a request_id. The request_id is used when sending a message in response to an MCP request. It should match the request_id of the original request.
Source§

fn send<'life0, 'async_trait>( &'life0 self, message: ServerMessage, request_timeout: Option<Duration>, ) -> Pin<Box<dyn Future<Output = Result<Option<ClientMessage>, TransportError>> + Send + 'async_trait>>
where 'life0: 'async_trait, SseTransport<ClientMessage>: 'async_trait,

Source§

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

Source§

fn write_str<'life0, 'life1, 'async_trait>( &'life0 self, payload: &'life1 str, ) -> Pin<Box<dyn Future<Output = Result<(), TransportError>> + Send + 'async_trait>>
where 'life0: 'async_trait, 'life1: 'async_trait, SseTransport<ClientMessage>: 'async_trait,

Writes a string payload to the underlying asynchronous writable stream, appending a newline character and flushing the stream afterward.
Source§

impl McpDispatch<ClientMessages, ServerMessages, ClientMessage, ServerMessage> for StdioTransport<ClientMessage>

Source§

fn send_message<'life0, 'async_trait>( &'life0 self, message: ServerMessages, request_timeout: Option<Duration>, ) -> Pin<Box<dyn Future<Output = Result<Option<ClientMessages>, TransportError>> + Send + 'async_trait>>
where 'life0: 'async_trait, StdioTransport<ClientMessage>: 'async_trait,

Sends a raw message represented by type S and optionally includes a request_id. The request_id is used when sending a message in response to an MCP request. It should match the request_id of the original request.
Source§

fn send<'life0, 'async_trait>( &'life0 self, message: ServerMessage, request_timeout: Option<Duration>, ) -> Pin<Box<dyn Future<Output = Result<Option<ClientMessage>, TransportError>> + Send + 'async_trait>>
where 'life0: 'async_trait, StdioTransport<ClientMessage>: 'async_trait,

Source§

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

Source§

fn write_str<'life0, 'life1, 'async_trait>( &'life0 self, payload: &'life1 str, ) -> Pin<Box<dyn Future<Output = Result<(), TransportError>> + Send + 'async_trait>>
where 'life0: 'async_trait, 'life1: 'async_trait, StdioTransport<ClientMessage>: 'async_trait,

Writes a string payload to the underlying asynchronous writable stream, appending a newline character and flushing the stream afterward.
Source§

impl McpDispatch<ServerMessages, ClientMessages, ServerMessage, ClientMessage> for MessageDispatcher<ServerMessage>

Source§

fn send_message<'life0, 'async_trait>( &'life0 self, messages: ClientMessages, request_timeout: Option<Duration>, ) -> Pin<Box<dyn Future<Output = Result<Option<ServerMessages>, TransportError>> + Send + 'async_trait>>
where 'life0: 'async_trait, MessageDispatcher<ServerMessage>: 'async_trait,

Sends a message from the client to the server and awaits a response if applicable.

Serializes the ClientMessages to JSON, writes it to the transport, and waits for a ServerMessages response if the message is a request. Notifications and responses return Ok(None).

§Arguments
  • messages - The client message to send, coulld be a single message or batch.
§Returns

A TransportResult containing Some(ServerMessages) for requests with a response, or None for notifications/responses, or an error if the operation fails.

§Errors

Returns a TransportError if serialization, writing, or timeout occurs.

Source§

fn write_str<'life0, 'life1, 'async_trait>( &'life0 self, payload: &'life1 str, ) -> Pin<Box<dyn Future<Output = Result<(), TransportError>> + Send + 'async_trait>>
where 'life0: 'async_trait, 'life1: 'async_trait, MessageDispatcher<ServerMessage>: 'async_trait,

Writes a string payload to the underlying asynchronous writable stream, appending a newline character and flushing the stream afterward.

Source§

fn send<'life0, 'async_trait>( &'life0 self, message: ClientMessage, request_timeout: Option<Duration>, ) -> Pin<Box<dyn Future<Output = Result<Option<ServerMessage>, TransportError>> + Send + 'async_trait>>
where 'life0: 'async_trait, MessageDispatcher<ServerMessage>: 'async_trait,

Source§

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

Source§

impl McpMessage for ServerMessage

Source§

fn message_type(&self) -> MessageTypes

Determines the type of the message and returns the corresponding MessageTypes variant.

Source§

fn is_response(&self) -> bool

Source§

fn is_request(&self) -> bool

Source§

fn is_notification(&self) -> bool

Source§

fn is_error(&self) -> bool

Source§

impl RpcMessage for ServerMessage

Source§

impl Serialize for ServerMessage

Source§

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
Source§

impl ToMessage<ServerMessage> for CallToolResult

Source§

impl ToMessage<ServerMessage> for CancelledNotification

Source§

impl ToMessage<ServerMessage> for CompleteResult

Source§

impl ToMessage<ServerMessage> for CreateMessageRequest

Source§

impl ToMessage<ServerMessage> for ElicitRequest

Source§

impl ToMessage<ServerMessage> for GetPromptResult

Source§

impl ToMessage<ServerMessage> for InitializeResult

Source§

impl ToMessage<ServerMessage> for ListPromptsResult

Source§

impl ToMessage<ServerMessage> for ListResourceTemplatesResult

Source§

impl ToMessage<ServerMessage> for ListResourcesResult

Source§

impl ToMessage<ServerMessage> for ListRootsRequest

Source§

impl ToMessage<ServerMessage> for ListToolsResult

Source§

impl ToMessage<ServerMessage> for LoggingMessageNotification

Source§

impl ToMessage<ServerMessage> for PingRequest

Source§

impl ToMessage<ServerMessage> for ProgressNotification

Source§

impl ToMessage<ServerMessage> for PromptListChangedNotification

Source§

impl ToMessage<ServerMessage> for ReadResourceResult

Source§

impl ToMessage<ServerMessage> for ResourceListChangedNotification

Source§

impl ToMessage<ServerMessage> for ResourceUpdatedNotification

Source§

impl ToMessage<ServerMessage> for Result

Source§

impl ToMessage<ServerMessage> for ToolListChangedNotification

Source§

impl Transport<ClientMessages, MessageFromServer, ClientMessage, ServerMessages, ServerMessage> for SseTransport<ClientMessage>

Source§

fn start<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<ReceiverStream<ClientMessages>, TransportError>> + Send + 'async_trait>>

Starts the transport, initializing streams and message dispatcher

Sets up the MCP stream and dispatcher using the provided duplex streams.

§Returns
  • TransportResult<(Pin<Box<dyn Stream<Item = R> + Send>>, MessageDispatcher<R>, IoStream)>
    • The message stream, dispatcher, and error stream
§Errors
  • Returns TransportError if streams are already taken or not initialized
Source§

fn is_shut_down<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = bool> + Send + 'async_trait>>
where 'life0: 'async_trait, SseTransport<ClientMessage>: 'async_trait,

Checks if the transport has been shut down

§Returns
  • bool - True if the transport is shut down, false otherwise
Source§

fn shut_down<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<(), TransportError>> + Send + 'async_trait>>
where 'life0: 'async_trait, SseTransport<ClientMessage>: 'async_trait,

Shuts down the transport, terminating tasks and signaling closure

Cancels any running tasks and clears the cancellation source.

§Returns
  • TransportResult<()> - Ok if shutdown is successful, Err if cancellation fails
Source§

fn message_sender( &self, ) -> Arc<RwLock<Option<MessageDispatcher<ClientMessage>>>>

Source§

fn error_stream(&self) -> &RwLock<Option<IoStream>>

Source§

fn consume_string_payload<'life0, 'life1, 'async_trait>( &'life0 self, payload: &'life1 str, ) -> Pin<Box<dyn Future<Output = Result<(), TransportError>> + Send + 'async_trait>>
where 'life0: 'async_trait, 'life1: 'async_trait, SseTransport<ClientMessage>: 'async_trait,

Source§

fn keep_alive<'life0, 'async_trait>( &'life0 self, interval: Duration, disconnect_tx: Sender<()>, ) -> Pin<Box<dyn Future<Output = Result<JoinHandle<()>, TransportError>> + Send + 'async_trait>>
where 'life0: 'async_trait, SseTransport<ClientMessage>: 'async_trait,

Source§

fn pending_request_tx<'life0, 'life1, 'async_trait>( &'life0 self, request_id: &'life1 RequestId, ) -> Pin<Box<dyn Future<Output = Option<Sender<ClientMessage>>> + Send + 'async_trait>>
where 'life0: 'async_trait, 'life1: 'async_trait, SseTransport<ClientMessage>: 'async_trait,

Source§

impl TransportDispatcher<ClientMessages, MessageFromServer, ClientMessage, ServerMessages, ServerMessage> for SseTransport<ClientMessage>

Source§

impl TransportDispatcher<ClientMessages, MessageFromServer, ClientMessage, ServerMessages, ServerMessage> for StdioTransport<ClientMessage>

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> FromRef<T> for T
where T: Clone,

Source§

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.
Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

impl<T> ToStringFallible for T
where T: Display,

Source§

fn try_to_string(&self) -> Result<String, TryReserveError>

ToString::to_string, but without panic on OOM.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> ErasedDestructor for T
where T: 'static,