open-api-mcp

基本能力

产品定位

Open API MCP 是一个用于快速生成 MCP 服务器的工具，主要面向开发人员，帮助其基于 OpenAPI 规范快速搭建 API 服务。

核心功能

1. 基于 OpenAPI 规范生成 MCP 服务器：通过解析 OpenAPI 规范文件（JSON 或 YAML 格式），自动生成对应的 MCP 服务器。
2. 支持多种部署方式：可以通过命令行直接运行，也可以通过 Docker 容器化部署。
3. 灵活的配置选项：支持通过环境变量配置 API 地址、API 密钥、MCP 服务器名称、版本以及传输类型等。

适用场景

1. 快速原型开发：开发人员可以通过 OpenAPI 规范快速生成 API 服务，用于原型验证或测试。
2. API 服务自动化：适用于需要基于 OpenAPI 规范自动化生成 API 服务的场景。
3. 微服务架构：在微服务架构中，可以通过 OpenAPI MCP 快速生成多个服务的 MCP 服务器。

工具列表

1. cli.sh：用于启动 MCP 服务器的命令行脚本。
2. Docker 镜像：提供容器化部署的支持，简化环境配置和部署流程。

常见问题解答

1. 如何指定 OpenAPI 规范文件？
2. 通过命令行参数指定文件路径，例如 ./cli.sh open-api.json。
3. 在 Docker 中，通过环境变量 OPEN_API_FILE 指定文件路径。
4. 如何配置 API 地址和密钥？
5. 在 .env 文件中配置，或在 Docker 的环境变量中直接设置。

使用教程

使用依赖

1. 安装 Bun（JavaScript 运行时）： bash curl -fsSL https://bun.sh/install | bash
2. 安装 Docker（可选，用于容器化部署）： bash curl -fsSL https://get.docker.com | sh

安装教程

1. 克隆仓库： bash git clone https://github.com/nexpando-com/open-api-mcp.git cd open-api-mcp
2. 安装依赖： bash bun install
3. 准备 OpenAPI 规范文件： bash wget -q -O open-api.json https://fakestoreapi.com/fakestoreapi.json 或使用 curl： bash curl -o open-api.json https://fakestoreapi.com/fakestoreapi.json
4. 配置环境变量： bash cp .env.template .env
5. 启动 MCP 服务器： bash ./cli.sh open-api.json

Docker 部署

1. 创建 specs 目录并放置 OpenAPI 规范文件： bash mkdir specs cp open-api.json specs/
2. 创建 docker-compose.yml 文件并配置： yaml services: open-api-mcp: image: nexpando/open-api-mcp container_name: open-api-mcp volumes: - ./specs:/app/specs environment: - OPEN_API_FILE=/app/specs/open-api.json - API_URL=https://fakestoreapi.com
3. 启动服务： bash docker-compose up

调试方式

1. 检查日志输出：
2. 命令行启动时，直接查看终端输出。
3. Docker 启动时，使用 docker logs open-api-mcp 查看日志。
4. 验证 API 服务：
5. 使用 curl 或 Postman 测试生成的 API 端点。

许可证

该项目遵循 MIT 开源许可条款，请参阅 MIT 了解完整条款。