Gin MCP

🚀 Gin - MVC の MCP 統合

Gin - MVC フレームワークでは、Gin - MCP という新しい機能モジュールを導入しました。このモジュールにより、開発者は Gin アプリケーションを MCP（機械学習プラットフォーム）と統合することができます。この特性により、Gin アプリにはより強力な拡張性と柔軟性がもたらされます。

🚀 クイックスタート

📦 インストール

Gin アプリで MCP サービスを使用するには、以下の手順に従ってください。

1. 依存関係のインストール：プロジェクトのルートディレクトリで以下のコマンドを実行して、必要なパッケージをインストールします。

   go get github.com/yourusername/gin-mcp/v2
   

2. MCP インスタンスの作成：Gin アプリで MCP サーバーインスタンスを初期化します。

   mcp := ginmcp.New(r, &ginmcp.Config{
       Name:        "Your App Name",
       Description: "Description of your app.",
       BaseURL:     "http://localhost:8080",
   })
   

3. ルートの設定：MCP ルートを指定されたパスにマウントします。

   mcp.Mount("/mcp")
   

4. アプリの起動：最後に、Gin アプリを実行します。

   r.Run(":8080")
   

💻 使用例

基本的な使用法

// 依存関係のインストール
go get github.com/yourusername/gin-mcp/v2

// MCP インスタンスの作成
mcp := ginmcp.New(r, &ginmcp.Config{
    Name:        "Your App Name",
    Description: "Description of your app.",
    BaseURL:     "http://localhost:8080",
})

// ルートの設定
mcp.Mount("/mcp")

// アプリの起動
r.Run(":8080")

高度な使用法

カスタムリクエストとレスポンスの Schema の定義

API の入出力形式をより良く制御するために、リクエストとレスポンスの JSON Schema をカスタマイズすることができます。

// 定義クエリパラメータ構造体
type QueryParams struct {
    Page  int `json:"page" jsonschema:"required,minimum=1,maximum=100"`
    Limit int `json:"limit" jsonschema:"required,minimum=1,maximum=100,default=10"`
}

// 定義リクエストボディ構造体
type CreateRequest struct {
    Name  string `json:"name" jsonschema:"required,description='Name of the resource'"`
    Value int    `json:"value" jsonschema:"required,minimum=0,maximum=100"`
}

カスタム Schema の登録

特定のルートと HTTP メソッドに対して、カスタムのリクエストとレスポンス schema を登録することができます。

mcp.RegisterSchema("GET", "/api/users", QueryParams{}, nil)
mcp.RegisterSchema("POST", "/api/users", nil, CreateRequest{})

公開する API エンドポイントのフィルタリング

セキュリティ上の理由から、MCP サービスに公開する API エンドポイントを選択的にフィルタリングすることができます。

// 操作 ID でフィルタリング
mcp := ginmcp.New(r, &ginmcp.Config{
    IncludeOperations: []string{"operation1", "operation2"},
})

// タグでフィルタリング
mcp := ginmcp.New(r, &ginmcp.Config{
    IncludeTags: []string{"public", "admin"},
})

高度な設定

レスポンス Schema の記述方法を選択することもできます。

mcp := ginmcp.New(r, &ginmcp.Config{
    DescribeAllResponses:        true,
    DescribeFullResponseSchema:  true,
})

🔧 技術詳細

サンプルの参照

より具体的な使用例については、プロジェクト内の examples ディレクトリを参照してください。

MCP クライアントでの接続

Gin アプリを起動した後は、以下の手順で MCP クライアントを使用して接続できます。

1. MCP クライアント（例：Cursor）を開きます。
2. 設定で MCP サービスのアドレスを入力します。例えば、http://localhost:8080/mcp です。
3. 統合された API ツールを使用して開発とデバッグを開始します。

🤝 貢献

どんな貢献も大歓迎です！問題や Pull Request をいつでも提出してください。