Skip to main content
NovoUse a GYRA+ direto do Claude com o nosso conector MCP. Você entra com o seu próprio login, e o agente enxerga só o que você enxerga.Conectar →
Resumo: esta página lista todas as tools do MCP Server da GYRA+, agrupadas por domínio (autenticação, relatórios, políticas, webhooks). Cada entrada descreve o que a tool faz, os parâmetros principais e um exemplo de prompt natural que costuma invocá-la.
O MCP da GYRA+ conecta um agente de IA seu à plataforma com o seu login. Além das tools da API (abaixo), ele traz as ações do Assistente GYRA+, com o prefixo gyra_: montar e editar esteira, criar e salvar política, editar formulários, termos e modelos de contrato, agir em execuções, solicitações e cadastros. Ver Ações do Assistente GYRA+.

Autenticação

authenticate

Troca o seu e-mail e senha da plataforma por um token de sessão (JWT válido por 24h). Geralmente não precisa ser chamada manualmente: o MCP autentica e renova sozinho quando GYRA_CLIENT_ID e GYRA_CLIENT_SECRET estão configurados (ou via custom connector OAuth).
  • Quando usa: agente que alterna entre logins de organizações diferentes on demand.
  • Parâmetros: clientId (e-mail), clientSecret (senha).
  • Retorno: objeto de sessão com accessToken, expiresAt (24h), userId e organizationId. Não existe campo expiresIn (verificado contra a API).

Relatórios

create_report

Cria uma nova análise para um CPF ou CNPJ.
  • Parâmetros: document, policyId, opcional amount.
  • Retorno: objeto Report com id e status inicial (PROCESSING).
  • Prompt típico: “roda uma análise no CNPJ 43.591.367/0001-30 com a política Capital de Giro”.

get_report

Consulta o detalhe de um relatório existente pelo id.
  • Parâmetros: reportId.
  • Retorno: objeto Report completo.
  • Prompt típico: “mostra o resultado da análise 6612a7f3…”.

list_reports

Lista relatórios da organização com filtros.
  • Parâmetros: opcionais status, document, policyId, from, to, limit, offset.
  • Prompt típico: “quais foram as 10 últimas análises?”.

count_reports

Conta quantos relatórios existem que atendem filtros específicos.
  • Parâmetros: mesmos filtros de list_reports.
  • Prompt típico: “quantas análises foram negadas este mês?”.

get_section

Retorna uma seção específica de um relatório.
  • Parâmetros: reportId, sectionId.
  • Prompt típico: “me traz a seção de processos judiciais desse relatório”.

get_report_section_by_type

Atalho para pegar seção por tipo, sem precisar saber o sectionId.
  • Parâmetros: reportId, sectionType (ex: "PROCESSES", "SCORE", "SCR"). Lista completa em Consultar Seção por Tipo.
  • Prompt típico: “qual o score do bureau nesse relatório?”.

analyze_report

Registra uma análise manual de um relatório: o usuário submete uma decisão (aprovado/negado) com justificativa, sobrescrevendo ou complementando o resultado automático da política.
  • Parâmetros: reportId, approved (boolean), commentary (motivo da decisão).
  • Quando usa: analista de crédito precisa registrar decisão manual (ex.: “aprovado por relacionamento comercial”, “negado por política interna”).
  • Prompt típico: “marca o relatório X como aprovado, justificativa: cliente histórico com bom relacionamento”.

re_analyze_report

Refaz uma análise manual já registrada em um relatório. Só pode ser usada quando já existe uma análise manual prévia e o usuário tem permissão para revisar.
  • Parâmetros: reportId, approved, commentary.
  • Quando usa: revisão de decisão manual anterior (ex.: nova informação chegou e o analista quer alterar o parecer já dado).
  • Prompt típico: “reanalisa manualmente esse relatório, mudei minha decisão para negado”.

export_report_sync

Exporta o relatório em PDF, XLS ou ambos e retorna um link com validade de 7 dias.
  • Parâmetros: reportId, exportFormat ("pdf", "excel" ou "both").
  • Prompt típico: “gera um PDF desse relatório” ou “me manda a planilha do relatório”.

Políticas

list_policies

Lista as políticas de crédito da organização.
  • Parâmetros: opcionais documentType ("PF" / "PJ"), enabled.
  • Prompt típico: “quais políticas PJ estão ativas?”.

Cadastro documental

Ver Onboarding para o conceito.

validate_document

A porta de entrada do módulo: um arquivo, e o parecer volta. A entrada é única, você não diz que documento é: a plataforma reconhece entre os 25 tipos e o formato do retorno depende do tipo identificado.
  • Parâmetros: file, expectedDocument (CNPJ/CPF da jornada), expectedName, expectedType (para conferir se veio o documento certo), typeHint (afirma o tipo e pula a classificação), waitSeconds.
  • Prompt típico: “lê esse contrato social e me diz se ele bate com o CNPJ 11.444.777/0001-61”.

get_document_status

Status e resultado de um documento pelo id. É o polling depois de um 202.
  • Parâmetros: docId.
  • Prompt típico: “o documento que subi já foi analisado?”.

get_document_result

Resultado completo: campos lidos, cada verificação com evidência, e o parecer.
  • Parâmetros: id (cadastro), docId.
  • Prompt típico: “por que esse comprovante de residência foi reprovado?”.

create_registry, get_registry, get_registry_by_document, list_registries

O dossiê de um CNPJ/CPF. create_registry é idempotente por documento. list_registries filtra por situação (PENDING, PROCESSING, UP_TO_DATE, ATTENTION, EXPIRED, RENEWING).
  • Prompt típico: “quais cadastros estão com pendência ou vencidos?”.

list_registry_documents, list_registry_persons

O que o dossiê já tem, e a árvore societária com a origem de cada pessoa.
  • Prompt típico: “o que já temos do CNPJ 11.444.777/0001-61 e quem são os sócios?”.

presign_registry_document, confirm_registry_document

Envio assíncrono, para arquivo acima de 15 MB (o teto do validate_document). Peça a URL assinada, suba o arquivo, confirme.

reprocess_document

Roda o pipeline de novo, inteiro ou só uma etapa. Corrige classificação errada com forceType. Não cobra de novo.
  • Prompt típico: “esse arquivo foi classificado errado, reprocessa como alteração contratual”.

get_rule_set, get_rule_set_catalog, get_registry_accuracy

A régua vigente, o catálogo de verificações em linguagem de negócio, e os indicadores de acurácia por tipo e por campo.
  • Prompt típico: “a taxa de análise manual do comprovante de residência justifica apertar a régua?”.

Solicitações

create_collection

Cria o pedido ao cliente final a partir de um modelo e manda o link.
  • Parâmetros: template (o slug, de list_collection_templates), document ou registryId, recipients, dueInDays, channel (EMAIL, WHATSAPP, BOTH ou NONE), message, forceItemKeys, draft.
  • Prompt típico: “pede contrato social e comprovante de endereço para a Ana no WhatsApp, prazo de 10 dias”.

list_collection_templates

Os modelos disponíveis, com o slug que entra em create_collection. Chame antes de criar.

list_collections, get_collection

Acompanhamento. get_collection traz item a item e o estado de entrega de cada destinatário.
  • Prompt típico: “quem está devendo documento e qual o prazo?”.

send_collection, cancel_collection

Envia ou reenvia o pedido, e cancela quando a operação cai.
  • Prompt típico: “reenvia a solicitação da Ana, ela não recebeu”.

review_collection_item

A decisão do operador sobre um item que espera revisão: APPROVED, RESEND_REQUESTED (comentário obrigatório, e é o texto que o cliente lê) ou WAIVED.
  • Prompt típico: “reprova o comprovante e pede outro, explicando que está no nome de outra pessoa”.

suggest_collection_contacts, suggest_signatories

Contatos que aquele documento já usou, e quem assina pela empresa segundo o documento societário vigente, com o regime de assinatura.
  • Prompt típico: “quem precisa assinar pela empresa e quantas assinaturas o contrato exige?”.

Webhooks

create_webhook

Cria um webhook para receber notificações de eventos. Um webhook por tipo, registre vários se precisa escutar mais de um.
  • Parâmetros: type (REPORT, REPORT_FINISHED, REPORT_STATUS, REPORT_EXPORTED, CREDIT_POLICY, COMMITTEE_FINISHED, OPERATION), url, apiKey (opcional, enviado como header api-key nas chamadas).
  • Prompt típico: “configura webhook REPORT_FINISHED apontando para https://meu-backend/gyra”.

find_webhooks

Lista webhooks configurados.
  • Parâmetros: opcionais webhookId, type.
  • Prompt típico: “quais webhooks eu tenho configurados?”.

delete_webhook

Remove um webhook.
  • Parâmetros: webhookId.
  • Prompt típico: “remove o webhook antigo que não está sendo usado”.
As três tools acima são da família de relatório e crédito. O módulo Onboarding tem envelope e assinatura próprios, e as três tools abaixo.

list_webhook_events

O catálogo de eventos assináveis, agrupados por categoria. Leia daqui em vez de fixar a lista.
  • Prompt típico: “quais eventos eu posso assinar?”.

list_webhook_endpoints

As assinaturas configuradas, com o estado da última entrega. Assinatura que acumula 20 falhas seguidas é desligada sozinha, e é aqui que isso aparece.
  • Prompt típico: “por que paramos de receber webhook?”.

save_webhook_endpoint

Cria ou atualiza uma assinatura. Lista de eventos vazia quer dizer todos. O segredo é devolvido uma única vez, na criação.
  • Prompt típico: “assina os eventos de parecer de documento e de solicitação concluída no meu endpoint”.

Ações do Assistente

As mesmas ações que o Assistente GYRA+ executa dentro do Toolbox aparecem no MCP com o prefixo gyra_ (por exemplo, gyra_policy_save). A lista é montada a cada conexão, para você:
  • Permissões do seu papel: sem permissão para gerenciar políticas, as tools de política não aparecem. É o mesmo corte das telas.
  • Módulos da organização: Propostas, Onboarding, Formalização e Comunicação só aparecem se a organização contratou o módulo.
  • Controles do assistente: se o administrador desligou um grupo de ações ou as escritas do assistente para a organização ou para você, elas somem do MCP também. Ver Controles e limites.

Escrita sempre com prévia

Toda ação marcada como escrita funciona em dois passos, e nada é gravado no primeiro:
  1. Chamada sem confirm: devolve só a prévia do que vai mudar e um proposalId.
  2. O agente mostra a prévia para você. Só com a sua aprovação ele chama de novo com os mesmos dados, confirm: true e o mesmo proposalId.
Se alguma coisa mudou entre a prévia e a confirmação (outra pessoa editou a política, a esteira ganhou uma etapa), o proposalId não confere, nada é gravado e volta uma prévia nova para aprovar de novo.

Políticas de crédito

Esteiras e execuções

Modelos de contrato (Formalização)

Produtos, carteiras e propostas (Propostas)

Formulários, termos e solicitações (Onboarding)

Cadastros (Onboarding)

Relatórios e balanços

Exportação e comunicação

Criar modelo de contrato e termo a partir de um arquivo Word só funciona no Assistente, dentro do Toolbox, porque depende de um anexo da conversa, e por isso essas ações não aparecem no MCP. O mesmo vale para os atalhos de tela e a apresentação de novidades. Pelo MCP, crie o modelo pelo Assistente ou pela tela e use as tools acima para ajustar, conferir e publicar.

Ajuda e consumo

Exemplos encadeados

O poder do MCP aparece quando o agente encadeia tools sem você precisar dizer qual chamar:

Exemplo 1, análise completa por conversa

Você: “roda uma análise no 43591367000130 com a política padrão PJ e me diz por que foi aprovada ou negada.”
  1. Agente chama list_policies filtrando por PJ para achar a política padrão.
  2. Agente chama create_report com document e policyId.
  3. Agente faz polling em get_report até status COMPLETED.
  4. Agente chama get_report_section_by_type para pegar o breakdown.
  5. Agente responde em linguagem natural com a conclusão.

Exemplo 2, auditoria semanal

Você: “quantas análises negadas tivemos esta semana e qual a regra mais frequente de bloqueio?”
  1. Agente chama count_reports com status: "DENIED" e intervalo de datas.
  2. Agente chama list_reports com o mesmo filtro.
  3. Agente consulta breakdown de cada relatório via get_report_section_by_type.
  4. Agente agrega e responde.

Limitações

  • Tools disponíveis refletem o escopo contratado pela organização. Features não contratadas retornam erro claro, e as ações gyra_* de um módulo não contratado nem aparecem.
  • Rate limit aplicável: mesmas regras da API REST (100 req/min padrão). O cliente MCP retransmite 429 e o modelo espera.
  • Payloads grandes: relatórios COMPLETO+ podem exceder o limite de contexto do modelo. Use get_report_section_by_type em vez de get_report para buscar só o que precisa.

Perguntas frequentes

A lista é montada para você a cada conexão: o seu papel precisa da permissão, a organização precisa do módulo e o administrador não pode ter desligado aquele grupo ou as escritas do assistente. Se a lista mudou (permissão nova, módulo contratado), reconecte o cliente MCP para ela ser montada de novo.
Por enquanto o catálogo é fechado. Se você precisa de tool específica, fale com o suporte. Se precisa de tool composta, deixe o modelo encadear as existentes (costuma ser suficiente).
Os schemas (nomes, parâmetros) estão em inglês para alinhar ao padrão MCP. As descrições funcionais estão em português para que modelos em PT-BR escolham corretamente.
Todo cliente MCP sério (Claude Desktop, Cursor) mostra as tool calls na UI. Além disso, toda chamada fica no log de auditoria do toolbox.

Próximos passos

Casos de uso

Conversas práticas com exemplos reais.

Troubleshooting

Quando uma tool não é chamada.

Instalação

Voltar e configurar o cliente.

API REST

Acesso direto sem MCP.