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 許可證。