render_mermaid

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

No annotations provided, so description carries full burden. It discloses required syntax, anti-patterns (33+25 node warning), and output format preferences. This gives clear behavioral expectations.

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?

Two sentences plus bullet-like anti-pattern list. Front-loaded with purpose. Every sentence earns its place, no fluff.

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?

Covers purpose, constraints, and output format. No output schema, but typical render tool returns image data. Could specify if output is base64 or file, but enough for agent to infer. Omits nothing 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 covers all 3 parameters with descriptions (100% coverage). Description adds value: suggests SVG for git-friendly diffs, theme use-cases (neutral for docs, forest for dark). Adds meaningful guidance beyond schema.

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 'Render a Mermaid diagram to SVG or PNG' and lists 10 supported diagram types, matching the tool name and distinguishing it from siblings like render_d2 or render_graphviz.

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?

Provides explicit constraints: code must start with diagram type, no semicolons, no HTML tags, and warns against anti-patterns. Also directs to get_tool_guide for examples. Lacks explicit when-not-to-use vs alternatives, but sibling names imply context.

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