Render Mermaid diagram to PNG

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

With no annotations, the description carries the full burden. It discloses key behaviors: returns image inline, optionally saves to file if outputPath is provided, and defaults for scale and backgroundColor. However, it does not mention error handling (e.g., invalid diagram syntax, file write failures) or performance characteristics.

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 two sentences, front-loaded with core purpose and key behavior, then lists supported diagram types. Every sentence is informative and no word is wasted. Highly concise and well-structured.

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?

Given 7 parameters, no output schema, and no annotations, the description covers essential aspects (purpose, inline return, optional saving). However, it omits error behavior, prerequisites (e.g., valid Mermaid syntax), and any side effects beyond file writing. Could be more complete for a tool lacking annotations.

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 coverage is 100%, providing baseline of 3. The description adds minimal extra meaning beyond schema descriptions: it specifies that outputPath must be an absolute .png path and explains scale factor effect. No parameter is left undocumented, but the description does not significantly enrich understanding.

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?

Description clearly states the action ('Render...to a PNG image'), specifies the resource (Mermaid diagram markup), and lists supported diagram types (flowcharts, sequence, etc.). It is precise and leaves no ambiguity about what the tool does.

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 mentions it is useful for converting Mermaid diagrams to images, which implies when to use it. However, it does not explicitly state when not to use it or provide alternatives. No sibling tools exist for comparison, so the guidance is implicit but not exhaustive.

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