JinDaGe - spring-mcp-bridge MCP Details

article

README

🚀 Spring MCP 桥接工具

Spring MCP 桥接工具是一款强大的工具，它能自动把 Spring Boot 应用里的 REST 端点转换为 MCP（消息对话协议）服务器。这使得 Claude、Cursor 等 MCP 兼容工具可以直接与您的 API 进行交互，极大地提升了 API 与 AI 助手集成的效率。

⚠️ 重要提示

目前版本尚未包含认证功能。若需使用需要认证的 Spring Boot API，请在处理代码中添加相应的头信息或令牌。

🚀 快速开始

将现有 API 集成到 AI 助手通常需要手动编码或复杂配置。Spring MCP 桥接工具通过自动扫描您的 Spring Boot 项目并生成一个即可使用的 MCP 服务器，消除了这一复杂性。

✨ 主要特性

自动扫描：发现所有 REST 端点（@RestController、@GetMapping 等）
零配置：无需对现有 Spring Boot 代码进行任何修改
模型保留：保持请求和响应模型与 MCP 工具兼容
Javadoc 提取：利用现有文档增强 MCP 工具描述
完整文档：生成 README 和清晰的使用说明

📦 安装指南

# 克隆仓库
git clone https://github.com/brunosantos/spring-mcp-bridge.git

# 进入目录
cd spring-mcp-bridge

💻 使用示例

基础用法

扫描您的 Spring Boot 项目：

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

运行生成的 MCP 服务器：

cd mcp_server
pip install -r requirements.txt
python main.py

通过 MCP 客户端连接：
- 配置您的 MCP 客户端（Claude、Cursor 等）使用 http://localhost:8000
- MCP 模式描述将在 http://localhost:8000/.well-known/mcp-schema.json 可用

高级用法

python spring_mcp_bridge.py --project ~/projects/my-spring --output ./mcp_server --name MySpringApp

📚 详细文档

📋 参数

| 参数名 | 描述 | 默认值 | |-------------|--------------------------|-------------| | --project | Spring Boot 项目路径 | (必需) | | --output | 输出目录 | ./mcp_server | | --name | 应用名称 | SpringAPI | | --debug | 启用调试日志 | False |

配置说明

项目配置

在 config.py 文件中，可以自定义以下设置：

# 设置日志级别
LOG_LEVEL = "DEBUG"

# 设置最大线程数
MAX_THREADS = 10

环境变量

可以通过环境变量进一步配置桥接工具：

export MCP_BRIDGE_ENV=development
export MCP_BRIDGE_PORT=8000

使用示例

创建项目

# 初始化新项目
mkdir my_mcp_project
cd my_mcp_project
python -m spring_mcp_bridge init

运行服务器

# 安装依赖
pip install -r requirements.txt

# 启动服务器
python main.py

🔧 技术细节

自动扫描：支持所有标准的 Spring Boot 注解，如 @RestController、@GetMapping、@PostMapping 等。
模型绑定：自动处理请求参数和响应模型，无需额外配置。
异常处理：内置异常处理机制，能够将常见错误转换为 MCP 标准错误格式。

📄 许可证

本项目采用 MIT 许可证。

🙏 致谢

受 FastAPI - MCP 和 MCP 工具生态的启发
感谢 Spring Boot 和 FastAPI 社区

开发者

Bruno Santos

spring-mcp-bridge