generate_with_api_node

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

With no annotations, description discloses key behavior: returns immediately with prompt_id, enqueues workflow, and directs to other tools for results. Missing details like error handling or permissions, but covers the main async pattern.

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?

Two sentences: first states purpose and result, second gives critical usage notes. Front-loaded, 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 complexity (dynamic inputs, async, no output schema), description covers essential usage, result handling, and auth. Could mention error scenarios but references schema for validation.

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 has 100% description coverage; description adds context for class_type (source of nodes) and inputs (schema-driven). Still useful beyond the 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?

Description states 'Build a minimal single-node workflow that runs a chosen API/partner node' – clear verb and resource. Distinct from sibling tools like 'generate_image' or 'generate_with_controlnet' which do different things.

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?

Provides explicit guidance: 'Do NOT pass auth credentials' and 'Use get_api_node_schema to discover valid inputs'. Also implies async usage via 'use get_job_status/get_history for results'. Lacks explicit when-not-to-use, but context is clear.

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