Get Mermaid Documentation

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

Annotations already indicate read-only, non-destructive, idempotent behavior. The description adds context about returning syntax and tips, but it does not elaborate on additional behavioral traits beyond the annotations.

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-front-loaded sentence with no unnecessary words, conveying the tool's purpose efficiently.

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 tool has only two simple parameters (one enum, one boolean) and no output schema. The description covers the return content reasonably well, but given the number of related sibling tools, a brief usage note would improve completeness.

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 0%, so the description carries the full burden. It mentions 'supported Mermaid diagram types,' which loosely relates to the diagramType parameter, but it does not explain the includeExamples parameter or provide syntax details, leaving parameter meaning unclear.

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 'Get bundled syntax, keywords, and usage tips for supported Mermaid diagram types,' which is a specific verb-resource combination that distinguishes it from sibling tools like 'create_mermaid_diagram' and 'validate_mermaid_syntax'.

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 implies usage for retrieving documentation but does not explicitly guide when to use this tool versus alternatives such as 'validate_mermaid_syntax' or 'detect_mermaid_diagram_type', leaving some ambiguity.

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