MCP Java SDK 使用说明

项目简介

MCP Java SDK 是一个为 Java 应用程序提供 Model Context Protocol (MCP) 集成支持的开发工具包。它旨在帮助 Java 开发者轻松构建符合 MCP 协议的应用，包括 MCP 客户端和服务器端。该 SDK 提供了核心库和示例代码，支持同步和异步通信模式，并集成了 Spring Boot，方便快速开发和部署。

主要功能点

资源 (Resources) 管理: 支持 MCP 服务器托管和管理各种类型的数据资源，例如文本、图片等，并提供标准化的数据访问接口。
工具 (Tools) 注册与执行: 允许 MCP 服务器注册和执行外部工具，例如计算器、搜索引擎等，使 LLM 客户端可以通过 MCP 协议调用这些工具。
Prompt 模板 (Prompts) 定义: 支持在 MCP 服务器端定义和管理 Prompt 模板，为 LLM 客户端提供可定制的交互模式。
JSON-RPC 通信: 基于 JSON-RPC 协议实现客户端与服务器端的标准化通信。
多传输协议支持: 支持 Stdio、SSE、WebSocket 等多种传输协议，灵活适应不同的应用场景。
Spring Boot 集成: 提供 Spring Boot Starter，简化 MCP 应用的集成和部署，支持快速构建 MCP 客户端和服务器。

安装步骤

环境准备: 确保已安装 JDK 17+，并配置 Maven 环境。
下载仓库: 从 GitHub 仓库 java-sdk 克隆或下载源代码。
编译项目: 在仓库根目录下，使用 Maven 命令 './mvnw clean install -DskipTests' 编译项目。
构建 Spring AI MCP (可选): 如果需要使用 Spring Boot 集成，可以利用 Spring Initializer 初始化 Spring Boot 项目，并引入 Spring AI MCP 依赖。

服务器配置

MCP 服务器需要配置启动命令及其参数才能运行。以下是一个基于 'java-sdk' 仓库信息生成的 JSON 格式 配置示例，用于 MCP 客户端连接 MCP 服务器。请注意，MCP 客户端无需配置任何代码，只需提供以下 JSON 配置信息即可：

{
  "serverName": "mcp-java-server",  // MCP 服务器名称，可自定义
  "command": "java",               // 启动 MCP 服务器的命令，通常为 java
  "args": [                        // 启动参数列表
    "-jar",                       // 指定以 jar 包方式运行
    "path/to/your-mcp-server.jar" //  **[请替换为实际的 MCP 服务器 jar 包路径]**，例如：target/mcp-server-boot-starter.jar (如果使用 Spring Boot Starter 构建)
  ],
  "description": "MCP 服务器示例配置" //  配置描述信息，可自定义
}

请务必将 'path/to/your-mcp-server.jar' 替换为您实际构建的 MCP 服务器 jar 文件路径。 如果您使用 Spring AI MCP 构建服务器，jar 包通常位于 'target' 目录下，例如 'mcp-server-boot-starter.jar'。

基本使用方法

启动 MCP 服务器: 根据上述配置，在命令行或终端中执行 MCP 服务器的启动命令。
构建 MCP 客户端: 使用 MCP Java SDK 构建 MCP 客户端应用，或使用 Spring AI MCP Client Starter 快速搭建客户端。
客户端连接服务器: 在 MCP 客户端中配置 MCP 服务器的启动命令和参数，建立客户端与服务器的连接。
客户端调用 MCP 功能: 通过 MCP 客户端 SDK 提供的 API，例如 'listTools', 'callTool', 'listResources', 'readResource', 'getPrompt' 等，调用 MCP 服务器提供的资源、工具和 Prompt 模板。
监控与日志: 通过 MCP 客户端和服务器的日志输出，监控应用运行状态和调试问题。

详细的使用方法和 API 文档，请参考 MCP Java SDK 参考文档和 Spring AI MCP 文档。

关键词