Struct WebSocketServerTransport 

pub struct WebSocketServerTransport { /* private fields */ }

WebSocket transport for MCP servers

This transport serves MCP requests over WebSocket connections, allowing multiple concurrent clients with bidirectional communication.

Implementations

impl WebSocketServerTransport

pub fn new<S: Into<String>>(bind_addr: S) -> Self

Create a new WebSocket server transport

Arguments

• bind_addr - Address to bind the WebSocket server to (e.g., “0.0.0.0:8080”)

Returns

New WebSocket server transport instance

pub fn with_config<S: Into<String>>( bind_addr: S, config: TransportConfig, ) -> Self

Create a new WebSocket server transport with custom configuration

Arguments

• bind_addr - Address to bind the WebSocket server to
• config - Transport configuration

Returns

New WebSocket server transport instance

pub async fn set_request_handler<F>(&mut self, handler: F)

where F: Fn(JsonRpcRequest) -> Receiver<JsonRpcResponse> + Send + Sync + 'static,

Set the request handler function

Arguments

• handler - Function that processes incoming requests

pub fn config(&self) -> &TransportConfig

Get the current configuration

pub fn max_message_size(&self) -> Option<usize>

Get the maximum message size from config

Trait Implementations

impl ServerTransport for WebSocketServerTransport

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

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

Start the server transport and begin listening for connections

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

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

Send a JSON-RPC notification to the client

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

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

Stop the server transport

fn is_running(&self) -> bool

Check if the server is running

fn server_info(&self) -> String

Get server information for debugging

fn set_request_handler(&mut self, handler: ServerRequestHandler)

Set the request handler that will process incoming requests

fn set_tool_schemas( &mut self, _schemas: HashMap<String, Value>, ) -> McpResult<()>

Provide registered tool input schemas to transports that mirror and validate MCP routing headers. Other transports may ignore them.

fn set_server_capabilities( &mut self, _capabilities: ServerCapabilities, ) -> McpResult<()>

Provide the capabilities used to acknowledge subscription filters.

fn set_task_notifications( &mut self, _receiver: Receiver<JsonRpcNotification>, ) -> McpResult<()>

Attach task-status notifications to the transport’s subscription hub.