Render a document

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

Annotations only state readOnlyHint=false and idempotentHint=false, leaving the description to carry behavioral context. The description adds useful transparency by noting that live keys consume units, test keys add a watermark, and the tool returns a download URL. It stops short of explaining side effects like resource creation or quota impact, but it adds meaningful value beyond the annotations.

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 two sentences, front-loaded with the core operation and output, and wastes no words. It packs the essential purpose, input types, output formats, return value, and billing behavior into a compact, scannable form.

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?

This is a complex 8-parameter tool with no output schema, so the description needs to cover return values and operational call requirements. It explains the download URL and main rendering paths, but it does not state whether a template or html is required, how filename behaves, or how asynchronous renders are retrieved. These gaps leave an agent with some uncertainty before invoking the tool.

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 75%, so the schema already handles most parameter documentation. The tool description clarifies high-level input modes (template+data vs raw HTML) and output format categories, but it does not add detail for undocumented parameters like data or filename. It is neither harmful nor highly compensatory.

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 a specific verb and resource: it renders templates or raw HTML into PDFs, images, DOCX, or PPTX, and returns a download URL. It does not explicitly differentiate itself from siblings like get_render or convert_to_pdf, but the output and rendering scope make the core purpose evident.

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 provides billing-related context (live keys consume units, test keys render with a watermark) but gives no guidance on when to use this tool instead of alternatives such as convert_to_pdf, get_render, or validate_template. It lacks explicit exclusions, prerequisites, or scenario-based routing.

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