Skip to main content

​
O que é MCP?

O Model Context Protocol (MCP) é um padrão aberto que permite que agentes de IA se conectem a ferramentas e serviços externos. Com o MCP Server da Garu, seu agente pode criar cobranças, consultar transações e gerenciar clientes diretamente pelo chat. Por que isso importa?
  • Seu agente de IA entende o contexto do seu código e cria cobranças sem sair do editor
  • Menos copy-paste de documentação, mais produtividade
  • Funciona com Claude Code, Cursor, Codex, Windsurf e qualquer cliente MCP
Pré-requisito: Você precisa de uma chave de API. Veja como obter em Autenticação.

​
Instalação

Escolha sua ferramenta e siga as instruções:
1
Instale o servidor MCP
2
Claude Code
claude mcp add garu -- npx -y @garuhq/mcp
Depois, defina a variável de ambiente GARU_API_KEY no seu projeto ou shell:
export GARU_API_KEY=YOUR_API_KEY
Cursor
Adicione ao arquivo .cursor/mcp.json do seu projeto:
{
  "mcpServers": {
    "garu": {
      "command": "npx",
      "args": ["-y", "@garuhq/mcp"],
      "env": {
        "GARU_API_KEY": "YOUR_API_KEY"
      }
    }
  }
}
Codex
codex mcp add garu --env GARU_API_KEY=YOUR_API_KEY -- npx -y @garuhq/mcp
Windsurf
Adicione ao arquivo .windsurf/mcp.json do seu projeto:
{
  "mcpServers": {
    "garu": {
      "command": "npx",
      "args": ["-y", "@garuhq/mcp"],
      "env": {
        "GARU_API_KEY": "YOUR_API_KEY"
      }
    }
  }
}
3
Teste a conexão
4
Peça ao agente para executar um comando simples:
5
Liste minhas cobranças recentes
6
Se a conexão estiver funcionando, o agente vai usar a ferramenta list_charges e retornar os resultados.

​
Transportes

O MCP Server da Garu suporta dois modos de transporte:
TransporteDescriçãoQuando usar
stdio (padrão)Comunicação via entrada/saída padrãoIDEs locais (Claude Code, Cursor, Codex, Windsurf)
HTTPServidor HTTP com Server-Sent EventsIntegrações remotas, servidores web
O modo stdio é o padrão e funciona automaticamente com os comandos de instalação acima. Para usar o modo HTTP: 
npx @garuhq/mcp --transport http --port 3100

​
Catálogo de Ferramentas

O servidor expõe 11 ferramentas que o agente pode usar:

​
Cobranças

FerramentaDescrição
create_chargeCria uma nova cobrança (PIX, Cartão ou Boleto)
list_chargesLista cobranças com filtros
get_chargeConsulta detalhes de uma cobrança
refund_chargeReembolsa uma cobrança
cancel_chargeCancela uma cobrança pendente
get_charge_statusConsulta o status de uma cobrança

​
Clientes

FerramentaDescrição
create_customerCadastra um novo cliente
list_customersLista clientes com filtros
get_customerConsulta detalhes de um cliente
update_customerAtualiza dados de um cliente
delete_customerRemove um cliente

​
Exemplos de Prompts

Experimente pedir ao seu agente: 
Crie uma cobrança PIX de R$49,90 para o cliente joao@email.com

Liste todas as cobranças do último mês com status "paid"

Qual o status da cobrança #12345?

Cadastre um cliente: Maria Silva, maria@email.com, CPF 123.456.789-00

Reembolse a cobrança #67890

​
Recursos

Repositório GitHub

Código-fonte e documentação técnica

Pacote npm

@garuhq/mcp no npm

​
Próximos Passos

CLI

Use a Garu direto no terminal

Skills

Ensine boas práticas ao seu agente