render

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

Annotations already provide readOnlyHint=true and idempotentHint=true. The description adds valuable context by stating 'Returns the rendered text' and clarifying that 'issue' means GitHub issue text, which goes beyond what annotations offer.

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 extremely concise, using two short paragraphs to convey the purpose, formats, and return type. Every sentence adds functional value with no redundancy.

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 simple, read-only tool with an output schema and good annotations, the description covers the core functionality and return type. The only notable gap is the lack of explicit guidance about when to prefer this over sibling tools, but the complexity is low enough that this is not critical.

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%, so the description must compensate. It clearly explains the 'format' parameter with all allowed values and their meanings, while 'report_id' is naturally implied by the phrase 'Render a report', making the schema self-explanatory enough.

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?

Immediately states 'Render a report as a shareable artifact' with a clear verb and resource. The format parameter is explained, and while it doesn't explicitly name sibling tools, the focus on reports vs. videos distinguishes it from render_html_video.

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?

No explicit when-to-use guidance or alternatives are mentioned. It does not tell the agent when to use this tool versus get_report or render_html_video, nor does it provide any exclusions.

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