OpenAPI Schema MCP 服务器

OpenAPI Schema MCP 服务器

结合 LLM 公开并搜索 OpenAPI 模式。即刻列出端点、获取模式,并用 OpenAPI Schema MCP 服务器提升 API 工作流。

“OpenAPI Schema” MCP 服务器有什么作用?

OpenAPI Schema MCP 服务器是一个模型上下文协议(MCP)服务器,专为向大语言模型(LLM,如 Claude)公开 OpenAPI 模式信息而设计。通过结构化访问 OpenAPI 规范,该服务器使 AI 助手能够探索和理解 API,包括其端点、参数、请求与响应模式等。这使开发者和 AI 工具可以查询 API 结构、跨规范搜索、获取详细的模式定义,从而提升 API 集成、文档编写和代码生成等工作流。服务器支持加载 JSON 或 YAML 格式的 OpenAPI 文件,并以 YAML 格式返回结果,以提升 LLM 的理解能力。

提示模板列表

仓库中未记录明确的提示模板。

资源列表

仓库中未描述明确的资源。

工具列表

OpenAPI Schema MCP 服务器为 LLM 提供以下工具:

  • list-endpoints:以嵌套对象结构列出所有 API 路径和其 HTTP 方法及摘要。
  • get-endpoint:获取某一特定端点的详细信息,包括参数和响应。
  • get-request-body:提供特定端点及 HTTP 方法的请求体模式。
  • get-response-schema:返回指定端点、方法和状态码的响应模式。
  • get-path-parameters:获取某一路径的参数信息。
  • list-components:列出所有模式组件(schemas、responses、parameters 等)。
  • get-component:返回某一组件的详细定义。
  • list-security-schemes:列出 API 中所有可用的安全方案。
  • get-examples:获取特定组件或端点的示例。
  • search-schema:在 OpenAPI 规范中的路径、操作和模式中进行搜索。

该 MCP 服务器的应用场景

  • API 探索与文档编写:开发者或 LLM 可快速列出端点、参数和模式,便于编写文档或理解 API 结构。
  • 自动代码生成:通过程序化获取请求和响应模式,工具可以为 API 交互生成客户端库或代码片段。
  • API 测试与验证:测试工具可用该服务器获取参数和示例负载,支持自动或人工 API 测试。
  • 安全审查:分析可用安全方案及其在各端点的实现,确保 API 得到妥善保护。
  • 模式搜索与分析:在大型 API 规范中,快速查找和分析与特定实体或功能相关的模式组件或端点。

如何设置

Windsurf

Windsurf 未提供设置说明。

Claude

  1. 确保已安装 Node.js 和 npx
  2. 找到你的 Claude Desktop 配置文件:
    • macOS/Linux: ~/Library/Application Support/Claude/claude_desktop_config.json
    • Windows: $env:AppData\Claude\claude_desktop_config.json
  3. mcpServers 对象下添加 OpenAPI Schema MCP 服务器:
    {
      "mcpServers": {
        "OpenAPI Schema": {
          "command": "npx",
          "args": ["-y", "mcp-openapi-schema", "/ABSOLUTE/PATH/TO/openapi.yaml"]
        }
      }
    }
    
  4. 保存文件并重启 Claude Desktop。
  5. 在 Claude UI 中确认服务器已可用。

Cursor

Cursor 未提供设置说明。

Cline

Claude Code CLI

  1. 确保已安装 Node.js 和 npx
  2. 添加 OpenAPI Schema MCP 服务器:
    claude mcp add openapi-schema npx -y mcp-openapi-schema
    
    或指定特定的 schema 文件:
    claude mcp add petstore-api npx -y mcp-openapi-schema ~/Projects/petstore.yaml
    
  3. 验证注册:
    claude mcp list
    claude mcp get openapi-schema
    
  4. 可选:移除服务器:
    claude mcp remove openapi-schema
    
  5. 在 Claude Code 会话中使用这些工具。

API 密钥安全

未提供关于 API 密钥安全或环境变量的相关信息。

如何在流程中使用该 MCP

在 FlowHunt 中使用 MCP

要将 MCP 服务器集成到你的 FlowHunt 工作流,首先在流程中添加 MCP 组件并将其连接到你的 AI 代理:

FlowHunt MCP flow

点击 MCP 组件以打开配置面板。在系统 MCP 配置部分,使用以下 JSON 格式填入你的 MCP 服务器信息:

{
  "MCP-name": {
    "transport": "streamable_http",
    "url": "https://yourmcpserver.example/pathtothemcp/url"
  }
}

配置完成后,AI 代理即可将该 MCP 作为工具,访问其全部功能。请记得将 “MCP-name” 替换为你的实际 MCP 服务器名称(如 “github-mcp”、“weather-api” 等),并将 URL 替换为你自己的 MCP 服务器地址。


概览

部分可用性详情/备注
概览
提示模板列表未记录提示模板
资源列表未记录明确资源
工具列表针对 OpenAPI 模式访问记录了 10 个工具
API 密钥安全未提及
采样支持(评估中不重要)未提及

根据现有文档,OpenAPI Schema MCP 服务器高度专注于通过 LLM 进行 OpenAPI 探索,工具集丰富,但在提示、资源、API 密钥处理和高级 MCP 特性上缺乏细节。对于 OpenAPI 场景非常强大;对于更广泛的 MCP 特性,则有限。


MCP 评分

是否有 LICENSE
至少有一个工具
Fork 数9
Star 数30

评分:
我会给该 MCP 服务器打 6/10。它在 OpenAPI 模式探索方面定义明确,工具丰富,但缺乏 MCP 提示模板、明确资源定义、安全实践文档,并未提及根节点支持或采样。缺少 LICENSE 也显著限制了开放协作。

常见问题

什么是 OpenAPI Schema MCP 服务器?

它是一个模型上下文协议(MCP)服务器,为大语言模型(LLM)提供结构化的 OpenAPI 规范访问能力,实现高级 API 探索、文档编写和代码生成。

该服务器提供哪些工具?

它提供了列出端点、获取端点及组件模式、获取请求与响应模式、列出安全方案、搜索模式及获取示例等工具,均可被 LLM 程序化访问。

典型的应用场景有哪些?

包括 API 探索、自动代码生成、API 文档编写、安全审查、模式搜索和分析,以及支持 API 测试工具。

是否支持 JSON 和 YAML 格式的 OpenAPI 文件?

支持,服务器可加载 JSON 和 YAML 格式的 OpenAPI 文件,并以 YAML 格式返回结果,提升 LLM 理解能力。

是否包含提示模板或资源定义?

没有,当前文档未提供提示模板或明确的资源定义。

有关于 API 密钥安全的说明吗?

没有,当前文档未涵盖 API 密钥安全或环境变量相关内容。

有哪些局限性?

缺少提示模板、明确的资源文档、API 密钥处理、采样支持,并且未指定许可证,限制了开放协作。

用 FlowHunt 体验 OpenAPI Schema MCP 服务器

赋能你的 AI 代理自动理解、编写文档并测试 API。将 OpenAPI Schema MCP 服务器集成到你的流程,实现无缝 API 访问与自动化。

了解更多

OpenAPI Schema Explorer MCP 服务器
OpenAPI Schema Explorer MCP 服务器

OpenAPI Schema Explorer MCP 服务器

OpenAPI Schema Explorer MCP 服务器可高效、结构化地访问 OpenAPI/Swagger 规范,将其作为 MCP 资源进行管理,为 AI 助手和开发者搭建起探索、模式验证、自动化等 API 文档桥梁。...

2 分钟阅读
API OpenAPI +5
GraphQL Schema MCP 服务器
GraphQL Schema MCP 服务器

GraphQL Schema MCP 服务器

GraphQL Schema MCP 服务器使 AI 助手和开发者能够以编程方式探索、分析和文档化 GraphQL 模式。它提供了一套强大的工具,实现模式发现、类型检查、字段查找和基于模式的搜索,从而简化 API 集成与文档编写流程。...

2 分钟阅读
GraphQL API +6
OpenAPI MCP 服务器
OpenAPI MCP 服务器

OpenAPI MCP 服务器

OpenAPI MCP 服务器让 AI 助手能够探索和理解 OpenAPI 规范,为开发者和大模型提供详细的 API 上下文、摘要和端点信息,无需直接执行端点。...

2 分钟阅读
API OpenAPI +5