Spring Rest To MCP

🚀 Spring Web 转换工具

本项目提供了一个强大的工具，可将传统的 REST API 转换为 Spring AI MCP（机器人员协议）服务器。通过简单的注解添加和配置修改，就能让您的 API 立即具备现代 AI 交互能力。

✨ 主要特性

• 自动注解处理：在保留现有功能的基础上，自动为 REST 方法添加必要的 @Tool 和 @ToolParam 注解。
• 配置自动生成：自动在 application.properties 或 application.yml 中添加 MCP 服务器所需的所有配置。
• 工具注册：自动生成工具注册 bean，无需手动实现工具发现逻辑。

🚀 快速开始

使用场景

1. 传统系统升级：能将遗留的 REST API 快速转换为支持 AI 交互的新一代接口。
2. API 现代化：为现有的 Spring Boot 服务增添 AI 交互能力。
3. 混合架构：可同时维护传统和现代客户端的支持。

转换过程

第一步：更新 POM 文件

mvn org.openrewrite.maven:rewrite-maven-plugin:6.4.0:run \
  -Drewrite.activeRecipes=org.spring.rewrite.McpConversionRecipe \
  -Drewrite.recipeArtifactCoordinates=com.example:spring-web-conversion-tool:1.0.0 \
  -Drewrite.exportDatatables=true

第二步：应用注解转换

mvn org.openrewrite.maven:rewrite-maven-plugin:6.4.0:run \
  -Drewrite.activeRecipes=org.spring.rewrite.McpConversionRecipe \
  -Drewrite.recipeArtifactCoordinates=com.example:spring-web-conversion-tool:1.0.0 \
  -Drewrite.exportDatatables=true

第三步：验证转换结果

• 检查 Controller 类中是否正确添加了 @Tool 和 @ToolParam 注解。
• 查看主应用类中是否自动生成了工具注册 bean。
• 确认 application.properties 或 application.yml 中是否新增 MCP 服务器配置。

💻 使用示例

示例项目

项目结构

git clone https://github.com/example/spring-boot-rest-api.git
cd spring-boot-rest-api

核心代码示例

Controller 类

@Tool(description = "获取用户信息")
public User getUserById(@ToolParam(description = "用户ID") @PathVariable Long id) {
    // 实现逻辑
}

配置文件

spring.ai.mcp.server.name=my-rest-api-mcp-server
spring.ai.mcp.server.sse-message-endpoint=/mcp/messages
spring.ai.mcp.server.type=SYNC
spring.ai.mcp.server.version=1.0.0

工具注册示例

@Bean
ToolCallbackProvider toolCallbackProvider(MyController myController) {
    return MethodToolCallbackProvider.builder()
            .toolObjects(myController)
            .build();
}

演示过程

1. 克隆示例项目：

   git clone https://github.com/example/spring-boot-rest-api.git
   cd spring-boot-rest-api
   

2. 执行 Maven 命令完成转换：

   mvn org.openrewrite.maven:rewrite-maven-plugin:6.4.0:run \
     -Drewrite.activeRecipes=org.spring.rewrite.McpConversionRecipe \
     -Drewrite.recipeArtifactCoordinates=com.example:spring-web-conversion-tool:1.0.0 \
     -Drewrite.exportDatatables=true
   

3. 启动应用：

   mvn spring-boot:run
   

4. 使用 MCP Inspector 进行验证：

   git clone https://github.com/protocol/mcp-inspector.git
   cd mcp-inspector
   npm install && npm run dev
   

配置示例

客户端配置

{
  "servers": [
    {
      "url": "http://localhost:8080",
      "name": "my-rest-api-mcp-server"
    }
  ]
}

📄 许可证

项目使用 MIT 许可证，允许自由修改和使用。

🤝 贡献指南

欢迎提交 PR 修复问题或改进功能。请 Fork 仓库并在自己的分支上进行开发。

📞 联系方式

如有任何问题，请联系：contact@example.com