io.modelcontextprotocol.spec

Interface McpServerTransportProviderBase

All Known Subinterfaces:

McpServerTransportProvider, McpStreamableServerTransportProvider

All Known Implementing Classes:

StdioServerTransportProvider, WebRxSseServerTransportProvider, WebRxStreamableServerTransportProvider

public interface McpServerTransportProviderBase

The core building block providing the server-side MCP transport. Implement this interface to bridge between a particular server-side technology and the MCP server transport layer.

The lifecycle of the provider dictates that it be created first, upon application startup, and then passed into either McpServer.sync(McpServerTransportProvider) or McpServer.async(McpServerTransportProvider). As a result of the MCP server creation, the provider will be notified of a McpServerSession.Factory which will be used to handle a 1:1 communication between a newly connected client and the server. The provider's responsibility is to create instances of McpServerTransport that the session will utilise during the session lifetime.

Finally, the McpServerTransports can be closed in bulk when close() or closeGracefully() are called as part of the normal application shutdown event. Individual McpServerTransports can also be closed on a per-session basis, where the McpServerSession.close() or McpServerSession.closeGracefully() closes the provided transport.

Author:

Dariusz Jędrzejczyk

Method Summary

Modifier and Type	Method and Description
default void	close() Immediately closes all the transports with connected clients and releases any associated resources.
reactor.core.publisher.Mono<Void>	closeGracefully() Gracefully closes all the transports with connected clients and releases any associated resources asynchronously.
reactor.core.publisher.Mono<Void>	notifyClients(String method, Object params) Sends a notification to all connected clients.
default List<String>	protocolVersions() Returns the protocol version supported by this transport provider.

Method Detail

notifyClients

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

Sends a notification to all connected clients.

Parameters:

method - the name of the notification method to be called on the clients

params - parameters to be sent with the notification

Returns:

a Mono that completes when the notification has been broadcast

See Also:

McpSession#sendNotification(String, Map)

close

default void close()

Immediately closes all the transports with connected clients and releases any associated resources.

closeGracefully

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

Gracefully closes all the transports with connected clients and releases any associated resources asynchronously.

Returns:

a Mono that completes when the connections have been closed.

protocolVersions

default List<String> protocolVersions()

Returns the protocol version supported by this transport provider.

Returns:

the protocol version as a string