attach_prompt_snippet_to_flow_step

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

With no annotations, the description carries the full burden. It discloses the effect (shapes the step's prompt), return value (linkId for later reorder/detach), and includes no misleading or contradictory statements. It does not detail permissions or error cases, but the core behavior is well-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?

The description is two sentences, concise and front-loaded with the main action. Every sentence is relevant and adds information without redundancy.

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 tool's simplicity and no output schema, the description covers the action, return value, and context (snippet alone does nothing). It lacks details on error conditions or permission requirements, but is fairly complete for its purpose.

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 parameters are well-documented. The description adds context by explaining the channel choice and ordering, and the overall purpose. For example, it says 'Choose the channel (target: system/user) and its order in that channel.' This adds value beyond the schema's individual descriptions.

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 the tool attaches a prompt snippet to a flow step's prompt stack, specifying the verb 'Place' and distinct resource. It differentiates from creating a snippet alone, and among siblings like 'detach_prompt_snippet_from_flow_step' this attach variant is unambiguous.

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 explains that this tool makes a snippet effective, contrasting with snippet creation. It implies when to use (after creating a snippet) and mentions return value for later actions. It does not explicitly state when not to use or list alternatives, but the context from sibling tools (create, delete, detach) is implicit.

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