OpenAPI 到 MCP 服务器生成器

一个命令行工具，用于从 OpenAPI 规范生成 Model Context Protocol (MCP) 服务器代码。此工具可帮助您快速创建一个 MCP 服务器，作为大型语言模型 (LLM) 和您的 API 之间的桥梁。

English | 简体中文

最初的想法

此仓库最初是从 openapi-mcp-generator 叉出，并添加了一些额外功能：

• 支持 OpenAPI 规范中的嵌套 $ref
• 除了生成源代码外，还生成 MCP 服务器配置
• 允许客户端设置日志级别并将日志消息作为通知发送到客户端
• 出现错误时将消息发送到 stderr

功能

• 自动工具生成: 将您 OpenAPI 规范中的每个 API 端点转换为 MCP 工具
• 简便的安装: 使用 npm 可轻松安装和运行
• 强大的配置: 支持多种安全方案，包括 OAuth2 和 OpenID Connect
• 灵活的日志: 允许自定义日志级别和输出格式

安装

npm install -g openapi-mcp-generator

使用说明

基本用法

1. 首先，安装工具：

   npm install -g openapi-mcp-generator
   

2. 然后，运行生成器：

   oai-mcp generate --input your_openapi_spec.yaml --output ./mcp-server
   

3. 最后，启动生成的 MCP 服务器：

   cd mcp-server && npm start
   

高级功能

支持的安全方案

OpenAPI 3.0 支持四种安全类型：

• apiKey: 示例：

    "securitySchemes": {
        "my_api_key": {
            "type": "apiKey",
            "name": "api_key",
            "in": "header"
        }
    }
  

  预期在 .env 中找到大写的环境变量：MY_API_KEY_API_KEY

• http: 示例：

    "securitySchemes": {
        basicAuth: {
           type: "http",
           scheme: "basic"
        }
    }
  

  尝试从 .env 中获取 BASICAUTH_USERNAME 和 BASICAUTH_PASSWORD

• oauth2: 由于/oauth2/的复杂性，无法自动处理。建议手动获取访问令牌，并将其设置为 .env 中的：

  API_HEADERS=Authorization:Bearer your-access-token-here
  

• openIdConnect 目前不支持

自定义日志级别

您可以在生成器中指定日志级别：

oai-mcp generate --input your_openapi_spec.yaml --output ./mcp-server --log-level debug

许可证

Apache 2.0