Collect a generation

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

With no annotations, the description carries the full burden and does disclose meaningful traits: it waits up to wait_s, saves images or videos, is free, and never re-runs the generation. It stops short of saying where files land or what a timed-out collect returns, but the non-obvious side-effect and cost behavior is covered.

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?

A single front-loaded sentence leads with verb and resource, and the parentheticals each add useful routing detail. Slightly dense, but no sentence is wasted.

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 three-parameter collect tool with no annotations or output schema, the description covers purpose, cost, idempotency and wait behavior. Remaining gaps (save location, timeout return shape) are minor for correct invocation.

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 coverage is 100%, so the schema already documents all three parameters. The description adds only marginal meaning, clarifying that generation_id may come from an earlier session and tying wait_s to the waiting behavior, so the baseline 3 holds.

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?

States a specific verb (Collect) and resource (the result of a generation) keyed on generation_id, and clarifies it is the retrieval counterpart to a generation that is 'still running'. It implicitly separates itself from the generating siblings, though it never names ideogram_generate directly.

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?

Gives a concrete trigger: use when a tool answered 'still running' or when resuming from an earlier session. This is clear context for when to reach for it, though there is no explicit statement of when NOT to use it or a named alternative.

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