Refgrow MCP Server

@refgrow/mcp

Um servidor Model Context Protocol (MCP) que encapsula a API REST da Refgrow. Isso permite que agentes de IA — Claude Desktop, Cursor, ChatGPT e outros clientes compatíveis com MCP — gerenciem seu programa de afiliados diretamente.

Pré-requisitos

• Node.js 18+
• Uma conta Refgrow com chave de API (gerada nas configurações do projeto)
• As chaves de API começam com rgk_

Instalação

npm install @refgrow/mcp

Ou clone e compile a partir do código-fonte:

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

Configuração

O servidor requer duas variáveis de ambiente:

Variável	Obrigatória	Padrão	Descrição
REFGROW_API_KEY	Sim	--	Sua chave de API da Refgrow (começa com rgk_)
REFGROW_API_URL	Não	https://refgrow.com	URL base da sua instância Refgrow

Como obter uma chave de API

1. Faça login no Refgrow
2. Acesse as configurações do seu projeto
3. Role até a seção API Keys
4. Clique em Generate API Key
5. Copie a chave (ela começa com rgk_ e é exibida apenas uma vez)

Uso com Claude Desktop

Adicione isto ao arquivo de configuração do 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"
      }
    }
  }
}

Ou se instalado globalmente / a partir do código-fonte:

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

Uso com Cursor

Nas configurações do Cursor, adicione um servidor MCP com:

• Nome: refgrow
• Comando: npx -y @refgrow/mcp
• Ambiente: REFGROW_API_KEY=rgk_your_api_key_here

Ou adicione ao .cursor/mcp.json na raiz do seu projeto:

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

Uso com Claude Code

Adicione ao .mcp.json do seu projeto:

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

Ferramentas disponíveis

Afiliados

Ferramenta	Descrição
list_affiliates	Lista todos os afiliados com estatísticas (cliques, inscrições, compras, ganhos)
get_affiliate_details	Obtém detalhes de um afiliado específico por e-mail
create_affiliate	Cria um novo afiliado com código de indicação personalizado opcional
update_affiliate	Atualiza e-mail, código de indicação, status ou slug de parceiro do afiliado
delete_affiliate	Remove um afiliado do projeto

Indicações

Ferramenta	Descrição
list_referrals	Lista usuários indicados, filtráveis por afiliado ou status
get_referral_details	Obtém detalhes de um usuário indicado específico por e-mail
create_referral	Cria manualmente um registro de usuário indicado

Conversões

Ferramenta	Descrição
list_conversions	Lista conversões com filtros por tipo, afiliado, intervalo de datas, status de pagamento
get_conversion	Obtém uma conversão específica por ID
create_conversion	Cria uma conversão (inscrição/compra) com cálculo automático de comissão
update_conversion	Atualiza detalhes da conversão ou marca como paga
delete_conversion	Exclui um registro de conversão

Cupons

Ferramenta	Descrição
list_coupons	Lista códigos de cupom com informações do afiliado
get_coupon	Obtém um cupom específico por ID
create_coupon	Cria um cupom vinculado a um afiliado (com IDs Stripe/LemonSqueezy opcionais)
update_coupon	Atualiza detalhes do cupom
delete_coupon	Exclui um cupom (também remove do Stripe se vinculado)

Exemplos de conversas

Depois de conectado, você pode pedir ao seu agente de IA coisas como:

• "Mostre-me todos os afiliados ativos e seus ganhos"
• "Crie um novo afiliado para partner@example.com com o código de indicação PARTNER2025"
• "Liste todas as conversões não pagas dos últimos 30 dias"
• "Quantas inscrições tivemos por meio de indicações de afiliados neste mês?"
• "Crie um código de cupom SAVE20 vinculado ao ID de afiliado 42"
• "Marque a conversão #123 como paga"
• "Desative o afiliado com e-mail old-partner@example.com"

Desenvolvimento

# 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

Documentação

Guia completo de configuração com exemplos e solução de problemas: https://refgrow.com/docs/mcp-server

Referência da API REST (para integração HTTP direta): https://refgrow.com/docs/api-reference

Licença

MIT