Skip to main content
Glama

GestãoClick

gestaoclick_notas_fiscais_consumidores_cancelar_create

Notas Fiscais de Consumidores: Cancelar (POST /api/notas_fiscais_consumidores/cancelar/{id}). [write, altera dados]

Bulk support: accepts ids for batched execution.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
idYes
idsNo
bodyNo
accountNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

B3.1/5.0
Behavior3/5

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

Annotations already indicate readOnlyHint=false, destructiveHint=false, and idempotentHint=false, so the write/alter behavior is expected. The description adds that it updates data and supports bulk execution. However, it does not disclose what happens to associated records, whether cancellation is reversible, or any side effects, which would add value beyond the annotations.

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

Conciseness4/5

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

The description is very concise: two lines with key information (endpoint, write nature, bulk support). It is front-loaded with the core purpose and endpoint. No fluff, but it could briefly mention parameter roles without much added length.

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

Completeness2/5

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

Given the tool has 4 parameters, 0% schema description coverage, and no output schema, the description is insufficient for reliable invocation. It does not clarify how 'body' and 'account' are used, the relationship between 'id' and 'ids', or error conditions. The lack of output schema means the agent cannot predict return values, and the description does not compensate.

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

Parameters2/5

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

Schema description coverage is 0%, and the description only mentions 'id' and 'ids' for bulk support. It does not explain the purpose of 'body' or 'account' parameters, nor does it clarify constraints on 'id' format or behavior when both 'id' and 'ids' are provided. Since the schema provides no descriptions, the tool description fails to compensate, leaving agent unsure about parameter usage.

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

Purpose4/5

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

The description clearly states the tool's purpose: cancelling consumer invoices via POST /api/notas_fiscais_consumidores/cancelar/{id}. It also notes bulk support for batches. It distinguishes from siblings through the resource name (notas_fiscais_consumidores) and action (cancelar), though it doesn't explicitly contrast with other variants like notas_fiscais_produtos_cancelar_create.

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

Usage Guidelines3/5

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

The description indicates it is a write operation that alters data and supports bulk execution via ids, implying use when cancelling consumer invoices. However, it does not provide explicit guidance on when to use this vs. other cancellation tools (e.g., for produtos or servicos) or when cancellation is appropriate, relying on the tool name and context.

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

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.