MCP Openapi Proxy

mcp-openapi-proxy是一個Python包，實現了一個模型上下文協議（MCP）服務器，用於將OpenAPI規範的REST API動態暴露為MCP工具，便於集成到MCP工作流中。

開發者工具雲平臺 #API代理 #動態工具 #MCP集成 #OpenAPI .Python

評分 : 2.5分

下載量 : 67

更新時間 : 2025-04-23

什麼是MCP開放API代理?

MCP開放API代理是一個將REST API動態轉換為MCP工具的服務器，使開發者可以輕鬆集成和使用各種API。

如何使用MCP開放API代理?

只需配置OpenAPI規格文件URL，即可快速啟用支持的API。

適用場景

適合需要快速集成多種API的項目，如自動化工具、數據集成平臺等。

主要功能

動態生成工具自動創建MCP工具以對應OpenAPI定義中的每個有效端點。

簡單模式提供預定義的一組工具，簡化配置流程。

支持OpenAPI規範兼容OpenAPI v3，未來可能支持v2。

自定義認證支持通過JMESPath表達式進行認證。

優勢與侷限性

優勢

快速集成多種API

動態生成工具無需手動配置

支持多種認證方式

侷限性

對複雜API可能需要額外配置

依賴於有效的OpenAPI規格文件

如何使用

安裝

通過PyPI安裝MCP開放API代理。

配置

設置必要的環境變量如OPENAPI_SPEC_URL。

啟動服務器

運行服務器以暴露API。

使用案例

Glama 示例快速驗證Glama API。

Fly.io 示例管理Fly.io機器。

常見問題

如何確保OpenAPI規格文件有效？

如果API需要自定義認證怎麼辦？

相關資源

官方文檔

MCP開放API代理的GitHub倉庫。

OpenAPI規範

OpenAPI規範的官方網站。

安裝

複製以下命令到你的Client進行配置

{
    "mcpServers": {
        "mcp-openapi-proxy": {
            "command": "uvx",
            "args": ["mcp-openapi-proxy"],
            "env": {
                "OPENAPI_SPEC_URL": "${OPENAPI_SPEC_URL}",
                "API_KEY": "${API_OPENAPI_KEY}"
            }
        }
    }
}

{
    "mcpServers": {
        "glama": {
            "command": "uvx",
            "args": ["mcp-openapi-proxy"],
            "env": {
                "OPENAPI_SPEC_URL": "https://glama.ai/api/mcp/openapi.json"
            }
        }
    }
}

{
    "mcpServers": {
        "flyio": {
            "command": "uvx",
            "args": ["mcp-openapi-proxy"],
            "env": {
                "OPENAPI_SPEC_URL": "https://raw.githubusercontent.com/abhiaagarwal/peristera/refs/heads/main/fly-machines-gen/fixed_spec.json",
                "API_KEY": "<your_flyio_token_here>"
            }
        }
    }
}

{
    "mcpServers": {
        "render": {
            "command": "uvx",
            "args": ["mcp-openapi-proxy"],
            "env": {
                "OPENAPI_SPEC_URL": "https://api-docs.render.com/openapi/6140fb3daeae351056086186",
                "TOOL_WHITELIST": "/services,/maintenance",
                "API_KEY": "your_render_token_here"
            }
        }
    }
}

{
    "mcpServers": {
        "slack": {
            "command": "uvx",
            "args": ["mcp-openapi-proxy"],
            "env": {
                "OPENAPI_SPEC_URL": "https://raw.githubusercontent.com/slackapi/slack-api-specs/master/web-api/slack_web_openapi_v2.json",
                "TOOL_WHITELIST": "/chat,/bots,/conversations,/reminders,/files,/users",
                "API_KEY": "<your_slack_bot_token, starts with xoxb>",
                "STRIP_PARAM": "token",
                "TOOL_NAME_PREFIX": "slack_"
            }
        }
    }
}

{
    "mcpServers": {
        "getzep": {
            "command": "uvx",
            "args": ["mcp-openapi-proxy"],
            "env": {
                "OPENAPI_SPEC_URL": "https://raw.githubusercontent.com/matthewhand/mcp-openapi-proxy/refs/heads/main/examples/getzep.swagger.json",
                "TOOL_WHITELIST": "/sessions",
                "API_KEY": "<your_getzep_api_key>",
                "API_AUTH_TYPE": "Api-Key",
                "TOOL_NAME_PREFIX": "zep_"
            }
        }
    }
}

{
    "mcpServers": {
        "virustotal": {
            "command": "uvx",
            "args": ["mcp-openapi-proxy"],
            "env": {
                "OPENAPI_SPEC_URL": "https://raw.githubusercontent.com/matthewhand/mcp-openapi-proxy/refs/heads/main/examples/virustotal.openapi.yml",
                "EXTRA_HEADERS": "x-apikey: ${VIRUSTOTAL_API_KEY}",
                "OPENAPI_SPEC_FORMAT": "yaml"
            }
        }
    }
}

{
  "mcpServers": {
    "notion": {
      "command": "uvx",
      "args": [
        "mcp-openapi-proxy"
      ],
      "env": {
          "API_KEY": "ntn_<your_key>",
          "OPENAPI_SPEC_URL": "https://storage.googleapis.com/versori-assets/public-specs/20240214/NotionAPI.yml",
          "SERVER_URL_OVERRIDE": "https://api.notion.com",
          "EXTRA_HEADERS": "Notion-Version: 2022-06-28"
      }
    }
  }
}

{
  "mcpServers": {
    "asana": {
      "command": "uvx",
      "args": [
        "mcp-openapi-proxy"
      ],
      "env": {
        "OPENAPI_SPEC_URL": "https://raw.githubusercontent.com/Asana/openapi/refs/heads/master/defs/asana_oas.yaml",
        "SERVER_URL_OVERRIDE": "https://app.asana.com/api/1.0",
        "TOOL_WHITELIST": "/workspaces,/tasks,/projects,/users",
        "API_KEY": "${ASANA_API_KEY}"
      }
    }
  }
}

{
    "mcpServers": {
        "apisguru": {
            "command": "uvx",
            "args": ["mcp-openapi-proxy"],
            "env": {
                "OPENAPI_SPEC_URL": "https://raw.githubusercontent.com/APIs-guru/openapi-directory/refs/heads/main/APIs/apis.guru/2.2.0/openapi.yaml"
            }
        }
    }
}

{
    "mcpServers": {
        "netbox": {
            "command": "uvx",
            "args": ["mcp-openapi-proxy"],
            "env": {
                "OPENAPI_SPEC_URL": "https://raw.githubusercontent.com/APIs-guru/openapi-directory/refs/heads/main/APIs/netbox.dev/3.4/openapi.yaml",
                "API_KEY": "${NETBOX_API_KEY}"
            }
        }
    }
}

{
  "mcpServers": {
    "wolframalpha": {
      "command": "uvx",
      "args": [
        "mcp-openapi-proxy"
      ],
      "env": {
        "OPENAPI_SPEC_URL": "https://raw.githubusercontent.com/APIs-guru/openapi-directory/refs/heads/main/APIs/wolframalpha.com/v0.1/openapi.yaml",
        "API_KEY": "${WOLFRAM_LLM_APP_ID}"
      }
    }
  }
}

注意：您的密鑰屬於敏感信息，請勿與任何人分享。

🚀 MCP 服務器配置指南

本指南詳細介紹了 MCP 服務器的安裝、配置、使用示例、故障排除等內容，幫助你快速搭建和使用 MCP 服務器。

🚀 快速開始

要運行 MCP 服務器，你需要先安裝相關依賴項，然後進行配置和使用。以下是具體步驟：

安裝依賴項：Node.js 和 npm。
使用 npm 安裝 MCP 服務器。
配置 MCP 服務器，包括示例配置文件和環境變量。
參考使用示例進行服務器配置。
若遇到問題，可參考故障排除部分進行解決。

✨ 主要特性

支持多種環境配置，如開發環境和生產環境。
可通過環境變量靈活配置服務器參數。
提供多種 API 配置示例，方便集成不同服務。
支持不同日誌記錄級別，便於調試和監控。

📦 安裝指南

要運行 MCP 服務器，請先安裝以下依賴項：

Node.js (推薦版本：16.x 或更高)
npm (推薦版本：7.x 或更高)

安裝命令如下：

npm install -g mcp-server

💻 使用示例

基礎用法

MCP 服務器配置示例

以下是 MCP 服務器的典型配置文件：

{
  "mcpServers": {
    "default": {
      "command": "uvx",
      "args": ["mcp-server"],
      "env": {
        "OPENAPI_SPEC_URL": "https://example.com/openapi.json",
        "TOOL_WHITELIST": "/users,/posts",
        "API_KEY": "your_api_key"
      }
    }
  }
}

Box API 配置示例

以下是一個 Box API 的配置示例：

{
  "mcpServers": {
    "box": {
      "command": "uvx",
      "args": ["mcp-server"],
      "env": {
        "OPENAPI_SPEC_URL": "https://raw.githubusercontent.com/APIs-guru/openapi-directory/refs/heads/main/APIs/box.com/2.0.0/openapi.yaml",
        "TOOL_WHITELIST": "/files,/folders",
        "BOX_API_KEY": "your_box_api_key"
      }
    }
  }
}

Wolfram Alpha API 配置示例

以下是一個 Wolfram Alpha API 的配置示例：

{
  "mcpServers": {
    "wolfram-alpha": {
      "command": "uvx",
      "args": ["mcp-server"],
      "env": {
        "OPENAPI_SPEC_URL": "https://example.com/wolfram-alpha/openapi.json",
        "WOLFRAM_API_KEY": "your_wolfram_api_key"
      }
    }
  }
}

高級用法

示例用法

OPENAPI_SPEC_URL="https://example.com/openapi.yaml" TOOL_WHITELIST="/users,/posts" uvx mcp-server

📚 詳細文檔

配置

示例配置文件

以下是一個典型的 MCP 服務器配置文件示例：

{
  "mcpServers": {
    "development": {
      "command": "uvx",
      "args": ["mcp-server"],
      "env": {
        "NODE_ENV": "development",
        "PORT": 3000,
        "API_KEY": "your_api_key_here"
      }
    },
    "production": {
      "command": "uvx",
      "args": ["mcp-server"],
      "env": {
        "NODE_ENV": "production",
        "PORT": 3001,
        "API_KEY": "your_production_api_key"
      }
    }
  }
}

環境變量配置

以下是 MCP 服務器支持的關鍵環境變量：

OPENAPI_SPEC_URL：指定 OpenAPI 規範的 URL 或本地文件路徑。
TOOL_WHITELIST：指定允許的工具端點，以逗號分隔的字符串。
API_KEY：指定 API 訪問密鑰。
DEBUG：啟用調試模式（值為 true 時）。

🔧 技術細節

故障排除

常見問題

問題：找不到 OpenAPI 規範文件
- 解決方法：檢查 OPENAPI_SPEC_URL 是否正確，並確保路徑可訪問。
問題：工具端點被拒絕
- 解決方法：檢查 TOOL_WHITELIST 是否包含所需的端點，或將其設置為 null 允許所有端點。
問題：API 請求失敗
- 解決方法：驗證 API_KEY 是否有效，並確保 API 服務正常運行。

日誌記錄

MCP 服務器支持以下日誌記錄級別：

debug
info
warning
error

📄 許可證

本項目遵循 MIT 許可證，具體條款如下：

MIT License

Copyright (c) [year] [author]

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

以上是 MCP 服務器的完整配置指南。如需進一步幫助，請參考官方文檔或聯繫支持團隊。