generate_pdf

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

With no annotations provided, the description carries full burden. It discloses the return format (base64-encoded PDF bytes) and implies a non-destructive creation operation. However, it does not address authorization, rate limits, or error behavior. Still, key behavioral traits are covered.

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 extremely concise: three sentences that efficiently convey purpose, differentiation, output format, and prerequisite. No unnecessary words.

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?

Given the complexity of the nested document parameter and lack of output schema, the description provides essential context (base64 output, sibling tool references, element discovery). It is nearly complete, though error handling details are absent.

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%, so baseline is 3. The description adds value by directing to call list_element_types for element shapes, which is critical context not present in the schema. This elevates it beyond the baseline.

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 action ('Generate a PDF from a custom PdfDocument JSON descriptor'), provides concrete examples of use cases (resumes, contracts, etc.), and explicitly differentiates from sibling tools (generate_invoice, generate_report).

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?

Explicitly states when to use this tool vs alternatives ('Use this for any layout not covered by generate_invoice or generate_report') and advises calling list_element_types first, providing clear guidance on prerequisite and alternative selection.

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