Refgrow MCP Server

@refgrow/mcp

一个封装 Refgrow REST API 的 Model Context Protocol（MCP）服务。它允许 AI Agent（Claude Desktop、Cursor、ChatGPT 及其他兼容 MCP 的客户端）直接管理你的联盟营销计划。

先决条件

• Node.js 18+
• 拥有 API 密钥的 Refgrow 账户（在项目设置中生成）
• API 密钥以 rgk_ 开头

安装

npm install @refgrow/mcp

或者克隆源代码并构建：

git clone https://github.com/refgrow/refgrow-mcp.git
cd refgrow-mcp
npm install
npm run build

配置

服务需要两个环境变量：

变量	必需	默认值	描述
REFGROW_API_KEY	是	--	你的 Refgrow API 密钥（以 rgk_ 开头）
REFGROW_API_URL	否	https://refgrow.com	Refgrow 实例的基础 URL

获取 API 密钥

1. 登录 Refgrow
2. 前往项目设置
3. 向下滚动到 API Keys 部分
4. 点击 Generate API Key
5. 复制密钥（以 rgk_ 开头，且只会显示一次）

在 Claude Desktop 中使用

将以下内容添加到 Claude Desktop 配置文件：

macOS： ~/Library/Application Support/Claude/claude_desktop_config.json Windows： %APPDATA%\Claude\claude_desktop_config.json

{
  "mcpServers": {
    "refgrow": {
      "command": "npx",
      "args": ["-y", "@refgrow/mcp"],
      "env": {
        "REFGROW_API_KEY": "rgk_your_api_key_here"
      }
    }
  }
}

如果是全局安装或从源代码安装，也可以使用：

{
  "mcpServers": {
    "refgrow": {
      "command": "node",
      "args": ["/path/to/packages/mcp-server/dist/index.js"],
      "env": {
        "REFGROW_API_KEY": "rgk_your_api_key_here"
      }
    }
  }
}

在 Cursor 中使用

在 Cursor 设置中添加 MCP 服务：

• 名称： refgrow
• 命令： npx -y @refgrow/mcp
• 环境： REFGROW_API_KEY=rgk_your_api_key_here

或者将以下内容添加到项目根目录的 .cursor/mcp.json：

{
  "mcpServers": {
    "refgrow": {
      "command": "npx",
      "args": ["-y", "@refgrow/mcp"],
      "env": {
        "REFGROW_API_KEY": "rgk_your_api_key_here"
      }
    }
  }
}

在 Claude Code 中使用

将以下内容添加到项目的 .mcp.json：

{
  "mcpServers": {
    "refgrow": {
      "command": "npx",
      "args": ["-y", "@refgrow/mcp"],
      "env": {
        "REFGROW_API_KEY": "rgk_your_api_key_here"
      }
    }
  }
}

可用工具

联盟营销人员

工具	描述
list_affiliates	列出所有联盟营销人员及其统计数据（点击、注册、购买、收入）
get_affiliate_details	按电子邮件地址获取指定联盟营销人员的详细信息
create_affiliate	创建新的联盟营销人员，可选自定义推荐代码
update_affiliate	更新联盟营销人员的电子邮件地址、推荐代码、状态或合作伙伴标识
delete_affiliate	从项目中移除联盟营销人员

推荐

工具	描述
list_referrals	列出被推荐用户，可按联盟营销人员或状态筛选
get_referral_details	按电子邮件地址获取指定被推荐用户的详细信息
create_referral	手动创建被推荐用户记录

转化

工具	描述
list_conversions	列出转化，可按类型、联盟营销人员、日期范围和付款状态筛选
get_conversion	按 ID 获取指定转化
create_conversion	创建转化（注册/购买），并自动计算佣金
update_conversion	更新转化详情或将其标记为已付款
delete_conversion	删除转化记录

优惠券

工具	描述
list_coupons	列出优惠券代码及联盟营销人员信息
get_coupon	按 ID 获取指定优惠券
create_coupon	创建关联到联盟营销人员的优惠券（可选 Stripe/LemonSqueezy ID）
update_coupon	更新优惠券详情
delete_coupon	删除优惠券（如果已关联 Stripe，也会从 Stripe 中移除）

对话示例

连接后，你可以向 AI Agent 提出以下请求：

• “显示所有活跃的联盟营销人员及其收入”
• “为 [email protected] 创建新的联盟营销人员，推荐代码为 PARTNER2025”
• “列出过去 30 天内所有未付款的转化”
• “本月通过联盟推荐获得了多少注册？”
• “创建代码为 SAVE20、关联到联盟营销人员 ID 42 的优惠券”
• “将转化 #123 标记为已付款”
• “停用电子邮件地址为 [email protected] 的联盟营销人员”

开发

# Install dependencies
npm install

# Build
npm run build

# Watch mode for development
npm run dev

# Run the server (requires REFGROW_API_KEY env var)
REFGROW_API_KEY=rgk_your_key npm start

文档

完整的设置指南，包含示例和故障排除： https://refgrow.com/docs/mcp-server

REST API 参考（用于直接 HTTP 集成）： https://refgrow.com/docs/api-reference

许可证

MIT