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 提升开发效率，并欢迎您的反馈与建议。