io.modelcontextprotocol.client.transport

类 StdioClientTransport

java.lang.Object

io.modelcontextprotocol.client.transport.StdioClientTransport

所有已实现的接口:

McpClientTransport, McpTransport

public class StdioClientTransport
extends java.lang.Object
implements McpClientTransport

Implementation of the MCP Stdio transport that communicates with a server process using standard input/output streams. Messages are exchanged as newline-delimited JSON-RPC messages over stdin/stdout, with errors and debug information sent to stderr.

构造器概要

构造器

构造器和说明
StdioClientTransport(ServerParameters params) Creates a new StdioClientTransport with the specified parameters and default ObjectMapper.
StdioClientTransport(ServerParameters params, com.fasterxml.jackson.databind.ObjectMapper objectMapper) Creates a new StdioClientTransport with the specified parameters and ObjectMapper.

方法概要

限定符和类型	方法和说明
void	awaitForExit() Waits for the server process to exit.
reactor.core.publisher.Mono<java.lang.Void>	closeGracefully() Gracefully closes the transport by destroying the process and disposing of the schedulers.
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) Starts the server process and initializes the message processing streams.
reactor.core.publisher.Sinks.Many<java.lang.String>	getErrorSink()
protected java.lang.ProcessBuilder	getProcessBuilder() Creates and returns a new ProcessBuilder instance.
protected void	handleOutbound(java.util.function.Function<reactor.core.publisher.Flux<McpSchema.JSONRPCMessage>,reactor.core.publisher.Flux<McpSchema.JSONRPCMessage>> outboundConsumer)
reactor.core.publisher.Mono<java.lang.Void>	sendMessage(McpSchema.JSONRPCMessage message) Sends a message to the peer asynchronously.
void	setStdErrorHandler(java.util.function.Consumer<java.lang.String> errorHandler) Sets the handler for processing transport-level errors.
<T> T	unmarshalFrom(java.lang.Object data, com.fasterxml.jackson.core.type.TypeReference<T> typeRef) Unmarshals the given data into an object of the specified type.

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

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

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

setExceptionHandler

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

close, protocolVersions

构造器详细资料

StdioClientTransport

public StdioClientTransport(ServerParameters params)

Creates a new StdioClientTransport with the specified parameters and default ObjectMapper.

参数:

params - The parameters for configuring the server process

StdioClientTransport

public StdioClientTransport(ServerParameters params,
                            com.fasterxml.jackson.databind.ObjectMapper objectMapper)

Creates a new StdioClientTransport with the specified parameters and ObjectMapper.

参数:

params - The parameters for configuring the server process

objectMapper - The ObjectMapper to use for JSON serialization/deserialization

方法详细资料

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)

Starts the server process and initializes the message processing streams. This method sets up the process with the configured command, arguments, and environment, then starts the inbound, outbound, and error processing threads.

指定者:

connect 在接口中 McpClientTransport

参数:

handler - a transformer for incoming messages

返回:

a Mono that terminates upon successful client setup. It can mean establishing a connection (which can be later disposed) but it doesn't have to, depending on the transport type. The successful termination of the returned Mono simply means the client can now be used. An error can be retried according to the application requirements.

抛出:

java.lang.RuntimeException - if the process fails to start or if the process streams are null

getProcessBuilder

protected java.lang.ProcessBuilder getProcessBuilder()

Creates and returns a new ProcessBuilder instance. Protected to allow overriding in tests.

返回:

A new ProcessBuilder instance

setStdErrorHandler

public void setStdErrorHandler(java.util.function.Consumer<java.lang.String> errorHandler)

Sets the handler for processing transport-level errors.

The provided handler will be called when errors occur during transport operations, such as connection failures or protocol violations.

参数:

errorHandler - a consumer that processes error messages

awaitForExit

public void awaitForExit()

Waits for the server process to exit.

抛出:

java.lang.RuntimeException - if the process is interrupted while waiting

sendMessage

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

从接口复制的说明: McpTransport

Sends a message to the peer asynchronously.

This method handles the transmission of messages to the server in an asynchronous manner. Messages are sent in JSON-RPC format as specified by the MCP protocol.

指定者:

sendMessage 在接口中 McpTransport

参数:

message - the McpSchema.JSONRPCMessage to be sent to the server

返回:

a Mono that completes when the message has been sent

handleOutbound

protected void handleOutbound(java.util.function.Function<reactor.core.publisher.Flux<McpSchema.JSONRPCMessage>,reactor.core.publisher.Flux<McpSchema.JSONRPCMessage>> outboundConsumer)

closeGracefully

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

Gracefully closes the transport by destroying the process and disposing of the schedulers. This method sends a TERM signal to the process and waits for it to exit before cleaning up resources.

指定者:

closeGracefully 在接口中 McpTransport

返回:

A Mono that completes when the transport is closed

getErrorSink

public reactor.core.publisher.Sinks.Many<java.lang.String> getErrorSink()

unmarshalFrom

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

从接口复制的说明: McpTransport

Unmarshals the given data into an object of the specified type.

指定者:

unmarshalFrom 在接口中 McpTransport

类型参数:

T - the type of the object to unmarshal

参数:

data - the data to unmarshal

typeRef - the type reference for the object to unmarshal

返回:

the unmarshalled object