Tools
O servidor expõe 289 tools sobre 73 famílias de recurso: 123 de leitura, 46 de escrita e 120 destrutivas. Cada tool espelha uma ação da API v2 (nos boletos de cobrança, da API v1 ou do painel), chama o mesmo código e passa pelas mesmas barreiras de autorização. A descrição de cada tool, que é o que o modelo lê, está em inglês.
Como ler estas páginas
| Coluna | Significado |
|---|---|
| Tipo | read, write ou destructive. Uma destructive cancela, exclui, paga, transfere, aprova ou muda para onde dado e dinheiro saem da conta. Veja Confirmação de tools destrutivas. |
| Permissão | A permissão de painel que a pessoa que autorizou o cliente precisa ter. Quando há duas, as duas são exigidas, como no painel. |
| Espelha | O endpoint da Referência da API que a tool reproduz, ou a ação do painel quando não há endpoint. |
| O que faz | A primeira frase da descrição que o cliente MCP recebe em tools/list. |
Acima de cada tabela fica o escopo que o token precisa carregar para a família. O nome legado do escopo (charge.bank_billets, sem o prefixo banking/) e all também valem: veja Escopo do token.
O catálogo
| Família | Página | Tools | read | write | destructive |
|---|---|---|---|---|---|
| Boletos de cobrança | Boletos e cobranças | 17 | 2 | 7 | 8 |
| Carteiras de cobrança | Boletos e cobranças | 5 | 2 | 2 | 1 |
| Pagamentos de boletos | Boletos e cobranças | 2 | 2 | 0 | 0 |
| Carnês | Boletos e cobranças | 4 | 2 | 1 | 1 |
| Assinaturas | Boletos e cobranças | 5 | 2 | 2 | 1 |
| Recebimentos | Boletos e cobranças | 4 | 2 | 0 | 2 |
| Cobranças Pix | Pix e Pix Automático | 8 | 4 | 2 | 2 |
| Contas Pix | Pix e Pix Automático | 5 | 2 | 0 | 3 |
| Pix Automático — contas | Pix e Pix Automático | 5 | 2 | 1 | 2 |
| Pix Automático — recorrências | Pix e Pix Automático | 6 | 2 | 3 | 1 |
| Pix Automático — solicitações | Pix e Pix Automático | 5 | 2 | 2 | 1 |
| Pix Automático — cobranças | Pix e Pix Automático | 6 | 2 | 1 | 3 |
| Pix Automático — locations | Pix e Pix Automático | 3 | 2 | 1 | 0 |
| Registros de boleto | Remessa, retorno e EDI | 2 | 2 | 0 | 0 |
| Remessas CNAB | Remessa, retorno e EDI | 4 | 2 | 0 | 2 |
| Boletos em remessa | Remessa, retorno e EDI | 3 | 2 | 0 | 1 |
| Retornos CNAB | Remessa, retorno e EDI | 2 | 2 | 0 | 0 |
| Boletos em retorno | Remessa, retorno e EDI | 2 | 2 | 0 | 0 |
| Remessas de pagamento | Remessa, retorno e EDI | 1 | 1 | 0 | 0 |
| Caixas EDI | Remessa, retorno e EDI | 4 | 2 | 0 | 2 |
| Pagamentos (unificado) | Pagamentos | 6 | 2 | 0 | 4 |
| Pagamento de boletos | Pagamentos | 4 | 2 | 0 | 2 |
| Pagamento Pix | Pagamentos | 4 | 2 | 0 | 2 |
| DARFs | Pagamentos | 4 | 2 | 0 | 2 |
| Tributos | Pagamentos | 4 | 2 | 0 | 2 |
| Concessionárias | Pagamentos | 4 | 2 | 0 | 2 |
| Lotes de pagamento | Pagamentos | 5 | 2 | 0 | 3 |
| Lotes de pagamento de boletos | Pagamentos | 1 | 0 | 0 | 1 |
| Lotes de pagamento Pix | Pagamentos | 1 | 0 | 0 | 1 |
| Lotes de DARF | Pagamentos | 1 | 0 | 0 | 1 |
| Lotes de tributos | Pagamentos | 1 | 0 | 0 | 1 |
| Lotes de concessionárias | Pagamentos | 1 | 0 | 0 | 1 |
| Contas de pagamento | Pagamentos | 4 | 2 | 2 | 0 |
| Contas DDA | Pagamentos | 6 | 2 | 1 | 3 |
| Boletos DDA | Pagamentos | 5 | 2 | 0 | 3 |
| Transferências (unificado) | Transferências | 6 | 2 | 0 | 4 |
| TED | Transferências | 6 | 2 | 0 | 4 |
| Transferência Pix | Transferências | 6 | 2 | 0 | 4 |
| Transferência interna | Transferências | 6 | 2 | 0 | 4 |
| Lotes de transferência | Transferências | 5 | 2 | 0 | 3 |
| Lotes de TED | Transferências | 1 | 0 | 0 | 1 |
| Lotes de transferência Pix | Transferências | 1 | 0 | 0 | 1 |
| Lotes de transferência interna | Transferências | 1 | 0 | 0 | 1 |
| Contas de transferência | Transferências | 4 | 2 | 1 | 1 |
| Contas financeiras | Contas financeiras e extrato | 7 | 4 | 0 | 3 |
| Saldos | Contas financeiras e extrato | 4 | 2 | 1 | 1 |
| Extrato | Contas financeiras e extrato | 3 | 2 | 1 | 0 |
| Sincronizações de extrato | Contas financeiras e extrato | 2 | 2 | 0 | 0 |
| Importações de extrato | Contas financeiras e extrato | 2 | 2 | 0 | 0 |
| Categorias de extrato | Contas financeiras e extrato | 1 | 1 | 0 | 0 |
| Provedores financeiros | Contas financeiras e extrato | 1 | 1 | 0 | 0 |
| Clientes | Clientes, eventos e consultas | 5 | 2 | 2 | 1 |
| Pessoas | Clientes, eventos e consultas | 4 | 2 | 1 | 1 |
| Eventos | Clientes, eventos e consultas | 2 | 2 | 0 | 0 |
| Webhooks | Clientes, eventos e consultas | 5 | 2 | 0 | 3 |
| Histórico de e-mails | Clientes, eventos e consultas | 2 | 2 | 0 | 0 |
| Contas de e-mail | Clientes, eventos e consultas | 6 | 2 | 1 | 3 |
| Importações | Clientes, eventos e consultas | 2 | 2 | 0 | 0 |
| Consultas de boleto | Clientes, eventos e consultas | 3 | 2 | 1 | 0 |
| Consultas de QR Code Pix | Clientes, eventos e consultas | 3 | 2 | 1 | 0 |
| Subcontas | Administração | 4 | 2 | 0 | 2 |
| Conexões | Administração | 5 | 2 | 1 | 2 |
| Associações de conexão | Administração | 2 | 0 | 0 | 2 |
| Comandos | Administração | 2 | 2 | 0 | 0 |
| Transações de contratação | Administração | 2 | 2 | 0 | 0 |
| Provedores | Administração | 1 | 1 | 0 | 0 |
| Caixas postais | Caixa postal | 5 | 2 | 2 | 1 |
| Arquivos | Caixa postal | 4 | 2 | 1 | 1 |
| Canal de e-mail | Caixa postal | 6 | 1 | 1 | 4 |
| Canal de WhatsApp | Caixa postal | 6 | 1 | 1 | 4 |
| Canal S3 | Caixa postal | 6 | 1 | 2 | 3 |
| Canal SFTP | Caixa postal | 6 | 1 | 2 | 3 |
| Canal Syncthing | Caixa postal | 8 | 1 | 2 | 5 |
Uma tool que você não pode rodar não aparece em tools/list. Se uma daqui não está lá, veja Autenticação.