Generate graph diagram

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

Annotations already indicate readOnlyHint=true, and description adds that it returns a Mermaid string. This adds some context beyond annotations, but behavioral traits like potential performance impact or output size are not disclosed. No contradictions.

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, front-loaded with verb and resource, no fluff. Every word earns its place.

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?

Despite having an output schema and only 2 parameters, the description omits crucial detail about the 'limit' parameter and how the graph_name is used. The return format is stated, but the tool's behavior with different parameter values is not explained.

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 0%, so parameters (limit, graph_name) have no descriptions. The description does not mention or explain any parameters, leaving their purpose unclear. The agent must rely solely on names, which is insufficient.

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 verb 'Generate' and the resource 'Mermaid flowchart diagram' for property graphs, with a specific purpose 'to visualize its schema and topology'. It distinguishes from siblings like describe_property_graph and generate_graph_projection by focusing on visual representation.

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?

Usage is implied: 'to visualize its schema and topology' suggests using it when a diagram is needed. However, no explicit when-to-use, when-not-to-use, or alternatives are provided. Among many sibling tools, guidance is absent.

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