clean_mermaid_diagram

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

No annotations are provided, so the description carries the full burden. It describes the removal operations clearly but doesn't discuss side effects, edge cases, or limitations (e.g., handling of malformed content). It is adequate but not deeply transparent.

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 structured with a summary, bullet list, and args/returns, which is helpful. However, it is somewhat verbose (e.g., 'Cleaned Mermaid content with note statements, empty braces, and post-newline strings removed') and could be tightened.

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 the tool's simplicity (one parameter, no annotations), the description covers the basic functionality and return value. However, it lacks completeness regarding expected input format, error handling, or robustness. It meets minimum requirements but leaves gaps.

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?

With 0% schema description coverage, the description adds meaning by specifying 'The raw Mermaid class diagram content' for the single parameter. This goes beyond the schema's minimal definition, though it could provide more format details.

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 tool's purpose: 'Clean a Mermaid class diagram by removing unwanted elements.' It lists specific elements removed (note statements, empty curly braces, strings after newline), making the action concrete. Sibling tools are unrelated (creating charts, querying), so it distinguishes well.

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 when to use this tool (when a Mermaid class diagram needs cleaning), but it doesn't explicitly guide usage or mention alternatives. No when-not-to-use advice is given, leaving some ambiguity.

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