comfy_visualize_workflow

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

Annotations already show readOnlyHint=true, idempotentHint=true, and destructiveHint=false. The description adds useful behavioral context: the return value is Mermaid source rather than a rendered image, it uses flowchart TD style, and the title becomes a comment in the diagram. No contradiction with annotations.

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 compact and front-loaded: it states the core purpose, the output type and how to use it, then the argument semantics. Every sentence adds value, and the Args section is minimal but informative.

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?

For a read-only, idempotent utility with two parameters and a simple string-returning behavior, the description is complete. It explains the input format, output format, and practical usage (paste into a renderer). The annotations and output schema cover the remaining trust and return-value context.

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 fully explain parameters. It does: workflow is defined as an API-format {node_id: {class_type, inputs}} dict, and title is explained as an optional string inserted as a diagram comment. This gives the agent enough semantic detail to construct both arguments correctly.

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 starts with a specific verb and resource: 'Render an API-format workflow as a Mermaid flowchart.' It clearly states what the tool produces and is easily distinguishable from sibling tools like validate_workflow, export_workflow, and inspect_workflow.

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 provides clear context for when to use the tool—when you need a Mermaid rendering of an API-format workflow—and explicitly frames the output as renderable Mermaid source. It doesn't mention explicit exclusions or alternatives, but the unique visualization purpose is clear.

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