dealdesk.render_quote_pdf

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

With no annotations, the description carries the full burden, and it does add real context: it writes to a specific exports folder, returns a file path, and does not persist the PDF on the quote. However it omits auth requirements, whether the file is overwritten, and any rate or side-effect caveats that a no-annotation tool would benefit from.

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?

Two tight sentences, front-loaded with the primary action and followed by the persistence caveat. Nothing is wasted, though the second clause is the only non-obvious detail.

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 render tool it covers the action, destination, and return value adequately. It is less complete on how selectedOptionIds affects output and on the API-key/project matching, which are relevant given no annotations and no output schema.

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 description coverage is only 67%, and the description adds no meaning for any of the three parameters. It does not explain quoteId, the projectId/API-key matching constraint, or what happens when selectedOptionIds is omitted, so the coverage gap is not compensated.

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?

States a specific verb (generate/render) and resource (quote PDF), plus the output location (project exports folder) and return value (file path). It is reasonably distinguishable but does not explicitly differentiate itself from siblings like render_quote_totals or render_card_summary.

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 says what the tool does but gives no guidance on when to use it versus alternatives such as get_quote or render_quote_totals, nor any prerequisites or exclusions. Usage must be inferred entirely from the name.

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