olist_gerar_nota_fiscal_pedido

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

With no annotations provided, the description carries the full burden of behavioral disclosure. It explicitly states 'Esta operação altera dados' (this operation changes data) and requires confirmar=true, which are critical to know. However, it does not disclose other behavioral traits such as side effects, reversibility, permissions, or response format.

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 concise, with three sentences: purpose, endpoint/docs, and a warning about mutation and confirmation. It is front-loaded with the main verb and resource, though the long URL and endpoint string add some noise.

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?

The description is adequate for a basic mutation tool: it names the operation, provides a documentation link, and warns about the mutation and confirmation requirement. However, it lacks information about return values (no output schema exists) and doesn't specify prerequisites or when to use this over sibling invoice tools, leaving gaps for an agent.

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?

The input schema has 100% coverage for all three parameters, so the baseline is 3. The description adds minimal extra meaning beyond the schema, only reinforcing that confirmar must be true. It does not provide additional context about id or modelo beyond their schema descriptions.

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 clearly states the tool generates an order invoice ('Gerar Nota Fiscal do Pedido'), with a specific verb and resource. It also includes the API endpoint and documentation link, but does not explicitly differentiate it from sibling tools like olist_nota_fiscal_emitir, which has a similar purpose.

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 does not provide any guidance on when to use this tool versus alternatives. It mentions the operation alters data and requires confirmar=true, but that is a warning rather than usage context. No alternative tools are mentioned.

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