generate_markdown

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

The description frames this as a rendering operation and aligns with the idempotentHint annotation. However, readOnlyHint is false and the description does not clarify whether the rendered Markdown is returned directly, saved to a file, or if any side effects occur, leaving some behavioral ambiguity.

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 a single, well-structured sentence with no redundant words. It efficiently captures the tool's purpose and key output characteristics.

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 provides enough context to understand the input source, output format, and distinctive features like TOC and citation consolidation. It could be slightly more explicit about the return type, but overall it positions the tool well among the sibling report-generation tools.

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 only 50%, and the description does not explain the required title and sections parameters or the nested citations structure. It defers to generate_report's schema rather than adding meaning to the many undocumented fields.

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 the tool renders a structured report into a GitHub-flavored Markdown document, with explicit mention of TOC, per-section confidence/sources, and a consolidated citation list. The verb, input, and output format are all concrete and unambiguous.

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 indicates the input is a structured report following generate_report's schema and that the output is Markdown, which distinguishes it from PDF generation. However, it does not explicitly explain when to choose Markdown over the PDF or institutional report siblings, nor does it provide workflow prerequisites beyond the schema pointer.

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