pdf_template_config_preview

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

Annotations already declare readOnly, idempotent, non-destructive, closed-world behavior, so the safety profile is covered. The description adds two genuinely useful facts beyond that: the output is HTML, and the data rendered is sample invoice data rather than real records — meaning nothing is persisted and the preview is not representative of live content.

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 sentences, zero waste, with the core action front-loaded and the usage cue immediately after. Nothing to trim.

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?

With no output schema, the description usefully discloses that the return value is HTML and that it is rendered against sample data. A four-parameter read-only tool is adequately covered; only the absence of any note on the preview's fidelity or size limits keeps it from a 5.

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 100%, including an enum for templateSlug, so the schema carries all parameter meaning. The description only gestures at the visual fields ("how a template will look") without adding format or default details beyond the schema. Baseline 3 applies.

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 and resource: generate an HTML preview of a PDF template, populated with sample invoice data. It is clearly distinct from pdf_template_config_get/update/templates by being a non-persisting render, though it never names those siblings explicitly.

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?

"Use this to preview how a template will look before saving configuration changes" gives a clear trigger condition that implicitly routes the agent here before calling pdf_template_config_update. No explicit exclusions or sibling names, so it stops short of a 5.

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