Quickmcp

🚀 QuickMCP 快速入門指南

QuickMCP 是一款強大的 .NET 工具包，主要用於簡化模型上下文協議（MCP）服務器的創建與部署工作。藉助它，開發者能依據 OpenAPI、Swagger 或 Google 發現規範快速生成服務器，減少樣板代碼，加快開發進程。

✨ 主要特性

• 可從 OpenAPI、Swagger 或 Google 發現規範生成 .NET MCP 服務器。
• 是高度可配置的 .NET 庫，還配備 CLI 實用工具，方便快速部署。
• 支持多種配置方式，既可以使用配置選項，也能通過方法鏈來配置。
• 提供全面的身份驗證支持，涵蓋 API Key、Basic、Bearer Token、OAuth 2.0、自定義頭，並且提供自定義身份驗證實現接口。
• 擁有配置生成工具，具備路徑過濾、HTTP 自定義、錯誤處理和日誌記錄等功能。
• 能與 MCP 客戶端（如 Claude Desktop）實現無縫集成。
• 支持配置文件，並且具備完整的異步/等待功能。

📦 安裝指南

CLI 安裝

dotnet tool install -g QuickMCP.CLI

庫安裝

dotnet add package QuickMCP

💻 使用示例

基礎用法

基本 CLI 使用方法

# 直接從 OpenAPI 規範提供服務
quickmcp serve --spec-url https://petstore.swagger.io/v2/swagger.json

# 生成配置文件
quickmcp build config --spec-url https://petstore.swagger.io/v2/swagger.json --output-path ./config

# 使用配置文件啟動服務
quickmcp serve --config-path ./config/mcp_server_config.json

# 在配置中添加身份驗證
quickmcp build config --spec-url https://api.example.com/swagger.json --auth bearer

# 添加一個服務器配置以實現快速訪問
quickmcp add server /path/to/config.json -n MyServer

# 列出所有已存儲的服務器配置
quickmcp list server

# 啟動已安裝的服務器配置
quickmcp serve -i myServer

# 刪除指定的服務器配置
quickmcp delete server MyServer

庫集成示例

// 創建並配置一個服務器實例
var serverInfoBuilder = McpServerInfoBuilder.ForOpenApi()
    .FromUrl("https://petstore.swagger.io/v2/swagger.json")
    .WithBaseUrl("https://petstore.swagger.io")
    .AddDefaultHeader("User-Agent", "QuickMCP 客戶端")
    .AddAuthentication(new ApiKeyAuthenticator("your-api-key", "X-API-Key", "header"));

// 構建服務器信息
var serverInfo = await serverInfoBuilder.BuildAsync();

// 集成到官方 MCP C# SDK 中
var hostBuilder = Host.CreateApplicationBuilder();

var mcpBuilder = hostBuilder.Services
    .AddMcpServer()
    .WithQuickMCP(mcpServerInfo)
    .WithStdioServerTransport();

// 啟動服務器
await hostBuilder.Build().RunAsync();

高級用法

與 MCP 客戶端的集成

{
  "servers": {
    "default": {
      "url": "http://localhost:8080"
    }
  }
}

或：

{
  "configuration": {
    "logging": {
      "level": "debug"
    }
  }
}

📚 詳細文檔

如需進一步瞭解如何使用 QuickMCP，請參考以下文檔：

• 安裝指南
• 基本 CLI 使用方法
• 庫集成示例
• 與 MCP 客戶端的集成

我們期待您能夠輕鬆利用 QuickMCP 提升開發效率，並歡迎您的反饋與建議。