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