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。