Openapi Schema

🚀 OpenAPI 模型上下文協議服務器

OpenAPI 模型上下文協議（MCP）服務器的主要作用是向 Claude 等大型語言模型（LLMs）公開 OpenAPI 模式信息。藉助該服務器，LLM 能夠通過一系列專用工具探索和理解 OpenAPI 規範。

🚀 快速開始

命令行使用

運行 MCP 服務器並指定特定的模式文件：

# 使用當前目錄中的默認openapi.yaml文件
npx -y mcp-openapi-schema

# 使用相對路徑的特定模式文件
npx -y mcp-openapi-schema ../petstore.json

# 使用絕對路徑的特定模式文件
npx -y mcp-openapi-schema /absolute/path/to/api-spec.yaml

# 顯示幫助信息
npx -y mcp-openapi-schema --help

Claude 桌面集成

要將此 MCP 服務器與 Claude Desktop 一起使用，請編輯 claude_desktop_config.json 配置文件：

{
  "mcpServers": {
    "OpenAPI Schema": {
      "command": "npx",
      "args": ["-y", "mcp-openapi-schema", "/ABSOLUTE/PATH/TO/openapi.yaml"]
    }
  }
}

配置文件位置：

• macOS/Linux: ~/Library/Application Support/Claude/claude_desktop_config.json
• Windows: $env:AppData\Claude\claude_desktop_config.json

Claude Code 集成

要將此 MCP 服務器與 Claude Code CLI 一起使用，請按照以下步驟操作：

1. 將 OpenAPI Schema MCP 服務器添加到 Claude Code

# 基本語法
claude mcp add openapi-schema npx -y mcp-openapi-schema

# 示例帶有特定模式文件
claude mcp add petstore-api npx -y mcp-openapi-schema ~/Projects/petstore.yaml

2. 驗證註冊的服務器

# 列出所有配置的服務器
claude mcp list

# 獲取您OpenAPI模式服務器的詳細信息
claude mcp get openapi-schema

3. 如有需要移除服務器

claude mcp remove openapi-schema

4. 在 Claude Code 中使用工具 配置完成後，您可以在 Claude Code 會話中通過詢問有關 OpenAPI 模式的問題來調用此工具。

✨ 主要特性

• 可通過命令行參數指定，加載任何指定的 OpenAPI 模式文件（JSON 或 YAML）。
• 支持探索 API 路徑、操作、參數和模式。
• 能夠查看請求和響應的詳細模式。
• 可查找組件定義和示例。
• 支持在整個 API 規範中進行搜索。
• 以 YAML 格式獲取響應，便於 LLM 更好地理解。

💻 使用示例

基本用法

命令行使用

# 使用當前目錄中的默認openapi.yaml文件
npx -y mcp-openapi-schema

# 使用相對路徑的特定模式文件
npx -y mcp-openapi-schema ../petstore.json

# 使用絕對路徑的特定模式文件
npx -y mcp-openapi-schema /absolute/path/to/api-spec.yaml

# 顯示幫助信息
npx -y mcp-openapi-schema --help

高級用法

Claude Code 集成

# 基本語法
claude mcp add openapi-schema npx -y mcp-openapi-schema

# 示例帶有特定模式文件
claude mcp add petstore-api npx -y mcp-openapi-schema ~/Projects/petstore.yaml

📚 詳細文檔

MCP 工具

該服務器為 LLM 提供了以下工具以交互 OpenAPI 模式：

• list-endpoints：列出所有 API 路徑及其 HTTP 方法和摘要，以嵌套對象結構顯示。
• get-endpoint：獲取特定端點的詳細信息，包括參數和響應。
• get-request-body：獲取特定端點和方法的請求正文模式。
• get-response-schema：獲取特定端點、方法和狀態碼的響應模式。
• get-path-parameters：獲取特定路徑的參數。
• list-components：列出所有組件（如 schemas, parameters 等）。
• get-component：獲取特定組件的詳細信息。
• list-tags：列出所有標籤。
• get-tag：獲取特定標籤的詳細信息。

示例查詢

列舉所有端點

operation:
  name: list-endpoints
  parameters:
    - name: filter
      type: string
      description: 過濾器條件（可選）

獲取特定端點的詳細信息

operation:
  name: get-endpoint
  parameters:
    - name: endpointId
      type: string
      required: true
      description: 端點ID

獲取請求正文模式

operation:
  name: get-request-body
  parameters:
    - name: requestId
      type: string
      required: true
      description: 請求ID

獲取響應模式

operation:
  name: get-response-schema
  parameters:
    - name: responseId
      type: string
      required: true
      description: 響應ID

示例查詢

curl -X GET "http://localhost:8080/api-docs"

💡 使用建議

• 使用-s或--scope標誌與project（默認）或global指定配置存儲的位置。
• 為不同的 API 添加多個 MCP 服務器，並使用不同名稱。