关键词

API桥接REST转MCPSpring BootAI助手自动化API

使用说明

项目简介

Spring MCP Bridge 是一个工具，旨在简化现有 Spring Boot RESTful API 与 AI 助手的集成过程。它通过自动扫描 Spring Boot 项目，将 RESTful 接口转换为符合 Model Context Protocol (MCP) 协议的服务器，从而使得像 Claude、Cursor 等 MCP 客户端可以直接调用和利用您的后端 API 功能。

主要功能点

  • 自动扫描: 自动发现 Spring Boot 项目中的 RESTful 接口 (如 '@RestController', '@GetMapping' 等)。
  • 零配置: 无需修改现有的 Spring Boot 代码。
  • 模型保留: 将 Spring Boot 的请求和响应模型转换为 MCP 工具可理解的格式。
  • 文档提取: 利用 Javadoc 注释增强 MCP 工具的描述信息。
  • 完整文档: 自动生成 README 文档和清晰的使用说明。

安装步骤

  1. 克隆仓库

    git clone https://github.com/brunosantoslab/spring-mcp-bridge.git
cd spring-mcp-bridge

  2. 扫描 Spring Boot 项目并生成 MCP 服务器 将 '/path/to/spring-project' 替换为您的 Spring Boot 项目的实际路径，'MyAPI' 替换为您希望的 API 名称。

    python spring_boot_mcp_converter.py --project /path/to/spring-project --output ./mcp_server --name MyAPI

  3. 进入生成的 MCP 服务器目录

    cd mcp_server

  4. 安装 Python 依赖

    pip install -r requirements.txt

服务器配置

MCP 客户端需要配置以下信息以连接到 MCP 服务器。请将以下 JSON 配置添加到您的 MCP 客户端配置中。

{
  "serverName": "MyAPI_MCP_Server",
  "command": "python",
  "args": ["main.py"],
  "cwd": "/path/to/mcp_server"  // 将此路径替换为您的 mcp_server 目录的绝对路径
}

参数注释:

  • 'serverName': MCP 服务器的名称，您可以自定义。
  • 'command': 运行 MCP 服务器的命令，这里是 'python'。
  • 'args': 传递给 'command' 的参数，'["main.py"]' 表示执行 'main.py' 文件。
  • 'cwd': 重要: MCP 服务器的工作目录，需要设置为您生成的 'mcp_server' 目录的绝对路径。您需要将 '/path/to/mcp_server' 替换为实际的绝对路径。例如，如果您的 'mcp_server' 目录在 '/home/user/projects/mcp_server'，则应设置为 '/home/user/projects/mcp_server'。

基本使用方法

  1. 启动 Spring Boot 应用 确保您的 Spring Boot 应用程序正在运行。

  2. 启动 MCP 服务器 在 'mcp_server' 目录下执行以下命令启动 MCP 服务器：

    python main.py

  3. 配置 MCP 客户端 在您的 MCP 客户端 (如 Claude, Cursor) 中，按照客户端的指引，配置上述 JSON 信息以连接到 MCP 服务器。

  4. 访问 MCP Schema MCP Schema 文件可以通过以下 URL 访问，您可以在 MCP 客户端中配置此 Schema URL (如果需要)： 'http://localhost:8000/.well-known/mcp-schema.json'

  5. 环境变量配置 在启动 MCP 服务器之前，您可能需要设置 'SPRING_BOOT_URL' 环境变量，指向您的 Spring Boot 应用的根 URL。例如：

    export SPRING_BOOT_URL="http://localhost:8080"
python main.py

    如果您 Spring Boot 应用运行在 'http://localhost:8080'，则需要设置此环境变量。

现在，您的 MCP 客户端应该能够通过 Spring MCP Bridge 访问和调用您的 Spring Boot API 功能了。

信息

分类

网页与API

访问项目