io.modelcontextprotocol.client.transport

类 WebRxSseClientTransport

java.lang.Object

io.modelcontextprotocol.client.transport.WebRxSseClientTransport

所有已实现的接口:

McpClientTransport, McpTransport

public class WebRxSseClientTransport
extends java.lang.Object
implements McpClientTransport

Server-Sent Events (SSE) implementation of the McpTransport that follows the MCP HTTP with SSE transport specification.

This transport establishes a bidirectional communication channel where:

• Inbound messages are received through an SSE connection from the server
• Outbound messages are sent via HTTP POST requests to a server-provided endpoint

The message flow follows these steps:

1. The client establishes an SSE connection to the server's /sse endpoint
2. The server sends an 'endpoint' event containing the URI for sending messages

This implementation uses HttpUtilsBuilder for HTTP communications and supports JSON serialization/deserialization of messages.

另请参阅:

MCP HTTP with SSE Transport Specification

嵌套类概要

嵌套类

限定符和类型	类和说明
static class	WebRxSseClientTransport.Builder Builder for WebRxSseClientTransport.

字段概要

字段

限定符和类型	字段和说明
protected reactor.core.publisher.Sinks.One<java.lang.String>	messageEndpointSink Sink for managing the message endpoint URI provided by the server.
protected com.fasterxml.jackson.databind.ObjectMapper	objectMapper ObjectMapper for serializing outbound messages and deserializing inbound messages.

构造器概要

构造器

构造器和说明
WebRxSseClientTransport(org.noear.solon.net.http.HttpUtilsBuilder webClientBuilder) Constructs a new SseClientTransport with the specified WebClient builder.
WebRxSseClientTransport(org.noear.solon.net.http.HttpUtilsBuilder webClientBuilder, com.fasterxml.jackson.databind.ObjectMapper objectMapper) Constructs a new SseClientTransport with the specified WebClient builder and ObjectMapper.
WebRxSseClientTransport(org.noear.solon.net.http.HttpUtilsBuilder webClientBuilder, com.fasterxml.jackson.databind.ObjectMapper objectMapper, java.lang.String sseEndpoint) Constructs a new SseClientTransport with the specified WebClient builder and ObjectMapper.

方法概要

限定符和类型	方法和说明
static WebRxSseClientTransport.Builder	builder(org.noear.solon.net.http.HttpUtilsBuilder webClientBuilder) Creates a new builder for WebRxSseClientTransport.
reactor.core.publisher.Mono<java.lang.Void>	closeGracefully() Implements graceful shutdown of the transport.
reactor.core.publisher.Mono<java.lang.Void>	connect(java.util.function.Function<reactor.core.publisher.Mono<McpSchema.JSONRPCMessage>,reactor.core.publisher.Mono<McpSchema.JSONRPCMessage>> handler) Establishes a connection to the MCP server using Server-Sent Events (SSE).
protected reactor.core.publisher.Flux<org.noear.solon.net.http.textstream.ServerSentEvent>	eventStream() Initializes and starts the inbound SSE event processing.
java.util.List<java.lang.String>	protocolVersions()
reactor.core.publisher.Mono<java.lang.Void>	sendMessage(McpSchema.JSONRPCMessage message) Sends a JSON-RPC message to the server using the endpoint provided during connection.
<T> T	unmarshalFrom(java.lang.Object data, com.fasterxml.jackson.core.type.TypeReference<T> typeRef) Unmarshalls data from a generic Object into the specified type using the configured ObjectMapper.

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

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

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

setExceptionHandler

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

close

字段详细资料

objectMapper

protected com.fasterxml.jackson.databind.ObjectMapper objectMapper

ObjectMapper for serializing outbound messages and deserializing inbound messages. Handles conversion between JSON-RPC messages and their string representation.

messageEndpointSink

protected final reactor.core.publisher.Sinks.One<java.lang.String> messageEndpointSink

Sink for managing the message endpoint URI provided by the server. Stores the most recent endpoint URI and makes it available for outbound message processing.

构造器详细资料

WebRxSseClientTransport

public WebRxSseClientTransport(org.noear.solon.net.http.HttpUtilsBuilder webClientBuilder)

Constructs a new SseClientTransport with the specified WebClient builder. Uses a default ObjectMapper instance for JSON processing.

参数:

webClientBuilder - the WebClient.Builder to use for creating the WebClient instance

抛出:

java.lang.IllegalArgumentException - if webClientBuilder is null

WebRxSseClientTransport

public WebRxSseClientTransport(org.noear.solon.net.http.HttpUtilsBuilder webClientBuilder,
                               com.fasterxml.jackson.databind.ObjectMapper objectMapper)

Constructs a new SseClientTransport with the specified WebClient builder and ObjectMapper. Initializes both inbound and outbound message processing pipelines.

参数:

webClientBuilder - the WebClient.Builder to use for creating the WebClient instance

objectMapper - the ObjectMapper to use for JSON processing

抛出:

java.lang.IllegalArgumentException - if either parameter is null

WebRxSseClientTransport

public WebRxSseClientTransport(org.noear.solon.net.http.HttpUtilsBuilder webClientBuilder,
                               com.fasterxml.jackson.databind.ObjectMapper objectMapper,
                               java.lang.String sseEndpoint)

Constructs a new SseClientTransport with the specified WebClient builder and ObjectMapper. Initializes both inbound and outbound message processing pipelines.

参数:

webClientBuilder - the WebClient.Builder to use for creating the WebClient instance

objectMapper - the ObjectMapper to use for JSON processing

sseEndpoint - the SSE endpoint URI to use for establishing the connection

抛出:

java.lang.IllegalArgumentException - if either parameter is null

方法详细资料

protocolVersions

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

指定者:

protocolVersions 在接口中 McpTransport

connect

public reactor.core.publisher.Mono<java.lang.Void> connect(java.util.function.Function<reactor.core.publisher.Mono<McpSchema.JSONRPCMessage>,reactor.core.publisher.Mono<McpSchema.JSONRPCMessage>> handler)

Establishes a connection to the MCP server using Server-Sent Events (SSE). This method initiates the SSE connection and sets up the message processing pipeline.

The connection process follows these steps:

1. Establishes an SSE connection to the server's /sse endpoint
2. Waits for the server to send an 'endpoint' event with the message posting URI
3. Sets up message handling for incoming JSON-RPC messages

The connection is considered established only after receiving the endpoint event from the server.

指定者:

connect 在接口中 McpClientTransport

参数:

handler - a function that processes incoming JSON-RPC messages and returns responses

返回:

a Mono that completes when the connection is fully established

抛出:

McpError - if there's an error processing SSE events or if an unrecognized event type is received

sendMessage

public reactor.core.publisher.Mono<java.lang.Void> sendMessage(McpSchema.JSONRPCMessage message)

Sends a JSON-RPC message to the server using the endpoint provided during connection.

Messages are sent via HTTP POST requests to the server-provided endpoint URI. The message is serialized to JSON before transmission. If the transport is in the process of closing, the message send operation is skipped gracefully.

指定者:

sendMessage 在接口中 McpTransport

参数:

message - the JSON-RPC message to send

返回:

a Mono that completes when the message has been sent successfully

抛出:

java.lang.RuntimeException - if message serialization fails

eventStream

protected reactor.core.publisher.Flux<org.noear.solon.net.http.textstream.ServerSentEvent> eventStream()

Initializes and starts the inbound SSE event processing. Establishes the SSE connection and sets up event handling for both message and endpoint events. Includes automatic retry logic for handling transient connection failures.

closeGracefully

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

Implements graceful shutdown of the transport. Cleans up all resources including subscriptions and schedulers. Ensures orderly shutdown of both inbound and outbound message processing.

指定者:

closeGracefully 在接口中 McpTransport

返回:

a Mono that completes when shutdown is finished

unmarshalFrom

public <T> T unmarshalFrom(java.lang.Object data,
                           com.fasterxml.jackson.core.type.TypeReference<T> typeRef)

Unmarshalls data from a generic Object into the specified type using the configured ObjectMapper.

This method is particularly useful when working with JSON-RPC parameters or result objects that need to be converted to specific Java types. It leverages Jackson's type conversion capabilities to handle complex object structures.

指定者:

unmarshalFrom 在接口中 McpTransport

类型参数:

T - the target type to convert the data into

参数:

data - the source object to convert

typeRef - the TypeReference describing the target type

返回:

the unmarshalled object of type T

抛出:

java.lang.IllegalArgumentException - if the conversion cannot be performed

builder

public static WebRxSseClientTransport.Builder builder(org.noear.solon.net.http.HttpUtilsBuilder webClientBuilder)

Creates a new builder for WebRxSseClientTransport.

参数:

webClientBuilder - the WebClient.Builder to use for creating the WebClient instance

返回:

a new builder instance