render_document

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

No annotations are provided, so the description carries the full burden. It discloses several non-obvious behaviors: the renderer uses the same pipeline as the editor, embeds web fonts as per-character subsets, waits for images to be ready, exports page by page, and auto-migrates v1–43 documents to v44. It omits cost or duration expectations and failure behavior for unreachable image URLs, which keeps it below 5.

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 content is front-loaded: the tool's action and default output appear first, followed by scope limits and pointers to related guides. It is dense but not padded, although the nested parentheticals and three separate cross-references make it slightly harder to scan.

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 12-parameter, annotation-free tool with no output schema, the description covers pipeline behavior, the required input constraints, and where to find more detail. However, it never says what the call returns (for example, output file paths or a thumbnail list), which is a meaningful gap when no output schema exists.

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%, so the schema already documents every parameter, including format defaults, previews default true, quality range, and the document/documentId/documentPath alternatives. The description mostly restates those defaults (page-by-page PNG, thumbnails attached) rather than adding new meaning, so the baseline 3 is appropriate.

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 states a specific verb and resource (headlessly render freeform-canvas v44 documents to images or PDF) and immediately names its differentiators: it uses the same pipeline as the editor export, with font subsetting, image-readiness waiting, and page-by-page export. It also states the default behavior (page-by-page PNG into outputDir plus thumbnails) and the hard scope limit (only freeform-canvas documents). An agent can distinguish it from siblings such as render_markdown or open_in_editor without opening the schema.

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 gives explicit when-to-use constraints: it is only for freeform-canvas documents, and image src values must be browser-loadable URLs or data URLs. It routes the agent to get_guide("render-export") for long-image, grid, PDF, JPEG, and scale modes, and to dingcard://schema/freeform for authoring. It does not explicitly exclude sibling tools such as render_markdown, so it falls short of a full 5.

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