Skip to main content
Glama

Br Cancel Cte

br__cancel_cte

Cancel an authorized Brazilian CT-e by submitting the official cancellation event to SEFAZ. Irreversible in production and requires confirmation.

Instructions

Solicita o cancelamento de um CT-e autorizado (evento 110111, CTeRecepcaoEventoV4).

Constrói, assina (build_cte_event_signer, alvo infEvento) e submete o evento de cancelamento. cStat=135 indica cancelamento homologado [Verified locally] — MOC CT-e Visão Geral v4.00 §6.2.2.

Cancelamento é uma operação irreversível em produção e exige confirmação em duas etapas (ConfirmationGate). Define BR_CTE_READ_ONLY=1 para desabilitar. endpoint_override é obrigatório — nenhuma URL de endpoint CT-e está embutida/verificada nesta versão.

Retorna cStat/xMotivo ou error.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
cnpjYesCNPJ do emitente do CT-e (autor do evento)
ch_cteYesChave de acesso do CT-e a cancelar (chCTe), 44 caracteres
n_protYesNúmero do protocolo de autorização do CT-e original (nProt)
tp_ambNoIdentificação do Ambiente (tpAmb): '1' = produção, '2' = homologação2
x_justYesJustificativa do cancelamento
c_orgaoYesCódigo IBGE da UF do autorizador (cOrgao), 2 dígitos (ou '90' para SUFRAMA)
cert_pathYesCaminho local para o certificado ICP-Brasil A1 (.p12/.pfx)
dh_eventoYesData e hora do evento (ISO 8601, UTC)
cert_passwordNoSenha do certificado A1, se houver
endpoint_overrideYesURL completa do webservice CTeRecepcaoEventoV4 — obrigatório, ver docstring do módulo.
confirmation_tokenNoToken de confirmação obtido de uma chamada anterior pendente.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. Addedv0.6.2

TDQS

A4.7/5.0
Behavior5/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Não há annotations, então a descrição assume todo o peso da transparência. Ela revela que a operação constrói, assina e submete o evento, é irreversível, exige ConfirmationGate, pode ser desabilitada com BR_CTE_READ_ONLY=1 e exige endpoint_override obrigatório. Isso é muito além do mínimo.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

A descrição é densa e bem estruturada: propósito primeiro, depois fluxo de assinatura/submissão, depois avisos críticos e retorno. Cada frase contribui com informação operacional relevante, sem enrolação ou repetição do schema.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Para uma ferramenta complexa com 11 parâmetros, nenhuma annotation e output schema presente, a descrição cobre os aspectos críticos: irreversibilidade, confirmação em duas etapas, obrigatoriedade de endpoint, retorno esperado e referência normativa. O output schema cuida da estrutura de retorno, então nada essencial está faltando.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

O schema já cobre 100% dos parâmetros, então a baseline é 3. A descrição adiciona valor ao explicar que endpoint_override é obrigatório porque nenhuma URL está embutida, e que confirmation_token vem de uma chamada pendente anterior. Também contextualiza cStat=135 como cancelamento homologado.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

A descrição afirma claramente o propósito: solicitar o cancelamento de um CT-e autorizado, especificando o evento (110111) e o serviço (CTeRecepcaoEventoV4). Isso diferencia a ferramenta dos irmãos como submit_cte, consult_cte e correct_cte, deixando evidente que é exclusivamente para cancelamento.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

A descrição deixa claro que a ferramenta deve ser usada para cancelar CT-e autorizados e que a operação é irreversível em produção, exigindo confirmação em duas etapas. Não menciona explicitamente alternativas, como correct_cte para ajustes, mas o contexto de uso é suficientemente claro.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.