MCP 客户端 SDK

MCP 服务端 SDK

其他

MCP 客户端 SDK 设置

安装依赖

我们需要使用 AJ MCP SDK 来进行 API 请求。安装依赖如下:


<dependency>
    <groupId>com.ajaxjs</groupId>
    <artifactId>aj-mcp-client</artifactId>
    <version>1.2</version>
</dependency>

您可以通过以下链接找到最新版本: Maven Central

客户端 SDK 的实现由两个主要组件组成:

设置传输层 Transport

首先,我们需要创建传输层。根据 MCP 服务器的类型,您可以选择以下两种传输方式之一:

标准输入输出(Stdio)传输

“Stdio” 是标准输入/输出的缩写,通常用于在程序和人之间通过命令行交互。在这里,它用于 MCP 客户端和 MCP 服务器之间的交互。通常,Stdio 用于本地应用程序,如 *.exe 程序或 Java Jar 程序等。

// MCP 服务器是一个 Java 程序,使用标准输入输出运行。
McpTransport transport=StdioTransport.builder()
        .command(Arrays.asList("java","-jar","C:\\app\\my-app-jar-with-dependencies.jar"))
        .logEvents(true)
        .build();

以下是一个 .exe 程序的示例:

// MCP 服务器是一个可执行程序,使用标准输入输出运行。
McpTransport transport=StdioTransport.builder()
        .command("C:\\app\\my-app.exe","-token","dd4df2sx32ds"))
        .logEvents(true)
        .build();

如果您希望查看客户端的完整日志,可以将 logEvents 设置为 true。这种方法有助于调试或更深入地理解 MCP 协议的基于 JSON 的消息格式。

SSE 传输

SSE(Server-Sent Events)传输使用 HTTP 协议实现 MCP 客户端与服务器之间的双向通信。这种传输方法特别适用于基于 Web 的应用程序。

McpTransport transport=HttpMcpTransport.builder()
        .sseUrl("http://localhost:8080/sse")
        .logRequests(true)
        .logResponses(true)
        .build();

SseUrl 是必需的,它指定了 MCP 服务器监听传入连接的 SSE 端点 URL。

MCP 客户端

MCP 客户端充当本地应用程序与远程工具实现之间的桥梁。

McpClient mcpClient=McpClient.builder()
        .clientName("my-host")
        .clientVersion("1.2")
        .transport(transport)
        .build();

通常我们会填写 clientNameclientVersion 属性:

所有属性如下所示:

属性 说明 值类型 示例值
clientName 设置客户端在初始化消息中向 MCP 服务器标识自己的名称。 String myapp/foo-app
clientVersion 设置客户端在初始化消息中向 MCP 服务器标识自己的版本字符串。默认值为 "1.0"。 String 1.0/2.1.2
protocolVersion 设置客户端在初始化消息中声明的协议版本。当前默认值为 "2024-11-05",但在后续版本中可能会有所更改。 String 2024-11-05
requestTimeout 设置工具执行的超时时间。此值适用于每个工具执行。默认值为 60 秒,值为 0 表示没有超时。 Duration Duration.ofSeconds(60)

请注意,在创建 McpClient 后,应立即调用 mcpClient.initialize();。关于初始化工作将在下一小节介绍。

McpClient mcpClient=McpClient.builder()
        .clientName("my-host")
        .clientVersion("1.2")
        .transport(sseTransport)
        .build();

        mcpClient.initialize();

最后,请记得在不再需要 MCP 客户端时,通过调用 close() 方法或使用自动关闭资源的方式来释放客户端资源。

try(IMcpClient mcpClient2=McpClient.builder().transport(transport).build()) {
     ...
}catch(Exception e){
     throw new RuntimeException(e);
}

MCP 客户端遵循分层架构,接口定义与实现之间有清晰的分离。客户端依赖传输层与服务器进行实际通信,并抽象通信细节以支持不同的传输机制。