Gin MCP

🚀 Gin-MVC MCP Integration

This project introduces a new feature module named Gin-MCP in the Gin-MVC framework, enabling developers to integrate Gin applications with the MCP (Machine Learning Platform). This feature enhances the extensibility and flexibility of Gin applications.

🚀 Quick Start

✨ Features

• Integrate Gin applications with MCP.
• Customize request and response JSON schemas.
• Filter exposed API endpoints.
• Advanced configuration for response schema description.

📦 Installation

To use the MCP service in your Gin application, follow these steps:

1. Install Dependencies: Run the following command in the project root directory to install the necessary packages:

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

2. Create an MCP Instance: Initialize an MCP server instance in your Gin application:

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

3. Configure Routes: Mount the MCP routes to the specified path:

   mcp.Mount("/mcp")
   

4. Start the Application: Finally, run your Gin application:

   r.Run(":8080")
   

💻 Usage Examples

Basic Usage

// Define query parameter structure
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"`
}

// Define request body structure
type CreateRequest struct {
    Name  string `json:"name" jsonschema:"required,description='Name of the resource'"`
    Value int    `json:"value" jsonschema:"required,minimum=0,maximum=100"`
}

Advanced Usage

// Register custom schemas for specific routes and HTTP methods
mcp.RegisterSchema("GET", "/api/users", QueryParams{}, nil)
mcp.RegisterSchema("POST", "/api/users", nil, CreateRequest{})

Filtering Exposed API Endpoints

// Filter by operation ID
mcp := ginmcp.New(r, &ginmcp.Config{
    IncludeOperations: []string{"operation1", "operation2"},
})

// Filter by tag
mcp := ginmcp.New(r, &ginmcp.Config{
    IncludeTags: []string{"public", "admin"},
})

Advanced Configuration

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

More Examples

For more practical usage examples, refer to the examples directory in the project.

Connecting with the MCP Client

After starting your Gin application:

1. Open the MCP client (e.g., Cursor).
2. Enter your MCP service address in the settings, for example: http://localhost:8080/mcp.
3. Start developing and debugging using the integrated API tools.

🤝 Contribution

Any contributions are welcome! Please feel free to submit issues or pull requests.