flowzip_to_api

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

With no annotations, the description carries full responsibility. It details the transformation process (inflating, mapping, resolving links) and discloses limitations (best-effort, skipped subgraphs, widget drift leading to errors). However, it does not explicitly state whether the operation is read-only or has side effects.

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 concise, front-loaded with the main purpose, and each sentence adds value without redundancy. It efficiently conveys the tool's function, best-effort nature, and post-processing advice.

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 that an output schema exists, the description need not explain return values. It covers the conversion process, edge cases (skipped nodes, widget drift), and provides guidance. It is reasonably complete for a converter tool, though it could mention prerequisites like live object_info.

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 schema has 0% coverage for the single parameter 'flowzip', so the description must compensate. It explains that the parameter is a FlowZip or litegraph and can be inflated, which adds meaning beyond the empty schema. However, it lacks details on format, encoding, or constraints.

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 clear verb 'Convert' and specifies the resource 'FlowZip (or litegraph)' with a target format 'API/prompt format ready for submit_workflow'. It distinguishes itself from siblings like inflate_workflow and submit_workflow by describing its bridging role.

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 states that this tool is intended for authoring/adapting graphs compactly and as a step before submitting workflows. It provides guidance on handling errors ('review the API graph before running') but does not explicitly compare to alternatives or specify when not to use it.

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