io.modelcontextprotocol.server

Class McpAsyncServerExchange

java.lang.Object

io.modelcontextprotocol.server.McpAsyncServerExchange

public class McpAsyncServerExchange
extends Object

Represents an asynchronous exchange with a Model Context Protocol (MCP) client. The exchange provides methods to interact with the client and query its capabilities.

Author:

Dariusz Jędrzejczyk, Christian Tzolov

Field Summary

Fields

Modifier and Type	Field and Description
static com.fasterxml.jackson.core.type.TypeReference<Object>	OBJECT_TYPE_REF

Constructor Summary

Constructors

Constructor and Description
McpAsyncServerExchange(McpSession session, McpSchema.ClientCapabilities clientCapabilities, McpSchema.Implementation clientInfo) Deprecated. Use McpAsyncServerExchange(String, McpLoggableSession, McpSchema.ClientCapabilities, McpSchema.Implementation, McpTransportContext)
McpAsyncServerExchange(String sessionId, McpLoggableSession session, McpSchema.ClientCapabilities clientCapabilities, McpSchema.Implementation clientInfo, McpTransportContext transportContext) Create a new asynchronous exchange with the client.

Method Summary

Modifier and Type	Method and Description
reactor.core.publisher.Mono<McpSchema.ElicitResult>	createElicitation(McpSchema.ElicitRequest elicitRequest) Creates a new elicitation.
reactor.core.publisher.Mono<McpSchema.CreateMessageResult>	createMessage(McpSchema.CreateMessageRequest createMessageRequest) Create a new message using the sampling capabilities of the client.
McpSchema.ClientCapabilities	getClientCapabilities() Get the client capabilities that define the supported features and functionality.
McpSchema.Implementation	getClientInfo() Get the client implementation information.
reactor.core.publisher.Mono<McpSchema.ListRootsResult>	listRoots() Retrieves the list of all roots provided by the client.
reactor.core.publisher.Mono<McpSchema.ListRootsResult>	listRoots(String cursor) Retrieves a paginated list of roots provided by the client.
reactor.core.publisher.Mono<Void>	loggingNotification(McpSchema.LoggingMessageNotification loggingMessageNotification) Send a logging message notification to the client.
reactor.core.publisher.Mono<Object>	ping() Sends a ping request to the client.
reactor.core.publisher.Mono<Void>	progressNotification(McpSchema.ProgressNotification progressNotification) Sends a notification to the client that the current progress status has changed for long-running operations.
String	sessionId() Provides the Session ID.
McpTransportContext	transportContext() Provides the McpTransportContext associated with the transport layer.

Methods inherited from class java.lang.Object

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

Field Detail

OBJECT_TYPE_REF

public static final com.fasterxml.jackson.core.type.TypeReference<Object> OBJECT_TYPE_REF

Constructor Detail

McpAsyncServerExchange

@Deprecated
public McpAsyncServerExchange(McpSession session,
                                          McpSchema.ClientCapabilities clientCapabilities,
                                          McpSchema.Implementation clientInfo)

Deprecated. Use McpAsyncServerExchange(String, McpLoggableSession, McpSchema.ClientCapabilities, McpSchema.Implementation, McpTransportContext)

Create a new asynchronous exchange with the client.

Parameters:

session - The server session representing a 1-1 interaction.

clientCapabilities - The client capabilities that define the supported features and functionality.

clientInfo - The client implementation information.

McpAsyncServerExchange

public McpAsyncServerExchange(String sessionId,
                              McpLoggableSession session,
                              McpSchema.ClientCapabilities clientCapabilities,
                              McpSchema.Implementation clientInfo,
                              McpTransportContext transportContext)

Create a new asynchronous exchange with the client.

Parameters:

session - The server session representing a 1-1 interaction.

clientCapabilities - The client capabilities that define the supported features and functionality.

clientInfo - The client implementation information.

transportContext - context associated with the client as extracted from the transport

Method Detail

getClientCapabilities

public McpSchema.ClientCapabilities getClientCapabilities()

Get the client capabilities that define the supported features and functionality.

Returns:

The client capabilities

getClientInfo

public McpSchema.Implementation getClientInfo()

Get the client implementation information.

Returns:

The client implementation details

transportContext

public McpTransportContext transportContext()

Provides the McpTransportContext associated with the transport layer. For HTTP transports it can contain the metadata associated with the HTTP request that triggered the processing.

Returns:

the transport context object

sessionId

public String sessionId()

Provides the Session ID.

Returns:

session ID string

createMessage

public reactor.core.publisher.Mono<McpSchema.CreateMessageResult> createMessage(McpSchema.CreateMessageRequest createMessageRequest)

Create a new message using the sampling capabilities of the client. The Model Context Protocol (MCP) provides a standardized way for servers to request LLM sampling (“completions” or “generations”) from language models via clients. This flow allows clients to maintain control over model access, selection, and permissions while enabling servers to leverage AI capabilities—with no server API keys necessary. Servers can request text or image-based interactions and optionally include context from MCP servers in their prompts.

Parameters:

createMessageRequest - The request to create a new message

Returns:

A Mono that completes when the message has been created

See Also:

McpSchema.CreateMessageRequest, McpSchema.CreateMessageResult, Sampling Specification

createElicitation

public reactor.core.publisher.Mono<McpSchema.ElicitResult> createElicitation(McpSchema.ElicitRequest elicitRequest)

Creates a new elicitation. MCP provides a standardized way for servers to request additional information from users through the client during interactions. This flow allows clients to maintain control over user interactions and data sharing while enabling servers to gather necessary information dynamically. Servers can request structured data from users with optional JSON schemas to validate responses.

Parameters:

elicitRequest - The request to create a new elicitation

Returns:

A Mono that completes when the elicitation has been resolved.

See Also:

McpSchema.ElicitRequest, McpSchema.ElicitResult, Elicitation Specification

listRoots

public reactor.core.publisher.Mono<McpSchema.ListRootsResult> listRoots()

Retrieves the list of all roots provided by the client.

Returns:

A Mono that emits the list of roots result.

listRoots

public reactor.core.publisher.Mono<McpSchema.ListRootsResult> listRoots(String cursor)

Retrieves a paginated list of roots provided by the client.

Parameters:

cursor - Optional pagination cursor from a previous list request

Returns:

A Mono that emits the list of roots result containing

loggingNotification

public reactor.core.publisher.Mono<Void> loggingNotification(McpSchema.LoggingMessageNotification loggingMessageNotification)

Send a logging message notification to the client. Messages below the current minimum logging level will be filtered out.

Parameters:

loggingMessageNotification - The logging message to send

Returns:

A Mono that completes when the notification has been sent

progressNotification

public reactor.core.publisher.Mono<Void> progressNotification(McpSchema.ProgressNotification progressNotification)

Sends a notification to the client that the current progress status has changed for long-running operations.

Parameters:

progressNotification - The progress notification to send

Returns:

A Mono that completes when the notification has been sent

ping

public reactor.core.publisher.Mono<Object> ping()

Sends a ping request to the client.

Returns:

A Mono that completes with clients's ping response