关键词

OpenAPIAPI探索ClaudeCursoroapis.org

使用说明

项目简介

OpenAPI 探索 MCP 服务器（openapi-mcp-server）是一个基于 Model Context Protocol (MCP) 构建的后端服务，旨在帮助用户在 Claude、Cursor 等支持 MCP 协议的客户端中搜索和探索 OpenAPI 规范。它利用 oapis.org 提供的 OpenAPI 规范信息，为用户提供 API 的概览和操作详情，从而辅助代码生成和 API 理解。请注意，当前版本 (v2) 仅支持 OpenAPI 规范的探索和上下文提供，尚不支持直接执行 API 端点。

主要功能点

  • OpenAPI 规范概览：获取指定 OpenAPI 规范的总体介绍，帮助用户快速了解 API 的功能和结构。
  • OpenAPI 操作详情：检索特定 API 操作的详细信息，例如请求参数、响应格式等，辅助用户理解 API 的使用方法。
  • 支持 JSON 和 YAML 格式：可以以 JSON 或 YAML 格式返回 OpenAPI 规范信息，满足不同用户的偏好。
  • 与 Claude 和 Cursor 集成：已测试与 Claude Desktop 和 Cursor 等 MCP 客户端的兼容性。

安装步骤

  1. 安装 Node.js: 确保您的系统已安装 Node.js (>= 16.17.0)。您可以从 Node.js 官网 下载并安装。
  2. 安装 MCP 服务器: 打开终端，运行以下命令安装 'openapi-mcp-server'： 
    npx slop-mcp init
    按照提示完成安装过程。此命令会自动将 MCP 服务器配置到 Claude Desktop (如果已安装)。

服务器配置

MCP 服务器配置信息用于告知 MCP 客户端（如 Claude、Cursor）如何连接和使用该服务器。'openapi-mcp-server' 通过 'npx slop-mcp init' 命令自动配置 Claude Desktop。如果您需要手动配置或其他 MCP 客户端，以下是配置信息示例：

{
  "mcpServers": {
    "slop": {
      "command": "node",  // 启动服务器的命令，这里使用 Node.js 运行
      "args": [            // 启动服务器命令的参数
        "/path/to/openapi-mcp-server/index.js",  // 指向 openapi-mcp-server 仓库中 index.js 文件的绝对路径。请替换为您的实际路径。
        "run"             // 运行 'run' 命令启动服务器
      ]
    }
  }
}

请注意：

  • '/path/to/openapi-mcp-server/index.js' 需要替换为您 'openapi-mcp-server' 仓库 'index.js' 文件的实际绝对路径。例如，如果您将仓库克隆到用户目录下的 'openapi-mcp-server' 文件夹，并且您的用户名是 'user'，则路径可能类似于 '/Users/user/openapi-mcp-server/index.js' (macOS/Linux) 或 'C:\Users\user\openapi-mcp-server\index.js' (Windows)。
  • 不同的 MCP 客户端配置方式可能略有不同，请参考您使用的 MCP 客户端的文档进行配置。

基本使用方法

成功安装和配置 MCP 服务器后，您可以在 Claude 或 Cursor 中通过自然语言指令来探索 OpenAPI 规范。以下是一些使用示例：

  • 在 Claude 或 Cursor 中提问：

    • "Find information about the Stripe API" (查找关于 Stripe API 的信息)
    • "Explain how to use the GitHub API's repository endpoints" (解释如何使用 GitHub API 的仓库端点)
    • "Search for OpenAPI specification for Pet Store API" (搜索 Pet Store API 的 OpenAPI 规范)

  • Claude 或 Cursor 的工作流程：

    1. 客户端接收到您的指令后，会调用 OpenAPI 探索 MCP 服务器。
    2. MCP 服务器会根据您的指令，在 oapis.org 上搜索相关的 OpenAPI 规范信息。
    3. MCP 服务器将 API 概览或操作详情返回给客户端。
    4. Claude 或 Cursor 将返回的信息展示给您，帮助您理解和使用 API。

卸载

要卸载 'openapi-mcp-server'，您需要手动从 Claude Desktop 的配置文件中移除相关的 MCP 服务器配置项。配置文件的路径通常为：

  • macOS: '~/Library/Application Support/Claude/claude_desktop_config.json'
  • Windows: '%APPDATA%\Claude\claude_desktop_config.json'

打开配置文件，找到 'mcpServers' 部分，删除名为 'slop' 的配置项并保存文件。

信息

分类

网页与API

访问项目