Auto MCP

Auto MCP

访问 Auto MCP 主页

将任意 OpenAPI/Swagger 定义转换为功能完备的**模型上下文协议（MCP）**服务，可在本地、Claude Desktop 内部或云端运行。

该服务读取 Swagger（OpenAPI v2）或 OpenAPI v3 文档，动态生成路由，将请求代理到你配置的上游端点，并通过 MCP 规范定义的 STDIO、HTTP 或 SSE 传输方式对外提供服务。

---

✨ 为什么选择 Auto MCP？

• 无需样板代码——只需提供 swagger.json 即可开始服务。
• 灵活部署——可作为 CLI、长期运行的守护进程，或在 Docker/Kubernetes 中运行。
• 支持所有传输模式——
  • stdio（默认）。
  • http - StreamableHttp，最新的 MCP 原型。
  • sse – 可自托管的长期运行事件源。
• 可插拔的身份验证——支持 bearer token、basic auth、API 密钥、OAuth2 或无身份验证。
• 运行时配置——支持 YAML 文件、CLI 标志或环境变量（前缀为 AUTO_MCP_）。

---

🛠️ 使用 Auto MCP

轻松调整 Swagger/OpenAPI 文件，以实现最佳 MCP 集成。MCP Config Builder 可让你：

• 编辑端点描述，提供更清晰、更实用的文档。
• 筛除不必要的路由，精简对外暴露的 API。
• 预览并自定义端点呈现给大模型和客户端的方式。
• 生成调整文件（--adjustment-file），供 Auto MCP 使用并自动应用你的自定义设置。

工作原理

1. 安装 MCP Config Builder：

   go install ./cmd/mcp-config-builder
   

   这会在你的 $GOPATH/bin（通常为 ~/go/bin）中构建并安装 mcp-config-builder 二进制文件。请确保此目录已加入 PATH。
2. 启动工具：

   mcp-config-builder --swagger-file=/path/to/swagger.json
   

3. 以交互方式检查和编辑端点，使用友好的 TUI（终端用户界面）。
4. 将调整保存到文件中，以便日后使用或分享。
5. 使用调整文件运行 Auto MCP，以应用你的自定义设置：

   auto-mcp --swagger-file=/path/to/swagger.json --adjustment-file=/path/to/adjustments.json
   

---

📚 使用场景

1. **快速原型开发：**几秒钟内即可将任意 REST API 封装为 MCP 服务——适合测试创意或快速构建 AI 工具。

2. **桥接旧系统：**将旧系统或内部系统作为 MCP 端点暴露，无需重写。

3. **从聊天应用访问任意第三方 API：**将任意第三方 API 转换为 MCP 工具，让 Claude 等 AI 助手能够访问。

4. **轻量代理工具：**使用 auto-mcp 代理已处理验证和逻辑的 API——无需编写封装层。

---

🖥️ 在 Claude Desktop 中运行

将以下代码片段添加到你的 Claude Desktop 配置中（⟂ 设置 → MCP 服务器）：

{
  "mcpServers": {
    "YourMCP": {
      "command": "docker",
      "args": [
        "run",
        "-i",
        "--rm",
        "-v",
        "/Users/you/path/to/swagger.json:/server/swagger.json",
        "ghcr.io/brizzai/auto-mcp:latest"
        "--swagger-file=/server/swagger.json"
      ]
    }
  },
  "globalShortcut": ""
}

Claude 会按需启动容器，并通过 STDIO 连接。请根据你的环境替换 swagger.json 的主机路径和镜像标签。

CLI 标志

• --mode – 覆盖 server.mode（stdio 或 sse）。
• --swagger-file – OpenAPI 文档的路径（默认：swagger.json）。
• --adjustment-file - mcp-config-builder 输出，用于筛选/更改路由描述

如需详细的配置指南，请参阅 CONFIGURATION.md。

---

🔐 OAuth 支持

Auto MCP 支持 OAuth 2.1 身份验证，包括 PKCE、动态客户端注册和多个提供方（内部、GitHub、Google）。这让你可以使用符合行业标准的身份验证流程来保护 MCP 服务。

如需详细的设置说明、端点描述和测试提示，请参阅 OAuth 使用指南。

---

🐳 使用 Docker 运行

1. 在本地 stdio 模式下运行：

   docker run --rm -i \
     -v $(pwd)/swagger.json:/server/swagger.json \
       ghcr.io/brizzai/auto-mcp:latest \
       --swagger-file=/server/swagger.json \
       --mode=stdio
   

2. 在远程 sse/http 模式下运行：

   docker run \
     -v $(pwd)/swagger.json:/server/swagger.json \
       ghcr.io/brizzai/auto-mcp:latest \
       --swagger-file=/server/swagger.json \
       --mode=http
   

随附的 docker-compose.yml 会映射端口 8080，并将日志持久化到 ./logs。

运行 Petshop 示例

你可以使用 Docker 试用随附的 Petshop 演示。此演示使用示例配置和 API 规范来展示 auto-mcp 的工作方式。

步骤：

1. 确保你位于此仓库的根目录。
2. 运行以下命令：

docker run --rm -i \
  -v $(pwd)/examples/petshop/config:/config \
  ghcr.io/brizzai/auto-mcp:latest

• 此命令会将本地计算机上的 examples/petshop/config 目录挂载到 Docker 容器内的 /config。
• 容器内的 /config 目录应包含：
  • config.yaml：演示的主配置文件
  • swagger.json：Petshop 服务的 API 规范
  • adjustment.yaml：API 的可选调整或覆盖项

注意： 你放入 examples/petshop/config 的任何文件都会覆盖容器内默认的 config.yaml、swagger.json 和 adjustment.yaml。

此设置让你可以轻松测试和修改 Petshop 演示配置。

如需查看所有配置选项和环境变量覆盖项，请参阅 [docs/CONFIGURATION.md](docs/ CONFIGURATION.md)。

🤝 贡献

如需详细的贡献指南，请参阅 CONTRIBUTING.md。

---

📄 许可证

根据 Apache License 2.0 License 分发。详情请参阅 LICENSE。