OpenAPI MCP Server

OpenAPI MCP Server

site icon
2025.04.16 503
JavaScriptAPI 探索代码生成开发效率
OpenAPI MCP Server 是一个为 Claude/Cursor 设计的模型上下文协议(MCP)服务器,用于通过 oapis.org 搜索和探索 OpenAPI 规范。它通过三步流程帮助用户理解和使用 OpenAPI 规范:识别所需的 OpenAPI 标识符、获取简单语言的摘要、确定所需的端点并了解其工作原理。该服务器适用于 API 探索和代码生成,但不支持直接执行端点。
View on GitHub

Overview

基本能力

产品定位

OpenAPI MCP Server 是一个用于探索和理解 OpenAPI 规范的 MCP 服务器,特别适用于开发者在代码生成和 API 探索场景中使用。

核心功能

  • 获取任何 OpenAPI 规范的概述
  • 检索特定 API 操作的详细信息
  • 支持 JSON 和 YAML 格式
  • 与 Claude Desktop 和 Cursor 兼容

适用场景

  • API 探索和理解
  • 代码生成
  • 开发者在需要快速了解和使用 OpenAPI 规范时的辅助工具

工具列表

  • OpenAPISearch: 用于搜索 OpenAPI 规范的工具
  • OAPIS: 提供 OpenAPI 规范的摘要和详细信息

常见问题解答

  • OpenAPI MCP v2 是一个进行中的项目,可能存在一些 bug
  • 目前不支持直接执行端点,因为认证问题尚未解决
  • 欢迎贡献者参与,可以通过 DM 联系开发者

使用教程

使用依赖

  • Node.js >= 16.17.0
  • Claude Desktop, Cursor 或其他 MCP 客户端

安装教程

运行以下命令并按照指示操作:

npx openapi-mcp-server@latest init

调试方式

安装完成后,可以在 Claude 中询问类似以下问题来进行调试: - "Find information about the Stripe API" - "Explain how to use the GitHub API's repository endpoints" Claude 将使用 MCP 服务器首先获取请求的 API 的概述,然后根据需要检索特定的操作详细信息。

许可证

该项目遵循 MIT 开源许可条款,请参阅 MIT 了解完整条款。