Module io.modelcontextprotocol.sdk.mcp

Package io.modelcontextprotocol.spec

Class DefaultMcpTransportStream<CONNECTION>

java.lang.Object

io.modelcontextprotocol.spec.DefaultMcpTransportStream<CONNECTION>

Type Parameters:

CONNECTION - the resource serving the stream

All Implemented Interfaces:

McpTransportStream<CONNECTION>

public class DefaultMcpTransportStream<CONNECTION>
extends Object
implements McpTransportStream<CONNECTION>

An implementation of McpTransportStream using Project Reactor types.

Author:

Dariusz Jędrzejczyk

Constructor Summary

Constructors

Constructor	Description
DefaultMcpTransportStream(boolean resumable, Function<McpTransportStream<CONNECTION>,org.reactivestreams.Publisher<CONNECTION>> reconnect)	Constructs a new instance representing a particular stream that can resume using the provided reconnect mechanism.

Method Summary

Modifier and Type	Method	Description
org.reactivestreams.Publisher<McpSchema.JSONRPCMessage>	consumeSseStream(org.reactivestreams.Publisher<reactor.util.function.Tuple2<Optional<String>,Iterable<McpSchema.JSONRPCMessage>>> eventStream)	Allows keeping track of the transport stream of events (currently an SSE stream from Streamable HTTP specification) and enable resumability and reconnects in case of stream errors.
Optional<String>	lastId()	The last observed event identifier.
long	streamId()	An internal stream identifier used to distinguish streams while debugging.

Methods inherited from class java.lang.Object

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

Constructor Details

DefaultMcpTransportStream

public DefaultMcpTransportStream(boolean resumable,
 Function<McpTransportStream<CONNECTION>,org.reactivestreams.Publisher<CONNECTION>> reconnect)

Constructs a new instance representing a particular stream that can resume using the provided reconnect mechanism.

Parameters:

resumable - whether the stream is resumable and should try to reconnect

reconnect - the mechanism to use in case an error is observed on the current event stream to asynchronously kick off a resumed stream consumption, potentially using the stored lastId().

Method Details

lastId

public Optional<String> lastId()

Description copied from interface: McpTransportStream

The last observed event identifier.

Specified by:

lastId in interface McpTransportStream<CONNECTION>

Returns:

if not empty, contains the most recent event that was consumed

streamId

public long streamId()

Description copied from interface: McpTransportStream

An internal stream identifier used to distinguish streams while debugging.

Specified by:

streamId in interface McpTransportStream<CONNECTION>

Returns:

a long stream identifier value

consumeSseStream

public org.reactivestreams.Publisher<McpSchema.JSONRPCMessage> consumeSseStream(org.reactivestreams.Publisher<reactor.util.function.Tuple2<Optional<String>,Iterable<McpSchema.JSONRPCMessage>>> eventStream)

Description copied from interface: McpTransportStream

Allows keeping track of the transport stream of events (currently an SSE stream from Streamable HTTP specification) and enable resumability and reconnects in case of stream errors.

Specified by:

consumeSseStream in interface McpTransportStream<CONNECTION>

Parameters:

eventStream - a Publisher of tuples (pairs) of an optional identifier associated with a collection of messages

Returns:

a flattened Publisher of JSON-RPC messages with the identifier stripped away