io.modelcontextprotocol.server.transport

Class WebRxStreamableServerTransportProvider

java.lang.Object

io.modelcontextprotocol.server.transport.WebRxStreamableServerTransportProvider

All Implemented Interfaces:

IMcpHttpServerTransport, McpServerTransportProviderBase, McpStreamableServerTransportProvider

public class WebRxStreamableServerTransportProvider
extends Object
implements McpStreamableServerTransportProvider, IMcpHttpServerTransport

Server-side implementation of the Model Context Protocol (MCP) streamable 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.

Author:

Christian Tzolov, Dariusz Jędrzejczyk, noear

See Also:

McpStreamableServerTransportProvider

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	WebRxStreamableServerTransportProvider.Builder Builder for creating instances of WebRxStreamableServerTransportProvider.

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_BASE_URL Default base URL for the message endpoint.
static String	ENDPOINT_EVENT_TYPE Event type for sending the message endpoint URI to clients.
static String	MESSAGE_EVENT_TYPE Event type for JSON-RPC messages sent through the SSE connection.

Method Summary

Modifier and Type	Method and Description
static WebRxStreamableServerTransportProvider.Builder	builder()
reactor.core.publisher.Mono<Void>	closeGracefully() Initiates a graceful shutdown of the transport.
String	getMcpEndpoint()
reactor.core.publisher.Mono<Void>	notifyClients(String method, Object params) Broadcasts a notification to all connected clients through their SSE connections.
List<String>	protocolVersions() Returns the protocol version supported by this transport provider.
void	setSessionFactory(McpStreamableServerSession.Factory sessionFactory) Sets the session factory that will be used to create sessions for new clients.
void	toHttpHandler(org.noear.solon.SolonApp app)

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.modelcontextprotocol.spec.McpStreamableServerTransportProvider

close

Field Detail

MESSAGE_EVENT_TYPE

public static final String MESSAGE_EVENT_TYPE

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

See Also:

Constant Field Values

ENDPOINT_EVENT_TYPE

public static final String ENDPOINT_EVENT_TYPE

Event type for sending the message endpoint URI to clients.

See Also:

Constant Field Values

DEFAULT_BASE_URL

public static final String DEFAULT_BASE_URL

Default base URL for the message endpoint.

See Also:

Constant Field Values

Method Detail

toHttpHandler

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

Specified by:

toHttpHandler in interface IMcpHttpServerTransport

getMcpEndpoint

public String getMcpEndpoint()

Specified by:

getMcpEndpoint in interface IMcpHttpServerTransport

protocolVersions

public List<String> protocolVersions()

Description copied from interface: McpServerTransportProviderBase

Returns the protocol version supported by this transport provider.

Specified by:

protocolVersions in interface McpServerTransportProviderBase

Returns:

the protocol version as a string

setSessionFactory

public void setSessionFactory(McpStreamableServerSession.Factory sessionFactory)

Description copied from interface: McpStreamableServerTransportProvider

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.

Specified by:

setSessionFactory in interface McpStreamableServerTransportProvider

Parameters:

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

notifyClients

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

Broadcasts a notification to all connected clients through their SSE connections. If any errors occur during sending to a particular client, they are logged but don't prevent sending to other clients.

Specified by:

notifyClients in interface McpServerTransportProviderBase

Specified by:

notifyClients in interface McpStreamableServerTransportProvider

Parameters:

method - The method name for the notification

params - The parameters for the notification

Returns:

A Mono that completes when the broadcast attempt is finished

See Also:

McpSession#sendNotification(String, Map)

closeGracefully

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

Initiates a graceful shutdown of the transport.

Specified by:

closeGracefully in interface McpServerTransportProviderBase

Specified by:

closeGracefully in interface McpStreamableServerTransportProvider

Returns:

A Mono that completes when all cleanup operations are finished

builder

public static WebRxStreamableServerTransportProvider.Builder builder()