Skip to main content
O MCP da Chargefy conecta assistentes compatíveis ao seu ambiente Chargefy. Depois da autorização, o agente pode consultar dados, encontrar documentação e executar alterações operacionais de baixo risco com as mesmas regras e os mesmos objetos públicos da API.
O MCP não amplia as permissões de quem se conecta. Organização, ambiente, leitura e escrita são limitados pelo consentimento OAuth ou pela API key e revalidados a cada chamada.

​
O que você pode fazer

Com uma conexão de leitura, o agente pode:
  • listar e consultar 16 tipos de recurso, como clientes, produtos, invoices, cobranças, assinaturas e eventos;
  • buscar clientes, itens de catálogo, links de pagamento e invoices por texto;
  • carregar vários objetos pelos IDs em uma única chamada;
  • pesquisar a documentação da Chargefy;
  • montar um plano de integração sem executar alterações.
Com acesso de escrita, ele também pode criar e atualizar clientes, produtos, preços, descontos, códigos de desconto e links de pagamento.
Capturas, confirmações, reembolsos, cancelamentos, movimentações financeiras, secrets e ações administrativas não fazem parte do MCP. Use a API pública e controles próprios no seu backend para esses fluxos.

​
Antes de conectar

Você precisa de:
  • uma conta Chargefy e acesso à organização que será conectada;
  • um cliente com suporte a MCP remoto por Streamable HTTP;
  • o MCP habilitado no ambiente desejado em Desenvolvedores → Conexões;
  • OAuth pelo navegador ou uma API key de organização;
  • acesso de escrita somente se o agente precisar criar ou editar dados.
O ambiente de teste vem habilitado por padrão. O ambiente ao vivo vem desabilitado até um administrador liberá-lo.

​
Conectar com OAuth

OAuth é o caminho recomendado para uso interativo. O cliente abre a Chargefy no navegador, você escolhe uma organização e define o acesso de teste e/ou ao vivo.
Adicione o servidor remoto:
Abra /mcp, selecione chargefy e escolha Authenticate. Depois do login, selecione uma organização e revise o acesso de cada ambiente.

​
O que acontece no consentimento

1

Escolha uma organização

Cada conexão pertence a uma única organização. Para operar outra, crie uma nova conexão ou revogue e conecte novamente.
2

Revise os ambientes

Teste e ao vivo aparecem separadamente. Ambientes habilitados começam selecionados como somente leitura.
3

Conceda escrita somente quando necessário

Leitura e escrita é uma escolha explícita. As capacidades do seu usuário ainda limitam quais recursos podem ser alterados.
4

Autorize

O cliente recebe a credencial OAuth e passa a enxergar apenas as tools e operações permitidas para essa conexão.

​
Conectar com API key

Use uma API key quando a automação precisa ficar presa a uma organização e a um ambiente. O prefixo da chave define o ambiente: ch_test_ para teste e ch_live_ para ao vivo.
O MCP não aceita chaves de plataforma com escopo platform_admin. Use uma API key de organização com escopo read, write ou admin.

​
Codex

Guarde o token em uma variável de ambiente e referencie o nome da variável:

​
Claude Code com .mcp.json

Crie .mcp.json na raiz do projeto sem colocar o token real no arquivo:
Cada pessoa define CHARGEFY_MCP_TOKEN no próprio ambiente. Se o arquivo for compartilhado, o Claude Code pedirá aprovação antes de usar o servidor do projeto.
Prefira OAuth para assistentes usados por pessoas. Reserve API keys para clientes que precisam de um contexto fixo ou que não oferecem OAuth.

​
Validar a conexão

Peça ao agente:
Use a conexão Chargefy somente para leitura. Mostre a organização, os ambientes e o nível de acesso disponíveis. Depois, liste até 5 clientes no ambiente de teste. Não altere nenhum dado.
O fluxo esperado é:
1

Ler o contexto

get_chargefy_account_info mostra a organização, os ambientes e o acesso da conexão.
2

Descobrir a operação

chargefy_api_search encontra customers.list.
3

Executar a leitura

chargefy_api_read consulta os clientes no escopo de teste.
Uma conexão somente leitura expõe nove tools. Quando existe ao menos um ambiente habilitado com acesso de escrita, chargefy_api_write também aparece.

​
Se algo não funcionar

Use exatamente https://mcp.chargefy.io, na raiz do host, e confirme que o cliente suporta Streamable HTTP. Configurações stdio ou SSE não se conectam a esse endpoint.
Abra o gerenciamento de MCP do cliente e procure Authenticate ou Login. No Codex, execute codex mcp login chargefy; no Claude Code, use /mcp.
Confirme que a chave pertence a uma organização, não expirou nem foi revogada e começa com ch_test_ ou ch_live_. Chaves de plataforma não são aceitas.
A instalação terminou corretamente. Verifique ambiente habilitado, acesso de leitura ou escrita, capacidade do usuário e concessão da operação. Veja Acesso e permissões.
Se OAuth autorizou teste e ao vivo, peça para chamar get_chargefy_account_info e envie livemode: false para teste ou livemode: true para ao vivo nas tools que acessam dados.

​
Continue

Acesso e permissões

Entenda organização, ambientes, leitura, escrita e revogação.

Tools e operações

Consulte as 10 tools e as 61 operações disponíveis.

Exemplos de uso

Siga fluxos práticos de descoberta, consulta e escrita segura.

Limites e segurança

Veja rate limits, auditoria e ações fora da superfície.