describe_workflow

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

With no annotations, the description carries the transparency burden. It discloses automatic resolution through primitives/switches, dynamic schema enrichment when ComfyUI is running, and the fact that schemas are cached (prompting refresh_schemas). It does not explicitly state the operation is read-only, but 'Report' implies no mutation; this is a minor omission.

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 well-structured: a purpose sentence, a paragraph on parameter resolution behavior, a paragraph on dynamic schema details, and an Args list. Every sentence adds value with no fluff or redundancy, achieving strong conciseness for a tool with moderate complexity.

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?

The description covers inputs, key behaviors (resolution, caching, dynamic types), and mentions outputs. Since an output schema exists, return-value details need not be in the description. It lacks explicit guidance on when to use versus alternatives (covered in usage_guidelines) and does not mention error cases, but overall it is sufficiently complete for an agent to invoke correctly.

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. The Args section explains both parameters: 'name' is the workflow file name without .json extension, and 'refresh_schemas' re-reads node schemas and should be used after installing models/custom nodes because schemas are cached. This adds meaningful semantics beyond the raw schema.

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 opens with 'Report the parameters a workflow accepts, plus its outputs and model files,' which specifies the verb and resource. It clearly distinguishes from siblings like list_workflows (listing) and describe_node (node-specific), while sharing the 'workflow' domain.

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 you need to inspect a workflow's parameters/outputs, but it does not explicitly state when to use this over describe_node, get_workflow_guide, or list_workflows. No exclusions or alternative tool mentions are provided.

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