关键词

健身房管理体育科技API 工具AI 应用集成数据访问

项目简介

PushPress TypeScript SDK 不仅是一个用于与 PushPress 健身房管理平台 API 交互的客户端库，它还包含一个可安装的 Model Context Protocol (MCP) 服务器实现。这个 MCP 服务器的核心作用是将 PushPress SDK 中定义的方法暴露为 AI 应用程序可以调用的工具，从而允许 AI 应用安全、便捷地访问和操作 PushPress 平台的数据和功能。

主要功能点

通过将 SDK 方法暴露为 MCP 工具，此服务器实现了以下主要功能（通过 AI 应用程序调用）：

  • 客户管理: 创建新客户、列出所有客户、获取特定客户的详细信息，以及管理客户归因信息（如创建、列出、获取归因记录）。
  • 签到管理: 获取总签到次数、列出特定类型的签到记录（课程、活动、预约、开放时段）以及获取详细签到信息。
  • 课程与活动: 获取特定课程或活动的详细信息，列出课程类型并获取其详细信息。
  • 订阅与计划: 获取客户的订阅（Enrollment）详细信息，获取计划（Plan）详细信息。
  • 消息通知: 发送电子邮件、推送通知、实时消息和短信（需满足特定条件）。
  • API 密钥管理: 列出和获取 API 密钥，以及创建和撤销 API 密钥。
  • Webhook 管理: 创建、列出、获取、更新、删除、激活和停用 Webhook，以及轮换 Webhook 签名密钥。

安装步骤

该 MCP 服务器作为 PushPress TypeScript SDK 包的一部分发布。您可以通过以下任一包管理器进行安装：

使用 npm:

npm add @pushpress/pushpress

使用 pnpm:

pnpm add @pushpress/pushpress

使用 Bun:

bun add @pushpress/pushpress

使用 Yarn:

yarn add @pushpress/pushpress zod
# 注意：Yarn 不会自动安装 peer dependencies，您需要手动安装 zod。

运行要求: 要作为 MCP 服务器运行，需要 Node.js v20 或更高版本。

服务器配置

MCP 服务器不是独立运行的后台服务，而是由支持 MCP 协议的客户端应用（如某些 AI 桌面应用或 IDE）启动和管理的进程。您需要在您的 MCP 客户端应用的配置文件中添加对此 PushPress MCP 服务器的引用。

以下是常见的 MCP 客户端配置示例，您需要根据您的客户端类型修改配置文件（例如 'claude_desktop_config.json' 或 '.cursor/mcp.json'）：

{
  "mcpServers": {
    "PushPress": {
      // 用于启动 MCP 服务器进程的命令
      "command": "npx",
      // 传递给 command 的参数列表
      "args": [
        "-y", "--package", "@pushpress/pushpress",
        "--",
        "mcp", "start",
        // PushPress API 密钥，用于认证
        "--api-key", "...",
        // 可选参数，指定操作的公司 ID，也可在调用工具时单独指定
        "--company-id", "..."
      ]
    }
  }
}

请将 '...' 替换为您的实际 PushPress API 密钥和公司 ID。具体的配置路径和格式请参考您使用的 MCP 客户端应用的文档。

基本使用方法

配置完成后，您的 MCP 客户端应用（例如 AI 助手）将能够检测到并与 PushPress MCP 服务器建立连接。AI 应用可以发现服务器暴露的工具（即 PushPress SDK 的各种方法），并在需要访问 PushPress 平台的数据或执行操作时调用这些工具。

例如，当您在支持 MCP 的 AI 应用中提出与客户相关的问题时，AI 可以自动识别并调用 PushPress MCP 服务器提供的“列出客户”或“获取客户详情”等工具来获取所需信息，并将其用于生成回答。

您可以在 MCP 客户端的界面中查看到服务器暴露的工具列表及其描述（通常基于 SDK 方法的文档）。

信息

分类

AI与计算

访问项目