Openapi To MCP Server

🚀 OpenAPI 轉換為 MCP 配置工具

本工具能夠將 OpenAPI 規範轉換為 MCP 配置，支持多種文件格式，保留關鍵信息，還具備模板補丁功能，方便用戶進行自定義修改。

✨ 主要特性

• 路徑轉換：將 OpenAPI 的路徑轉換為 MCP 工具。
• 文件格式支持：支持 JSON 和 YAML 格式的 OpenAPI 規範。
• 生成配置：生成包含服務器和工具定義的 MCP 配置。
• 保留參數描述：保留參數描述和類型信息。
• 自動設置位置：根據 OpenAPI 參數位置自動設置 position 字段。
• 支持多種參數類型：支持路徑、查詢、頭、Cookie 和正文參數。
• 生成響應模板：生成包含字段描述和改進格式的響應模板，便於 LLM 理解。
• 可選規範驗證：提供 OpenAPI 規範驗證功能（默認關閉）。
• 模板補丁支持：支持基於模板對生成配置進行自定義修改。

🚀 快速開始

模板補丁功能

通過 --template 標誌可以指定一個 YAML 文件，用於對生成的配置進行補丁式修改。這對於添加通用頭、認證信息或其他自定義配置非常有用。

示例模板文件

server:
  config:
    apiKey: ""

tools:
  requestTemplate:
    headers:
      - key: Authorization
        value: "APPCODE {{.config.apiKey}}"
      - key: X-Ca-Nonce
        value: "{{uuidv4}}"

應用後，模板將執行以下操作：

1. 在服務器配置中添加 apiKey 字段。
2. 將指定的頭信息添加到所有工具的配置中。

使用方法

openapi-to-mcp --input api-spec.json --output mcp-server.yaml --server-name my-server --template template.yaml

模板中的佔位符如 {{.config.apiKey}} 或 "{{uuidv4}}" 不會在此工具中處理，而是直接保留在輸出文件中，以便 MCP 服務器在運行時使用。