Snaggle Ai Openapi MCP Server

🚀 OpenAPI MCP 服務器

OpenAPI MCP 服務器可創建一個 Model Context Protocol (MCP) 服務器，作為任何具有 OpenAPI v3.1 規範的 API 的代理。藉助它，你能使用 Claude Desktop 輕鬆與本地和遠程服務器上的 API 進行交互，實現通過自然語言與 API 對話的便捷操作。

🚀 快速開始

配置 Claude Desktop

將以下內容添加到您的 claude_desktop_config.json 文件中：

{
  "mcpServers": {
    "petstore-api": {
      "command": "npx",
      "args": ["openapi-mcp-server", "/絕對/路徑/to/petstore-openapi.json"]
    }
  }
}

重啟並交互

重新啟動 Claude Desktop，即可開始與您的 API 進行交互！

✨ 主要特性

自動轉換端點

此代理能夠自動將 OpenAPI 端點轉換為 Claude 工具，讓 Claude 可以發現可用的 API 端點並瞭解其目的，知曉所需的參數及其類型，代表您進行 API 調用，還能適當處理響應。例如，對於 Petstore API 的 /pets/{petId} 端點：

/pets/{petId}:
  get:
    operationId: getPetById
    summary: Returns a pet by ID
    parameters:
      - name: petId
        in: path
        required: true
        schema:
          type: integer
          format: int64

Claude 能夠通過自然語言理解並執行此端點，返回有關寵物的詳細信息。

文件上傳支持

除了處理標準 API 請求外，OpenAPI MCP 服務器還支持文件上傳。具體配置方式如下：

1. 在 OpenAPI 規範中定義 FormData 參數：

parameters:
  - name: file
    in: formData
    required: true
    schema:
      type: string
      format: binary

2. 在服務器端處理文件上傳：

const uploadedFile = await request.file('file');
// 處理上傳的文件

💻 使用示例

此倉庫包含一個完整的 Petstore API 服務器示例，可用於測試 OpenAPI MCP 服務器。該示例服務器實現了一個基本的 CRUD API 來管理寵物，是學習使用此工具的理想選擇。有關如何運行示例服務器，請參閱 examples/README.md。

📚 詳細文檔

使用場景

本地開發

• 通過自然對話測試您的 APIs。
• 在編寫代碼之前調試端點。
• 交互式探索 API 功能。

API 集成

• 快速測試第三方 API。
• 在編寫代碼之前進行原型設計。
• 通過對話瞭解新的 API。

文檔

• 提問關於 API 端點的問題。
• 獲取使用端點的示例。
• 理解錯誤條件。

侷限性

• 目前僅支持 OpenAPI v3.1 規範。
• 響應處理針對 JSON/文本進行了優化。
• 文件上傳僅支持本地文件（不支持遠程 URL）。
• 流式響應尚未實現。

🔧 技術細節

開發操作

未完成的任務列在 TODO.md 中。基礎操作如下：

# 安裝依賴項
pnpm install

# 運行測試
pnpm test

# 構建項目
pnpm build

# 將項目鏈接到全局 node_modules 以便使用 npx
npm link

# 現在啟動 Claude Desktop 開始使用

# 在進行更改後再次運行構建以更新 Claude Desktop
pnpm build

# 現在重新啟動 Claude Desktop 使用最新更改

📄 許可證

本項目採用 MIT 許可證。

本項目由 ❤️ 打造，旨在通過自然語言使 API 更具 accessibility。

⚠️ 重要提示

如果您遇到 Claude 崩潰或規範無法使用的問題，請通過我們的 規格清理應用程序 進行處理，該工具會整理一些 OpenAPI 模式以幫助其成為 LLM 可讀格式。