consultar_nfe

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

With no annotations provided, the description carries the burden of disclosing behavior. The word 'Consulta' (queries) indicates a read operation, but it does not explicitly state that it is read-only, mention authentication needs, or describe the response format. This is minimal but adequate for a simple query tool.

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

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

The description is a single, compact sentence that conveys all essential information without any filler or redundant words. It is perfectly front-loaded.

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

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

For a simple one-parameter fetch operation, the description is nearly complete: it states what it does and which ID to use. However, since there is no output schema, it could have been more explicit about what 'detalhes' are returned (e.g., status, values, tax info), though sibling tools like baixar_pdf_nfe and baixar_xml_nfe hint that this returns JSON data.

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

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

Schema coverage is 100% with the single 'id' parameter clearly described as 'ID da NF-e na Nuvem Fiscal'. The description repeats 'pelo ID' but adds no extra semantics beyond what the schema already provides, so the baseline of 3 is appropriate.

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

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

The description uses the specific verb 'Consulta' and identifies the resource as 'os detalhes de uma NF-e específica pelo ID', clearly indicating a single-record query. This distinguishes it from siblings like listar_nfe (listing all NF-es) and consultar_nfse (service invoices).

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

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

The description implies usage when you have a specific NF-e ID and need details, but it does not explicitly mention alternatives or state when not to use it. There is no direct comparison with listar_nfe or consultar_nfse, leaving the guidance implicit.

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