Referência
Tools
Todas as ferramentas do Magnus MCP Server
Operações da API
Uma tool por operação. Cada chamada vira uma requisição real à API com a sua API Key.
| Tool | Rota | Parâmetros |
|---|---|---|
create_pix_payment | POST /transactions/create | amount, description?, payerName?, payerDocument? |
get_transaction | POST /transactions/check | transactionId |
list_transactions | GET /transactions | page?, limit? |
get_fees | GET /transactions/fees | — |
get_balance | GET /wallet/balance | — |
create_pix_withdrawal ⚠️ | POST /wallet/withdraw | amount, pixKey, pixKeyType, description?, verificationCode? |
create_internal_transfer ⚠️ | POST /wallet/transfer | amount, recipientEmail, description?, verificationCode? |
update_webhook_config | PUT /api/webhooks/config | webhookUrl, webhookSecret? |
generate_webhook_secret | POST /api/webhooks/generate-secret | — |
test_webhook | POST /api/webhooks/test | — |
get_webhook_logs | GET /api/webhooks/logs | limit? |
get_webhook_stats | GET /api/webhooks/stats | — |
⚠️ = move dinheiro para fora da conta. Os editores pedem confirmação antes de executar, e a segurança de transferências (se ativa) exige verificationCode. pixKeyType: CPF, CNPJ, EMAIL, TELEFONE ou RANDOM.
execute_operation
Executor genérico: recebe operationId e params e roda qualquer operação da tabela acima. Útil para agentes que descobrem as operações em tempo de execução. Só aceita operações do catálogo.
Ferramentas compostas
| Tool | O que faz | Parâmetros |
|---|---|---|
debug_api_key | Testa a chave e devolve saldo, taxas, limites e dicas para cada erro (401, 403, 429) | — |
configure_webhook | Define a URL, gera secret novo e envia evento de teste numa chamada | webhookUrl, generateSecret?, sendTest? |
analyze_webhook | Valida o payload e recalcula o HMAC do header X-mc-Signature (roda local, nada é enviado) | rawBody, signature?, secret? |
wait_for_payment | Consulta a transação a cada ~4s até sair de PENDING (máx. 120s) | transactionId, timeoutSeconds? |
Descoberta
| Tool | O que faz | Parâmetros |
|---|---|---|
list_operations | Lista as operações, opcionalmente de uma tag | tag? (pix, saques, conta, webhooks) |
search_operations | Busca operações por texto | query?, tag? |
get_operation | Schema de entrada (JSON Schema), rota e documentação da operação | operationId |
Documentação
| Tool | O que faz | Parâmetros |
|---|---|---|
search_docs | Busca na documentação oficial e devolve trechos com o slug da página | query |
fetch_doc | Conteúdo completo de uma página | slug |
Slugs: visao-geral, pagamentos-criar, pagamentos-buscar, pagamentos-listar, taxas, conta-saldo, conta-transferencia, saques-criar, webhooks, websocket, rate-limiting, mcp.
Resources
| URI | Conteúdo |
|---|---|
magnus://spec/v1 | Catálogo de operações com JSON Schema de entrada |
magnus://docs | Índice da documentação |
magnus://docs/<slug> | Cada página da documentação em markdown |
magnus://webhooks | Guia de webhooks: eventos, payload, headers e assinatura |
Respostas
Toda tool de operação devolve o JSON da API com o status HTTP (
{ "status": 201, "success": true, "data": {...} }). Erros da API voltam marcados como erro para o agente, com a mensagem original.