OpenAPI Schema Model Context Protocol Server

OpenAPI Schema Model Context Protocol Server

site icon
2025.03.13 24
JavaScriptOpenAPI 规范API 探索开发效率
mcp-openapi-schema 是一个 Model Context Protocol (MCP) 服务器,专门用于向大型语言模型(如 Claude)暴露 OpenAPI 模式信息。该服务器允许 LLM 通过一组专用工具探索和理解 OpenAPI 规范。
View on GitHub

Overview

基本能力

产品定位

mcp-openapi-schema 是一个专门用于处理 OpenAPI 规范的 MCP 服务器,旨在帮助大型语言模型理解和探索 API 规范。

核心功能

  • 加载任何 OpenAPI 模式文件(JSON 或 YAML)
  • 探索 API 路径、操作、参数和模式
  • 查看详细的请求和响应模式
  • 查找组件定义和示例
  • 在整个 API 规范中搜索
  • 以 YAML 格式获取响应,以便更好地理解 LLM

适用场景

  • 开发者在开发 API 时需要快速了解 API 规范
  • 大型语言模型需要理解和使用 OpenAPI 规范
  • 团队协作时需要共享和探索 API 规范

工具列表

  • list-endpoints: 列出所有 API 路径及其 HTTP 方法和摘要
  • get-endpoint: 获取特定端点的详细信息,包括参数和响应
  • get-request-body: 获取特定端点和方法的请求体模式
  • get-response-schema: 获取特定端点、方法和状态代码的响应模式
  • get-path-parameters: 获取特定路径的参数
  • list-components: 列出所有模式组件(模式、响应、参数等)
  • get-component: 获取特定组件的详细定义
  • list-security-schemes: 列出所有可用的安全方案
  • get-examples: 获取特定组件或端点的示例
  • search-schema: 在路径、操作和模式中搜索

使用教程

使用依赖

确保已安装 Node.js 和 npm。

安装教程

运行以下命令启动 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

调试方式

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

```bash # 列出所有配置的服务器 claude mcp list

# 获取 OpenAPI 模式服务器的详细信息 claude mcp get openapi-schema ```

  1. 使用工具在 Claude Code 会话中提问关于 OpenAPI 模式的问题。

常见问题解答

  • 如何添加多个 MCP 服务器? 使用不同的名称添加多个 MCP 服务器。

  • 如何指定配置存储位置? 使用 -s--scope 标志与 project(默认)或 global 一起指定配置存储位置。

  • 如何删除服务器? 使用 claude mcp remove openapi-schema 命令删除服务器。

许可证

None