render_checklist_html

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

With no annotations provided, the description carries the full behavioral burden. It discloses return values (html string and base64 content), the provenance stamp, the self-contained nature, and view behavior ('view='official' strips to the published form's three columns'). This is strong, though it does not discuss side effects or failure modes.

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 dense but every clause adds value: purpose, relationship to sibling, output details, input requirements, and view option. It is front-loaded with the primary action and maintains a clear structure despite its length.

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?

The description covers the essential operational needs: inputs, output format, and a view variant. It is slightly incomplete regarding what happens when no input is provided or when both assessment and manuscript_id are supplied, but overall it gives enough context for correct invocation.

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 0%, but the description compensates by explaining that either an assessment object or manuscript_id should be passed, and that view='official' changes the output. It does not fully describe all possible view values or the exact shape of the assessment object, leaving some room for ambiguity.

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 action ('Render the completed TARGET checklist as a self-contained HTML page') and clearly identifies the output format. It also distinguishes the tool from its sibling render_checklist by noting 'same content as render_checklist' while adding the HTML/browser context.

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 clear guidance on when to use this tool: when an HTML page is needed, viewable in any browser. It also tells the agent what inputs to provide ('Pass a full assessment object or the manuscript_id of one assessed this session'). However, it does not explicitly state when not to use it or compare against render_checklist_docx.

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