flatten_positions

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

Discloses the default dry_run=true, which is critical for safe execution. No annotations are provided, so the description carries the full burden. It also mentions market orders, implying immediacy. However, it could mention potential risks like slippage.

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, front-loaded with purpose, no unnecessary words. Efficient and clear.

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 low complexity, the description covers core usage and a key behavior (dry_run). No output schema exists, but return values are not critical for this action. Still, it could mention that it places market orders and their potential impact.

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 covers symbol with description, but dry_run lacks description. The description adds 'Default dry_run=true', compensating for dry_run's missing info. Schema coverage is 50%, so the description adds value 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?

The description clearly states the action ('Close every open position with opposite-side market orders') and the resource ('positions'), with an optional filter by symbol. It distinguishes from siblings like cancel_all (cancels orders) and place_order (single order).

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 provides use cases: 'close everything' operator actions or end-of-day flatten. This gives clear context, though it doesn't explicitly mention when not to use.

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