generate_pdf_sync

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

Description adds significant behavioral context beyond annotations: synchronous generation, download URL in response, local save for stdio, no server save for HTTP, optional inline preview. No contradictions with annotations (readOnlyHint=false, destructiveHint=false).

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?

Well-structured with bullet points for modes and warnings. Front-loaded key info. Slightly verbose but each part adds value. Could be marginally shorter but still effective.

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?

Covers all aspects: pre-condition (check parameters), post-condition (download URL, local save), mode-specific details, parameter constraints. No output schema, but response description is sufficient. Comprehensive for a complex tool with nested object.

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%, but description adds critical context: outputDir default behavior, includePreview only when needed, params must come from get_design_parameters, shareType codes mapping. Enhances understanding beyond schema.

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 a PDF synchronously with a download URL. It distinguishes from async siblings and download tools, and explains mode-specific behavior (stdio vs HTTP). The purpose is unambiguous.

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 instructs to call get_design_parameters first, ask user for values, and avoid placeholder/fake data. Also provides when to use includePreview and outputDir. Differentiates from async tools and download tools.

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