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

Spring Web 转换工具

将传统REST API转变为现代AI交互服务的桥梁