Openapi Mcpserver Generator

🚀 OpenAPI 到 MCP 服务器生成器

这是一个命令行工具，可依据 OpenAPI 规范生成 Model Context Protocol (MCP) 服务器代码。借助该工具，您能快速搭建一个 MCP 服务器，它可作为大型语言模型 (LLM) 与您的 API 之间的桥梁。

English | 简体中文

🚀 快速开始

此工具能让您快速创建 MCP 服务器，以下是使用步骤：

安装

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 规范中的每个 API 端点转换为 MCP 工具。
• 简便的安装：使用 npm 可轻松安装和运行。
• 强大的配置：支持多种安全方案，包括 OAuth2 和 OpenID Connect。
• 灵活的日志：允许自定义日志级别和输出格式。

📦 安装指南

使用以下命令进行全局安装：

npm install -g openapi-mcp-generator

💻 使用示例

基础用法

# 安装工具
npm install -g openapi-mcp-generator
# 运行生成器
oai-mcp generate --input your_openapi_spec.yaml --output ./mcp-server
# 启动生成的 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

📚 详细文档

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

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

📄 许可证

本项目采用 Apache 2.0 许可证。