visualize_workflow

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

No annotations exist, so the description carries the full burden. It does add real behavioral context: the tool renders Mermaid for the user rather than returning raw text, and pipeline workflows are collapsed to session steps inside an 'each of N sessions' block with artifact kinds on edges. It does not state whether the operation is read-only/side-effect free, whether invalid workflows error or degrade, or any limits on graph size.

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 tight sentences, front-loaded with the purpose before the format details. The pipeline-collapsing sentence is dense and slightly awkward but every clause carries information an agent would otherwise lack.

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?

With an output schema present, return-value explanation is unnecessary, and the description covers both input parameters plus the notable rendering convention for pipelines. Remaining gap is guidance on failure modes and interaction with validate_workflow, minor for a read/visualization tool.

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 the description must compensate, and it largely does: it explains that the workflow argument accepts either Mermaid flowchart text or a node/edge graph as JSON, which maps directly onto the anyOf schema. It also names the rendering intent of each format option. It does not describe the enum's default or error behavior for mismatched format/input.

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?

Opens with a specific verb and resource: "Draw a workflow or pipeline," then names the two output modalities. It is clearly distinguishable from siblings like export_workflow or validate_workflow, though it never explicitly contrasts itself with export_workflow (which might also emit Mermaid).

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 through the format distinction — Mermaid text is to be rendered for the user, JSON graph is for a visual editor — which effectively tells an agent which mode to pick. However, there is no explicit when-to-use/when-not guidance relative to export_workflow or validate_workflow, and no stated preconditions (e.g., must the workflow be validated first).

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