返回 MCP 目录
public公开dns本地运行

OpenAPI Proxy

一个为Claude/Cursor设计的OpenAPI规范探索服务器,通过三步流程帮助用户搜索和理解API文档。

article

README

🚀 OpenAPI MCP 服务器

OpenAPI MCP 服务器是一个专门为 Claude/Cursor 设计的 Model Context Protocol (MCP) 服务器,可通过 oapis.org 搜索和探索 OpenAPI 规范,为用户提供 API 相关的上下文信息。

🚀 快速开始

OpenAPI MCP 服务器通过以下三个步骤工作:

  1. 确定所需的 OpenAPI 标识符。
  2. 请求该标识符的简明摘要。
  3. 确定具体的端点,并详细解释其功能(同样以简明语言呈现)。

安装完成后,你可以让 Claude 执行以下操作:

  • "查找关于 Stripe API 的信息"
  • "解释如何使用 GitHub API 的仓库端点"

Claude 将通过 MCP 服务器:

  1. 首先获取请求的 API 概述。
  2. 然后根据需要检索特定的操作细节。

✨ 主要特性

  • 获取任何 OpenAPI 规范的概述。
  • 检索特定 API 操作的详细信息。
  • 支持 JSON 和 YAML 格式。
  • 已在 Claude Desktop 和 Cursor 上测试过。

📦 安装指南

通过 Smithery 安装

要通过 Smithery 自动安装 openapi-mcp-server:

npx -y @smithery/cli install @janwilmake/openapi-mcp-server --client claude

通过 npx 安装

运行并按照提示操作:

npx openapi-mcp-server@latest init

📚 详细文档

相关链接

  • 示例:https://x.com/janwilmake/status/1903497808134496583
  • HN 讨论线程:https://news.ycombinator.com/item?id=43447278
  • OpenAPISearch:https://github.com/janwilmake/openapisearch
  • OAPIS:https://github.com/janwilmake/oapis

重要提示

⚠️ 重要提示

OpenAPI MCP 已经找到新主人并从 v1.2 迁移到了 v2,与之前的版本有所不同。你仍然可以访问任何在 v2.0.0 之前的版本及其 README 文件 此处

OpenAPI MCP v2 是一个正在开发中的版本,专注于 API 探索和提供上下文信息。它目前不支持直接执行端点作为工具,因为身份验证尚未通过 MCP 解决。不过,对于代码生成非常有用!

预期会有 bug。欢迎贡献者 私信

要求

  • Node.js >= 16.17.0
  • Claude Desktop、Cursor 或其他任何 MCP 客户端。

📄 许可证

本项目采用 MIT 许可证。

help

运行方式说明

cloud

托管运行

托管运行通常表示这个 MCP Server 由服务方环境承载,用户一般按页面提供的连接方式或授权流程接入,不需要在本地长期启动一个 MCP 进程

  1. 打开服务方连接页
  2. 完成授权或复制端点
  3. 在 MCP 客户端中连接
terminal

本地运行 / 其它方式

本地运行通常需要用户在自己的电脑或服务器上安装依赖,把 server_config 复制到 MCP 客户端,并按 env_schema 补齐环境变量、密钥或其它配置

  1. 复制 server_config
  2. 安装所需依赖
  3. 补齐环境变量后重启客户端