基本能力
产品定位
Spring Web to MCP Converter 是一个开发工具,旨在帮助开发者将现有的 Spring Web REST API 转换为符合 Spring AI MCP 协议的服务器工具,从而提升 API 的可访问性和兼容性。
核心功能
- 注解转换:将 Spring Web 的注解(如
@GetMapping
)转换为 MCP 的@Tool
和@ToolParam
注解。 - 配置更新:自动添加 MCP 服务器所需的配置,包括服务器名称、版本、类型和消息端点。
- 依赖管理:更新 Maven 依赖以包含 Spring AI MCP 服务器组件。
- 文档提取:从 JavaDoc 注释中提取方法描述,用于生成 MCP 工具的文档。
适用场景
- API 迁移:将现有的 Spring Web REST API 迁移到 MCP 协议,以便与 AI 代理集成。
- 开发效率:自动化转换过程,减少手动修改代码的工作量。
- 兼容性提升:使 API 能够同时支持传统 REST 和 MCP 协议。
工具列表
- OpenRewrite 配方:用于执行代码转换和配置更新。
- MCP Inspector:用于测试和验证转换后的 MCP 服务器工具。
常见问题解答
- 如何运行转换? 需要运行两次 Maven 命令,第一次更新 POM 文件,第二次执行代码转换。
- 转换后 API 是否仍支持 REST? 是的,转换后的 API 仍保留原有的 REST 功能。
- 如何测试转换结果? 可以使用 MCP Inspector 工具进行交互式测试。
使用教程
使用依赖
- Java 17 或更高版本
- Maven 3.6+
- Spring Boot 3.2+
- Spring Web MVC
安装教程
- 克隆仓库:
bash
git clone https://github.com/yourusername/web-to-mcp.git
cd web-to-mcp - 构建项目:
bash
mvn clean install
调试方式
- 运行转换命令:
bash
mvn org.openrewrite.maven:rewrite-maven-plugin:6.4.0:run \
-Drewrite.activeRecipes=RewriteWebToMCP \
-Drewrite.recipeArtifactCoordinates=com.atbug.rewrite:web-to-mcp:1.0-SNAPSHOT \
-Drewrite.exportDatatables=true - 运行应用:
bash
mvn spring-boot:run - 使用 MCP Inspector 测试:
bash
git clone https://github.com/modelcontextprotocol/inspector.git
cd inspector
npm install
npm run dev
访问 http://localhost:5173/ 进行测试。