io.modelcontextprotocol.spec

接口 McpSession

所有已知实现类:

McpClientSession, McpServerSession, StatelessMcpSession

public interface McpSession

Represents a Model Control Protocol (MCP) session that handles communication between clients and the server. This interface provides methods for sending requests and notifications, as well as managing the session lifecycle.

The session operates asynchronously using Project Reactor's Mono type for non-blocking operations. It supports both request-response patterns and one-way notifications.

方法概要

限定符和类型	方法和说明
void	close() Closes the session and releases any associated resources.
reactor.core.publisher.Mono<java.lang.Void>	closeGracefully() Closes the session and releases any associated resources asynchronously.
java.lang.String	getId() Retrieve the session id.
reactor.core.publisher.Mono<java.lang.Void>	handle(McpSchema.JSONRPCMessage message) Called by the McpServerTransportProvider once the session is determined.
default reactor.core.publisher.Mono<java.lang.Void>	sendNotification(java.lang.String method) Sends a notification to the model client or server without parameters.
reactor.core.publisher.Mono<java.lang.Void>	sendNotification(java.lang.String method, java.util.Map<java.lang.String,java.lang.Object> params) Sends a notification to the model client or server with parameters.
<T> reactor.core.publisher.Mono<T>	sendRequest(java.lang.String method, java.lang.Object requestParams, com.fasterxml.jackson.core.type.TypeReference<T> typeRef) Sends a request to the model counterparty and expects a response of type T.

方法详细资料

getId

java.lang.String getId()

Retrieve the session id.

返回:

session id

handle

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

Called by the McpServerTransportProvider once the session is determined. The purpose of this method is to dispatch the message to an appropriate handler as specified by the MCP server implementation (McpAsyncServer or McpSyncServer) via McpServerSession.Factory that the server creates.

参数:

message - the incoming JSON-RPC message

返回:

a Mono that completes when the message is processed

sendRequest

<T> reactor.core.publisher.Mono<T> sendRequest(java.lang.String method,
                                               java.lang.Object requestParams,
                                               com.fasterxml.jackson.core.type.TypeReference<T> typeRef)

Sends a request to the model counterparty and expects a response of type T.

This method handles the request-response pattern where a response is expected from the client or server. The response type is determined by the provided TypeReference.

类型参数:

T - the type of the expected response

参数:

method - the name of the method to be called on the counterparty

requestParams - the parameters to be sent with the request

typeRef - the TypeReference describing the expected response type

返回:

a Mono that will emit the response when received

sendNotification

default reactor.core.publisher.Mono<java.lang.Void> sendNotification(java.lang.String method)

Sends a notification to the model client or server without parameters.

This method implements the notification pattern where no response is expected from the counterparty. It's useful for fire-and-forget scenarios.

参数:

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

返回:

a Mono that completes when the notification has been sent

sendNotification

reactor.core.publisher.Mono<java.lang.Void> sendNotification(java.lang.String method,
                                                             java.util.Map<java.lang.String,java.lang.Object> params)

Sends a notification to the model client or server with parameters.

Similar to sendNotification(String) but allows sending additional parameters with the notification.

参数:

method - the name of the notification method to be sent to the counterparty

params - a map of parameters to be sent with the notification

返回:

a Mono that completes when the notification has been sent

closeGracefully

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

Closes the session and releases any associated resources asynchronously.

返回:

a Mono that completes when the session has been closed.

close

void close()

Closes the session and releases any associated resources.