visualize_workflow

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

The description discloses the core behavior: conversion to Mermaid syntax, grouping by category, and labeling connections. Since annotations are absent, the description carries the full burden, and it adequately covers the read-only nature. It could add details on return format or error handling, but it is clear and non-contradictory.

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-structured sentence that front-loads the action and key output details. There is no unnecessary or redundant information.

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 complexity (3 parameters, no output schema), the description is mostly complete. It specifies input type, output format, and organizational details. Missing details like return format (plain text vs code block) or error handling would be improvements but are not critical.

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?

The input schema has 100% coverage with descriptions for all three parameters, so the baseline is 3. The main description does not add parameter-level meaning beyond what the schema provides; it focuses on output characteristics.

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 converts a ComfyUI workflow JSON into a Mermaid flowchart diagram, specifying the output format and content (nodes grouped by category, connections labeled by data type). This distinguishes it from siblings like visualize_workflow_hierarchical.

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 when one needs a Mermaid diagram of a workflow, but it does not explicitly state when to use this tool versus alternatives like visualize_workflow_hierarchical or other visualization tools. No exclusion or comparison is provided.

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