Gin MCP

🚀 Gin-MVC 中的 MCP 集成

本項目在 Gin-MVC 框架中引入了名為 Gin-MCP 的新功能模塊，該模塊可幫助開發者將 Gin 應用程序與 MCP（機器學習平臺）集成，極大地增強了 Gin 應用的擴展性與靈活性。

🚀 快速開始

✨ 初始化 MCP 服務器

若要在你的 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")

💻 使用示例

基礎用法

自定義請求和響應 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

還能選擇如何描述 API 響應：

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。