OpenAPI Schema 模型上下文协议服务器

一个模型上下文协议 (MCP) 服务器，它向大型语言模型 (LLM)，如 Claude，公开 OpenAPI schema 信息。此服务器允许 LLM 通过一组专用工具来探索和理解 OpenAPI 规范。

功能

• 加载通过命令行参数指定的任何 OpenAPI schema 文件（JSON 或 YAML）
• 探索 API 路径、操作、参数和 schema
• 查看详细的请求和响应 schema
• 查找组件定义和示例
• 搜索整个 API 规范
• 以 YAML 格式获取响应，以便更好地被 LLM 理解

用法

命令行

使用特定的 schema 文件运行 MCP 服务器：

# 使用当前目录中的默认 openapi.yaml
npx -y mcp-openapi-schema

# 使用特定的 schema 文件（相对路径）
npx -y mcp-openapi-schema ../petstore.json

# 使用特定的 schema 文件（绝对路径）
npx -y mcp-openapi-schema /absolute/path/to/api-spec.yaml

# 显示帮助
npx -y mcp-openapi-schema --help

Claude Desktop 集成

要将此 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
   
   # 带有特定 schema 的示例
   claude mcp add petstore-api npx -y mcp-openapi-schema ~/Projects/petstore.yaml
   

2. 验证 MCP 服务器是否已注册

   # 列出所有已配置的服务器
   claude mcp list
   
   # 获取 OpenAPI schema 服务器的详细信息
   claude mcp get openapi-schema
   

3. 如果需要，删除服务器

   claude mcp remove openapi-schema
   

4. 在 Claude Code 中使用该工具

   配置完成后，您可以通过询问有关 OpenAPI schema 的问题，在 Claude Code 会话中调用该工具。

提示：

• 使用 -s 或 --scope 标志以及 project（默认）或 global 来指定配置的存储位置
• 为不同的 API 添加具有不同名称的多个 MCP 服务器

MCP 工具

该服务器提供以下工具，供 LLM 与 OpenAPI schema 交互：

• list-endpoints: 列出所有 API 路径及其 HTTP 方法，并在嵌套对象结构中提供摘要
• get-endpoint: 获取有关特定端点的详细信息，包括参数和响应
• get-request-body: 获取特定端点和方法的请求正文 schema
• get-response-schema: 获取特定端点、方法和状态代码的响应 schema
• get-path-parameters: 获取特定路径的参数
• list-components: 列出所有 schema 组件（schemas、responses、parameters 等）
• get-component: 获取特定组件的详细定义
• list-security-schemes: 列出所有可用的安全方案
• get-examples: 获取特定组件或端点的示例
• search-schema: 搜索路径、操作和 schemas

示例

可以尝试的示例查询：

此 API 中有哪些可用的端点？
显示 POST /pets 端点的详细信息。
GET /pets/{petId} 端点接受哪些参数？
创建新宠物所需的请求正文 schema 是什么？
我将从 DELETE /pets/{petId} 端点获得什么响应？
此 API 中定义了哪些 schemas？
显示 Pet schema 的定义。
此 API 有哪些可用的安全方案？
是否有通过 ID 获取宠物的示例响应？
在此 API 中搜索与“user”相关的任何内容。