flow-add-step

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

Describes success return, failure behavior, error conditions (tool not found, invalid JSON), and a correction method (edit .yaml file). No annotations provided, so description carries full burden and does well.

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?

Five sentences with no fluff; purpose, usage, returns, errors, and correction are each addressed in a front-loaded, efficient manner.

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?

Covers return object, error handling, and prerequisites (recording flow). Lacks explanation of 'active flow' but context is adequate for a step-adding tool with no output schema.

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 baseline is 3. Description repeats schema's parameter descriptions without adding significant new semantics, thus no additional value.

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 clearly states the tool executes a tool call and records it as a step in the active flow, distinguishing it from siblings like flow-add-echo (which adds echo steps) and flow-start-recording (which starts recording).

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?

Explicitly says when to use: 'Use when recording a flow with flow-start-recording and you want to run and capture each action.' Does not explicitly say when not to use or mention alternatives, but provides clear usage context.

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