使用说明

项目简介

本仓库是基于 Petstore OpenAPI 规范生成的 SDK,同时也是一个可安装的 MCP 服务器。它将 Petstore API 的各种方法作为工具暴露出来,供 AI 应用(如 LLM 客户端)调用。

主要功能点

  • 工具 (Tools) 注册与执行: 将 Petstore API 的操作(如添加宠物、查询订单、创建用户等)注册为 MCP 工具,LLM 客户端可以通过调用这些工具来访问和操作宠物商店的数据。
  • 基于 OpenAPI 规范: SDK 和 MCP 服务器均基于 OpenAPI 3.1 规范自动生成,保证了 API 接口的完整性和一致性。
  • 多种传输协议支持: MCP 服务器默认支持 Stdio 传输协议,同时也支持 SSE 协议,可以灵活地与不同的 MCP 客户端集成。
  • 可配置的服务器参数: 启动 MCP 服务器时,可以配置端口号、日志级别、API 密钥等参数,以满足不同的运行环境和安全需求。

安装步骤

  1. 环境要求: 确保已安装 Node.js v20 或更高版本。
  2. 安装 SDK: 使用 npm, pnpm, bun 或 yarn 等包管理器安装 SDK 包 'meep-moop' (仓库中实际使用的包名,README 中有提及)。例如使用 npm 安装:
    npm add meep-moop

服务器配置

MCP 服务器需要配置到 MCP 客户端中才能使用。以下分别以 Claude 和 Cursor 客户端为例,说明配置方法。

Claude 客户端配置

  1. 打开 Claude 客户端的配置文件 'claude_desktop_config.json'。
  2. 在 'mcpServers' 字段下添加一个新的服务器配置,配置内容如下:
    {
      "mcpServers": {
        "Petstore": {  // server name: 用户自定义,在 Claude 客户端中显示的服务器名称
          "command": "npx",  // 启动命令: Node.js 包执行器
          "args": [  // 启动参数
            "-y",  // 自动确认安装
            "--package", "meep-moop",  // 指定要安装和执行的 npm 包 (Petstore SDK)
            "--",  // 分隔 npm 参数和应用参数
            "mcp", "start",  // 执行 'meep-moop' 包中的 'mcp' 命令,并使用 'start' 子命令启动 MCP 服务器
            "--api-key", "YOUR_API_KEY"  // 服务器启动参数,设置 API 密钥 (请替换为你的实际 API 密钥)
          ]
        }
      }
    }
    参数说明:
    • 'server name': 'Petstore' (用户自定义,服务器名称)
    • 'command': 'npx' (Node.js 包执行器)
    • 'args':
      • '-y': 自动确认安装
      • '--package meep-moop': 指定要安装和执行的 npm 包 (Petstore SDK)
      • '--': 分隔 npm 参数和应用参数
      • 'mcp start': 执行 'meep-moop' 包中的 'mcp' 命令,并使用 'start' 子命令启动 MCP 服务器
      • '--api-key YOUR_API_KEY': 服务器启动参数,设置 API 密钥 (请替换为你的实际 API 密钥)

Cursor 客户端配置

  1. 打开 Cursor 客户端设置,找到 'Features > MCP Servers' 选项。
  2. 点击 'Add new MCP server' 添加新的服务器配置,配置内容如下:
    • Name: 'Petstore' (用户自定义,服务器名称)
    • Type: 'command'
    • Command: 'npx -y --package meep-moop -- mcp start --api-key YOUR_API_KEY' (请替换为你的实际 API 密钥)

基本使用方法

完成 MCP 服务器配置后,在 MCP 客户端中即可使用 Petstore API 提供的工具。工具名称通常与 API 操作名称对应,例如:

  • 'pet-pets-store-monday': 更新宠物信息
  • 'store-get-inventory': 获取商店库存
  • 'user-login-user': 用户登录

具体可用的工具列表请参考仓库 README.md 文件中 "Available Resources and Operations" 和 "Standalone functions" 章节。

获取更多帮助

如需了解更多服务器启动参数或高级配置,请在终端中运行以下命令查看帮助信息:

npx -y --package meep-moop -- mcp start --help

信息

分类

网页与API