https://github.com/gunpal5/QuickMCP
Effortlessly Build Model Context Protocol Servers with OpenAPI or Swagger or Google Discovery Specifications
https://github.com/gunpal5/QuickMCP
Last synced: 4 months ago
JSON representation
Effortlessly Build Model Context Protocol Servers with OpenAPI or Swagger or Google Discovery Specifications
- Host: GitHub
- URL: https://github.com/gunpal5/QuickMCP
- Owner: gunpal5
- License: mit
- Created: 2025-04-05T02:29:20.000Z (6 months ago)
- Default Branch: main
- Last Pushed: 2025-06-03T19:44:21.000Z (4 months ago)
- Last Synced: 2025-06-04T03:56:47.153Z (4 months ago)
- Language: C#
- Homepage: http://quickmcp.net
- Size: 5.17 MB
- Stars: 47
- Watchers: 1
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-mcp-servers - gunpal5/QuickMCP
- awesome-mcp-servers - **QuickMCP** - Effortlessly Build Model Context Protocol Servers with OpenAPI or Swagger or Google Discovery Specifications `api` `http` `git` `github` `c#` `git clone https://github.com/gunpal5/QuickMCP` (Other)
- awesome-mcp-servers - **QuickMCP** - Effortlessly Build Model Context Protocol Servers with OpenAPI or Swagger or Google Discovery Specifications `api` `http` `git` `github` `c#` `git clone https://github.com/gunpal5/QuickMCP` (Other)
- awesome-dotnet-mcp - QuickMCP - Effortlessly Build Model Context Protocol Servers with OpenAPI or Swagger or Google Discovery Specifications (Servers / DotNET)
- awesome-dotnet-mcp - QuickMCP - Effortlessly Build Model Context Protocol Servers with OpenAPI or Swagger or Google Discovery Specifications (Servers / DotNET)
README
# QuickMCP
Effortlessly Build and Serve Model Context Protocol (MCP) Servers with OpenAPI, Swagger, or Google Discovery Specifications using .NET.
## Introduction
QuickMCP is a powerful .NET toolkit designed to streamline the creation and deployment of Model Context Protocol (MCP) servers. It allows developers to quickly generate servers from OpenAPI, Swagger, or Google Discovery specifications, reducing boilerplate code and accelerating development.
## Features
- Generate .NET MCP servers from OpenAPI/Swagger/Google Discovery specifications
- Highly configurable .NET library with CLI utility for rapid deployment
- Multiple configuration approaches (Configuration options or method chaining)
- Comprehensive authentication support:
- API Key, Basic, Bearer Token, OAuth 2.0, Custom Header
- Custom authentication implementation interface
- Generate Tools with Path filtering, HTTP customization, error handling, and logging
- Seamless integration with MCP clients like Claude Desktop
- Configuration file support and full async/await capabilities
## Installation
### CLI Installation
```bash
dotnet tool install -g QuickMCP.CLI
```
### Library Installation
```bash
dotnet add package QuickMCP
```
## Quick Start
### Basic CLI Usage
```bash
# Serve directly from OpenAPI specification
quickmcp serve --spec-url https://petstore.swagger.io/v2/swagger.json
# Build a configuration file
quickmcp build config --spec-url https://petstore.swagger.io/v2/swagger.json --output-path ./config
# Serve using a configuration file
quickmcp serve --config-path ./config/mcp_server_config.json
# Add authentication to your configuration
quickmcp build config --spec-url https://api.example.com/swagger.json --auth bearer
# Add a server configuration for quick access
quickmcp add server /path/to/config.json -n MyServer
# List available servers
quickmcp list server
# Serve installed server
quickmcp serve -i myServer
# Remove a stored server configuration
quickmcp delete server MyServer
```
### Library Integration Example
```csharp
// Create and configure a server
var serverInfoBuilder = McpServerInfoBuilder.ForOpenApi()
.FromUrl("https://petstore.swagger.io/v2/swagger.json")
.WithBaseUrl("https://petstore.swagger.io")
.AddDefaultHeader("User-Agent", "QuickMCP Client")
.AddAuthentication(new ApiKeyAuthenticator("your-api-key", "X-API-Key", "header"));
// Build server info
var serverInfo = await serverInfoBuilder.BuildAsync();
//Integrate with official MCP C# SDK
var hostBuilder = Host.CreateApplicationBuilder();
var mcpBuilder = hostBuilder.Services
.AddMcpServer()
.WithQuickMCP(mcpServerInfo)
.WithStdioServerTransport();
//Run Server
await hostBuilder.Build().RunAsync();
```
### Integration with MCP Clients
```json
{
"mcpServers": {
"petStore": {
"command": "quickmcp",
"args": ["serve", "-c", "path/to/config.json"]
}
}
}
```
or Use installed server
```json
{
"mcpServers": {
"petStore": {
"command": "quickmcp",
"args": ["serve", "-i", "server_id"]
}
}
}
```
## Documentation
For detailed documentation on the following topics, refer to the wiki:
- [Library Implementation Guide](https://github.com/gunpal5/QuickMCP/wiki/Library-Implementation-Guide)
- [Authentication Options](https://github.com/gunpal5/QuickMCP/wiki/Authentication-Options)
- [Configuration Methods](https://github.com/gunpal5/QuickMCP/wiki/Configuration-Methods)
- [CLI Usage](https://github.com/gunpal5/QuickMCP/wiki/CLI-Usage)
## Contributing
We welcome contributions! Submit PR or Issues to contribute to the project.
## License
QuickMCP is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.