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. ハイブリッドアーキテクチャ：従来のクライアントと最新のクライアントのサポートを同時に維持します。

🚦 変換手順

ステップ1：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

ステップ2：アノテーション変換の適用

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：変換結果の検証

• 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対話サービスに変える架け橋