Refgrow MCP Server
Servidor MCP para gestionar programas de afiliados y referidos. Realiza seguimiento de referidos, gestiona afiliados, procesa conversiones y maneja pagos a través de asistentes de IA.
Documentación
@refgrow/mcp
Un servidor de Model Context Protocol (MCP) que envuelve la API REST de Refgrow. Esto permite que agentes de IA — Claude Desktop, Cursor, ChatGPT y otros clientes compatibles con MCP — gestionen tu programa de afiliados directamente.
Requisitos previos
- Node.js 18+
- Una cuenta de Refgrow con una clave de API (generada en la configuración del proyecto)
- Las claves de API comienzan con
rgk_
Instalación
npm install @refgrow/mcp
O clona y compila desde el código fuente:
git clone https://github.com/refgrow/refgrow-mcp.git
cd refgrow-mcp
npm install
npm run build
Configuración
El servidor requiere dos variables de entorno:
| Variable | Obligatoria | Predeterminada | Descripción |
|---|---|---|---|
REFGROW_API_KEY | Sí | -- | Tu clave de API de Refgrow (comienza con rgk_) |
REFGROW_API_URL | No | https://refgrow.com | URL base de tu instancia de Refgrow |
Cómo obtener una clave de API
- Inicia sesión en Refgrow
- Ve a la configuración de tu proyecto
- Desplázate hasta la sección API Keys
- Haz clic en Generate API Key
- Copia la clave (comienza con
rgk_y solo se muestra una vez)
Uso con Claude Desktop
Añade esto al archivo de configuración de 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"
}
}
}
}
O si está instalado globalmente / desde el código fuente:
{
"mcpServers": {
"refgrow": {
"command": "node",
"args": ["/path/to/packages/mcp-server/dist/index.js"],
"env": {
"REFGROW_API_KEY": "rgk_your_api_key_here"
}
}
}
}
Uso con Cursor
En la configuración de Cursor, añade un servidor MCP con:
- Nombre: refgrow
- Comando:
npx -y @refgrow/mcp - Entorno:
REFGROW_API_KEY=rgk_your_api_key_here
O añádelo a .cursor/mcp.json en la raíz de tu proyecto:
{
"mcpServers": {
"refgrow": {
"command": "npx",
"args": ["-y", "@refgrow/mcp"],
"env": {
"REFGROW_API_KEY": "rgk_your_api_key_here"
}
}
}
}
Uso con Claude Code
Añádelo al .mcp.json de tu proyecto:
{
"mcpServers": {
"refgrow": {
"command": "npx",
"args": ["-y", "@refgrow/mcp"],
"env": {
"REFGROW_API_KEY": "rgk_your_api_key_here"
}
}
}
}
Herramientas disponibles
Afiliados
| Herramienta | Descripción |
|---|---|
list_affiliates | Lista todos los afiliados con estadísticas (clics, registros, compras, ganancias) |
get_affiliate_details | Obtiene detalles de un afiliado específico por correo electrónico |
create_affiliate | Crea un nuevo afiliado con un código de referencia opcional personalizado |
update_affiliate | Actualiza el correo electrónico, código de referencia, estado o slug de socio del afiliado |
delete_affiliate | Elimina un afiliado del proyecto |
Referidos
| Herramienta | Descripción |
|---|---|
list_referrals | Lista usuarios referidos, filtrables por afiliado o estado |
get_referral_details | Obtiene detalles de un usuario referido específico por correo electrónico |
create_referral | Crea manualmente un registro de usuario referido |
Conversiones
| Herramienta | Descripción |
|---|---|
list_conversions | Lista conversiones con filtros por tipo, afiliado, rango de fechas, estado de pago |
get_conversion | Obtiene una conversión específica por ID |
create_conversion | Crea una conversión (registro/compra) con cálculo automático de comisión |
update_conversion | Actualiza los detalles de una conversión o márcala como pagada |
delete_conversion | Elimina un registro de conversión |
Cupones
| Herramienta | Descripción |
|---|---|
list_coupons | Lista códigos de cupón con información del afiliado |
get_coupon | Obtiene un cupón específico por ID |
create_coupon | Crea un cupón vinculado a un afiliado (con IDs opcionales de Stripe/LemonSqueezy) |
update_coupon | Actualiza los detalles de un cupón |
delete_coupon | Elimina un cupón (también lo elimina de Stripe si está vinculado) |
Ejemplos de conversaciones
Una vez conectado, puedes pedirle a tu agente de IA cosas como:
- "Muéstrame todos los afiliados activos y sus ganancias"
- "Crea un nuevo afiliado para partner@example.com con el código de referencia PARTNER2025"
- "Lista todas las conversiones no pagadas de los últimos 30 días"
- "¿Cuántos registros obtuvimos a través de referidos de afiliados este mes?"
- "Crea un código de cupón SAVE20 vinculado al ID de afiliado 42"
- "Marca la conversión #123 como pagada"
- "Desactiva el afiliado con el correo electrónico old-partner@example.com"
Desarrollo
# 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
Documentación
Guía completa de configuración con ejemplos y solución de problemas: https://refgrow.com/docs/mcp-server
Referencia de la API REST (para integración HTTP directa): https://refgrow.com/docs/api-reference
Licencia
MIT