mermaid_to_workflow

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

Since no annotations are provided, the description carries full burden. It discloses that it resolves node types using /object_info schemas, wires connections, and fills missing inputs with defaults. This is thorough, though error handling on invalid Mermaid input is not mentioned.

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?

Three sentences, each adding value: first states purpose, second details parsing, third explains resolution and output. Front-loaded and no fluff.

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 single parameter and no output schema, the description covers the conversion process adequately, including how nodes and connections are resolved. It explains the necessary details for an agent to invoke the tool 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?

With 100% schema coverage, the description adds meaning beyond the schema by specifying that node labels should use ComfyUI class_type names and connections should be labeled with data types. It also clarifies that input can include or omit code fences.

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 that it converts a Mermaid flowchart into a ComfyUI workflow JSON, specifying parsing of node definitions, connections with data type labels, and widget values. It distinguishes itself from siblings like 'workflow_from_image' and 'dsl_to_workflow' by focusing on Mermaid syntax.

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 use when a Mermaid diagram is available, but does not explicitly state when to use this tool versus alternatives like 'dsl_to_workflow' or 'visualize_workflow'. No exclusion criteria or prerequisites are given.

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