codebase_graph_visualize

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

No annotations, so description carries full burden. Details behavior: mermaid returns text, interactive writes HTML and opens browser, includes features like click interaction, right-click blast radius, layout switcher, PNG export. 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?

Well-structured with bullet points for modes. Detailed but not verbose; every sentence adds value. Could be slightly more concise but maintains clarity.

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?

Completeness for a tool with 3 parameters and no output schema: covers all modes, features, and edge cases (headless environments via open=false). No gaps given schema richness.

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%, so baseline 3. Description adds default values for 'mode' (mermaid) and 'open' (true) but schema already describes parameters. Minimal added meaning beyond defaults.

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?

Clearly states 'Visualise the code dependency graph' and describes two distinct modes with specific outputs. Distinguishes from sibling tools like codebase_graph_build or codebase_graph_query by focusing on visualization.

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?

Explicitly describes when to use each mode: 'mermaid' for inline rendering, 'interactive' for visual exploration or shareable diagrams. Implicitly excludes other sibling tools (e.g., not for building or searching).

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