Skip to main content
Glama

Consultar nota de produto

consultar_nota_produto
Read-onlyIdempotent

Situação de uma NF-e ou NFC-e desta conta: status, número, chave de acesso e, se rejeitada, o motivo que a SEFAZ deu. Traz xml_url e pdf_url, que exigem a chave de API: entregue os links, não diga que leu os arquivos.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "tipo": "<tipo>",
      "id": "<id>"
    },
    "name": "consultar_nota_produto"
  }
}

Input Schema

NameRequiredDescriptionDefault
idYes
tipoYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Added

TDQS

B3.4/5.0
Behavior4/5

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

Annotations already declare readOnlyHint, idempotentHint, non-destructive and closed-world, so safety is covered. The description adds genuinely non-obvious behavior: rejection responses carry the SEFAZ reason, and xml_url/pdf_url require an API key and must be handed back as links rather than read. It does not say what happens when the id is unknown or invalid.

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?

Two tight sentences, front-loaded with the payoff (what situation data is returned) before the operational caveat about API-key-gated URLs. Little waste, though the return-field enumeration is dense and the id ambiguity means some words are spent without resolving the key confusion.

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

Completeness3/5

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

With no output schema, the description does the right thing by enumerating returned fields and flagging the API-key requirement. But for a two-required-parameter lookup tool it leaves the primary identifier undefined and says nothing about not-found or invalid-id behavior, which is the main gap an agent would hit in practice.

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% for two required parameters, so the description must carry the load, and it does not. 'tipo' is only obliquely covered by 'NF-e ou NFC-e', and 'id' is never explained at all — worse, the description mentions 'chave de acesso' as a returned field, which invites confusion about whether the input id is the chave, an internal id, or something else given the 20-32 character pattern.

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 names a specific resource and verb ('Situação de uma NF-e ou NFC-e desta conta') and enumerates what comes back (status, número, chave de acesso, motivo de rejeição, xml_url, pdf_url). It does not explicitly distinguish itself from the sibling 'consultar_nota', so an agent still has to infer which of the two to call.

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?

Usage is only implied: it is a status lookup for an already-issued nota, and the instruction 'entregue os links, não diga que leu os arquivos' is a presentation rule rather than a when-to-use rule. No statement of when not to use it, no prerequisites, and no pointer to 'consultar_nota' or 'listar_notas_produto' for the cases this tool does not cover.

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.

Resources