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. and base JDK8 serialization/deserialization of messages.

另请参阅:

MCP HTTP with SSE Transport Specification

嵌套类概要

嵌套类

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

字段概要

字段

限定符和类型	字段和说明
protected com.fasterxml.jackson.databind.ObjectMapper	objectMapper JSON object mapper for message serialization/deserialization

构造器概要

构造器

构造器和说明
WebRxSseClientTransport(org.noear.solon.net.http.HttpUtilsBuilder webBuilder) Creates a new transport instance with default HTTP client and object mapper.
WebRxSseClientTransport(org.noear.solon.net.http.HttpUtilsBuilder webBuilder, com.fasterxml.jackson.databind.ObjectMapper objectMapper) Creates a new transport instance with custom HTTP client builder and object mapper.
WebRxSseClientTransport(org.noear.solon.net.http.HttpUtilsBuilder webBuilder, java.lang.String sseEndpoint, com.fasterxml.jackson.databind.ObjectMapper objectMapper) Creates a new transport instance with custom HTTP client builder and object mapper.

方法概要

限定符和类型	方法和说明
static WebRxSseClientTransport.Builder	builder(org.noear.solon.net.http.HttpUtilsBuilder webBuilder) Creates a new builder for WebRxSseClientTransport.
reactor.core.publisher.Mono<java.lang.Void>	closeGracefully() Gracefully closes the transport connection.
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 the SSE connection with the server and sets up message handling.
reactor.core.publisher.Mono<java.lang.Void>	sendMessage(McpSchema.JSONRPCMessage message) Sends a JSON-RPC message to the server.
<T> T	unmarshalFrom(java.lang.Object data, com.fasterxml.jackson.core.type.TypeReference<T> typeRef) Unmarshals data to the specified type using the configured object mapper.

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

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

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

close

字段详细资料

objectMapper

protected com.fasterxml.jackson.databind.ObjectMapper objectMapper

JSON object mapper for message serialization/deserialization

构造器详细资料

WebRxSseClientTransport

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

Creates a new transport instance with default HTTP client and object mapper.

参数:

webBuilder - the HttpUtilsBuilder to use for creating the HttpUtils instance

WebRxSseClientTransport

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

Creates a new transport instance with custom HTTP client builder and object mapper.

参数:

webBuilder - the HttpUtilsBuilder to use for creating the HttpUtils instance

objectMapper - the object mapper for JSON serialization/deserialization

抛出:

java.lang.IllegalArgumentException - if objectMapper or clientBuilder is null

WebRxSseClientTransport

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

Creates a new transport instance with custom HTTP client builder and object mapper.

参数:

webBuilder - the HttpUtilsBuilder to use for creating the HttpUtils instance

sseEndpoint - the SSE endpoint path

objectMapper - the object mapper for JSON serialization/deserialization

抛出:

java.lang.IllegalArgumentException - if objectMapper or clientBuilder is null

方法详细资料

builder

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

Creates a new builder for WebRxSseClientTransport.

参数:

webBuilder - the HttpUtilsBuilder to use for creating the HttpUtils instance

返回:

a new builder instance

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 the SSE connection with the server and sets up message handling.

This method:

• Initiates the SSE connection
• Handles endpoint discovery events
• Processes incoming JSON-RPC messages

指定者:

connect 在接口中 McpClientTransport

参数:

handler - the function to process received JSON-RPC messages

返回:

a Mono that completes when the connection is established

sendMessage

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

Sends a JSON-RPC message to the server.

This method waits for the message endpoint to be discovered before sending the message. The message is serialized to JSON and sent as an HTTP POST request.

指定者:

sendMessage 在接口中 McpTransport

参数:

message - the JSON-RPC message to send

返回:

a Mono that completes when the message is sent

抛出:

McpError - if the message endpoint is not available or the wait times out

closeGracefully

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

Gracefully closes the transport connection.

Sets the closing flag and cancels any pending connection future. This prevents new messages from being sent and allows ongoing operations to complete.

指定者:

closeGracefully 在接口中 McpTransport

返回:

a Mono that completes when the closing process is initiated

unmarshalFrom

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

Unmarshals data to the specified type using the configured object mapper.

指定者:

unmarshalFrom 在接口中 McpTransport

类型参数:

T - the target type

参数:

data - the data to unmarshal

typeRef - the type reference for the target type

返回:

the unmarshalled object