io.modelcontextprotocol.server.transport

类 WebRxSseServerTransportProvider

java.lang.Object

io.modelcontextprotocol.server.transport.WebRxSseServerTransportProvider

所有已实现的接口:

IMcpHttpServerTransport, McpServerTransportProvider, McpServerTransportProviderBase

public class WebRxSseServerTransportProvider
extends java.lang.Object
implements McpServerTransportProvider, IMcpHttpServerTransport

Server-side implementation of the Model Context Protocol (MCP) transport layer using HTTP with Server-Sent Events (SSE) through Spring WebMVC. This implementation provides a bridge between synchronous WebMVC operations and reactive programming patterns to maintain compatibility with the reactive transport interface.

Key features:

• Implements bidirectional communication using HTTP POST for client-to-server messages and SSE for server-to-client messages
• Manages client sessions with unique IDs for reliable message delivery
• Supports graceful shutdown with proper session cleanup
• Provides JSON-RPC message handling through configured endpoints
• Includes built-in error handling and logging

The transport operates on two main endpoints:

• /sse - The SSE endpoint where clients establish their event stream connection
• A configurable message endpoint where clients send their JSON-RPC messages via HTTP POST

This implementation uses ConcurrentHashMap to safely manage multiple client sessions in a thread-safe manner. Each client session is assigned a unique ID and maintains its own SSE connection.

另请参阅:

McpServerTransportProvider, Handler

嵌套类概要

嵌套类

限定符和类型	类和说明
static class	WebRxSseServerTransportProvider.Builder Builder for creating instances of WebMvcSseServerTransportProvider.

字段概要

字段

限定符和类型	字段和说明
static java.lang.String	DEFAULT_SSE_ENDPOINT Default SSE endpoint path as specified by the MCP transport specification.
static java.lang.String	ENDPOINT_EVENT_TYPE Event type for sending the message endpoint URI to clients.
static java.lang.String	MESSAGE_EVENT_TYPE Event type for JSON-RPC messages sent through the SSE connection.

构造器概要

构造器

构造器和说明
WebRxSseServerTransportProvider(com.fasterxml.jackson.databind.ObjectMapper objectMapper, java.lang.String baseUrl, java.lang.String messageEndpoint, java.lang.String sseEndpoint, McpTransportContextExtractor<org.noear.solon.core.handle.Context> contextExtractor, java.time.Duration keepAliveInterval) 已过时。 Use the builder builder() instead for better configuration options.

方法概要

限定符和类型	方法和说明
static WebRxSseServerTransportProvider.Builder	builder() Creates a new Builder instance for configuring and creating instances of WebMvcSseServerTransportProvider.
reactor.core.publisher.Mono<java.lang.Void>	closeGracefully() Initiates a graceful shutdown of the transport.
java.lang.String	getMcpEndpoint()
reactor.core.publisher.Mono<java.lang.Void>	notifyClients(java.lang.String method, java.lang.Object params) Broadcasts a notification to all connected clients through their SSE connections.
java.util.List<java.lang.String>	protocolVersions() Returns the protocol version supported by this transport provider.
void	setSessionFactory(McpServerSession.Factory sessionFactory) Sets the session factory that will be used to create sessions for new clients.
void	toHttpHandler(org.noear.solon.SolonApp app)

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

从接口继承的方法 io.modelcontextprotocol.spec.McpServerTransportProviderBase

close

字段详细资料

MESSAGE_EVENT_TYPE

public static final java.lang.String MESSAGE_EVENT_TYPE

Event type for JSON-RPC messages sent through the SSE connection.

另请参阅:

常量字段值

ENDPOINT_EVENT_TYPE

public static final java.lang.String ENDPOINT_EVENT_TYPE

Event type for sending the message endpoint URI to clients.

另请参阅:

常量字段值

DEFAULT_SSE_ENDPOINT

public static final java.lang.String DEFAULT_SSE_ENDPOINT

Default SSE endpoint path as specified by the MCP transport specification.

另请参阅:

常量字段值

构造器详细资料

WebRxSseServerTransportProvider

@Deprecated
public WebRxSseServerTransportProvider(com.fasterxml.jackson.databind.ObjectMapper objectMapper,
                                                   java.lang.String baseUrl,
                                                   java.lang.String messageEndpoint,
                                                   java.lang.String sseEndpoint,
                                                   McpTransportContextExtractor<org.noear.solon.core.handle.Context> contextExtractor,
                                                   java.time.Duration keepAliveInterval)

已过时。 Use the builder builder() instead for better configuration options.

Constructs a new WebMvcSseServerTransportProvider instance.

参数:

objectMapper - The ObjectMapper to use for JSON serialization/deserialization of messages.

baseUrl - The base URL for the message endpoint, used to construct the full endpoint URL for clients.

messageEndpoint - The endpoint URI where clients should send their JSON-RPC messages via HTTP POST. This endpoint will be communicated to clients through the SSE connection's initial endpoint event.

sseEndpoint - The endpoint URI where clients establish their SSE connections. * @param keepAliveInterval The interval for sending keep-alive messages to

抛出:

java.lang.IllegalArgumentException - if any parameter is null

方法详细资料

toHttpHandler

public void toHttpHandler(org.noear.solon.SolonApp app)

指定者:

toHttpHandler 在接口中 IMcpHttpServerTransport

getMcpEndpoint

public java.lang.String getMcpEndpoint()

指定者:

getMcpEndpoint 在接口中 IMcpHttpServerTransport

protocolVersions

public java.util.List<java.lang.String> protocolVersions()

从接口复制的说明: McpServerTransportProviderBase

Returns the protocol version supported by this transport provider.

指定者:

protocolVersions 在接口中 McpServerTransportProviderBase

返回:

the protocol version as a string

setSessionFactory

public void setSessionFactory(McpServerSession.Factory sessionFactory)

从接口复制的说明: McpServerTransportProvider

Sets the session factory that will be used to create sessions for new clients. An implementation of the MCP server MUST call this method before any MCP interactions take place.

指定者:

setSessionFactory 在接口中 McpServerTransportProvider

参数:

sessionFactory - the session factory to be used for initiating client sessions

notifyClients

public reactor.core.publisher.Mono<java.lang.Void> notifyClients(java.lang.String method,
                                                                 java.lang.Object params)

Broadcasts a notification to all connected clients through their SSE connections. The message is serialized to JSON and sent as an SSE event with type "message". If any errors occur during sending to a particular client, they are logged but don't prevent sending to other clients.

指定者:

notifyClients 在接口中 McpServerTransportProviderBase

参数:

method - The method name for the notification

params - The parameters for the notification

返回:

A Mono that completes when the broadcast attempt is finished

另请参阅:

McpSession#sendNotification(String, Map)

closeGracefully

public reactor.core.publisher.Mono<java.lang.Void> closeGracefully()

Initiates a graceful shutdown of the transport. This method:

• Sets the closing flag to prevent new connections
• Closes all active SSE connections
• Removes all session records

指定者:

closeGracefully 在接口中 McpServerTransportProviderBase

返回:

A Mono that completes when all cleanup operations are finished

builder

public static WebRxSseServerTransportProvider.Builder builder()

Creates a new Builder instance for configuring and creating instances of WebMvcSseServerTransportProvider.

返回:

A new Builder instance