io.modelcontextprotocol.server.transport

Class StdioServerTransportProvider

java.lang.Object

io.modelcontextprotocol.server.transport.StdioServerTransportProvider

All Implemented Interfaces:

McpServerTransportProvider, McpServerTransportProviderBase

public class StdioServerTransportProvider
extends Object
implements McpServerTransportProvider

Implementation of the MCP Stdio transport provider for servers that communicates using standard input/output streams. Messages are exchanged as newline-delimited JSON-RPC messages over stdin/stdout, with errors and debug information sent to stderr.

Author:

Christian Tzolov

Constructor Summary

Constructors

Constructor and Description
StdioServerTransportProvider() Creates a new StdioServerTransportProvider with a default ObjectMapper and System streams.
StdioServerTransportProvider(com.fasterxml.jackson.databind.ObjectMapper objectMapper) Creates a new StdioServerTransportProvider with the specified ObjectMapper and System streams.
StdioServerTransportProvider(com.fasterxml.jackson.databind.ObjectMapper objectMapper, InputStream inputStream, OutputStream outputStream) Creates a new StdioServerTransportProvider with the specified ObjectMapper and streams.

Method Summary

Modifier and Type	Method and Description
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.
List<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.

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.McpServerTransportProviderBase

close

Constructor Detail

StdioServerTransportProvider

public StdioServerTransportProvider()

Creates a new StdioServerTransportProvider with a default ObjectMapper and System streams.

StdioServerTransportProvider

public StdioServerTransportProvider(com.fasterxml.jackson.databind.ObjectMapper objectMapper)

Creates a new StdioServerTransportProvider with the specified ObjectMapper and System streams.

Parameters:

objectMapper - The ObjectMapper to use for JSON serialization/deserialization

StdioServerTransportProvider

public StdioServerTransportProvider(com.fasterxml.jackson.databind.ObjectMapper objectMapper,
                                    InputStream inputStream,
                                    OutputStream outputStream)

Creates a new StdioServerTransportProvider with the specified ObjectMapper and streams.

Parameters:

objectMapper - The ObjectMapper to use for JSON serialization/deserialization

inputStream - The input stream to read from

outputStream - The output stream to write to

Method Detail

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(McpServerSession.Factory sessionFactory)

Description copied from interface: 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.

Specified by:

setSessionFactory in interface McpServerTransportProvider

Parameters:

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

notifyClients

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

Description copied from interface: McpServerTransportProviderBase

Sends a notification to all connected clients.

Specified by:

notifyClients in interface McpServerTransportProviderBase

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)

closeGracefully

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

Description copied from interface: McpServerTransportProviderBase

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

Specified by:

closeGracefully in interface McpServerTransportProviderBase

Returns:

a Mono that completes when the connections have been closed.