get_diagram_syntax_guide

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

With no annotations, the description carries the full burden, and it does document the shape of the returned content (rules, keyword requirements, connectors, pitfalls, working examples), which is genuinely useful given there is no output schema. However, it says nothing about failure behavior when an unknown or misspelled diagram_type is supplied, nor about whether aliases resolve or error — a real gap for a free-form string input.

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?

A single front-loaded sentence that leads with the outcome ("Returns authoritative syntax rules") and then enumerates the payload categories efficiently. The long parenthetical example list is somewhat redundant with the schema, but it is compact and does not bury the main point.

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 one-parameter lookup with no annotations and no output schema, the description does adequately cover what comes back. It falls short on how to obtain valid diagram_type values and what happens on an unrecognized value, both of which an agent needs to call this reliably on the first try.

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 100%, and the parameter's own description already lists the same example values ("usecase-beta", "swimlane-beta", "sequenceDiagram", etc.) that the tool description repeats. The description adds no new semantics such as case sensitivity, alias resolution rules, or a pointer to where the authoritative list lives, so the baseline 3 applies.

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 uses a specific verb ("Returns") and enumerates the resource precisely: syntax rules, keyword requirements, connectors, pitfalls, and verified examples for a named diagram type. An agent can tell this is a documentation lookup rather than a renderer, but no sibling (e.g. get_supported_diagrams, render_mermaid_file) is named or contrasted, so sibling differentiation is left to inference.

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?

There is no explicit when-to-use guidance, no statement that this should be consulted before rendering with render_mermaid_file, and no exclusion of when it is unnecessary. The natural precondition — discovering valid diagram_type values via get_supported_diagrams — is never mentioned, which matters because the parameter is free-form with no enum.

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