volume_breakout_scanner

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

No annotations provided, so description must supply behavioral context. Lacks details on real-time vs historical, data source, rate limits, or output format details. Only parameter defaults hint at behavior.

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?

Description is well-structured with an Args block. It is concise and front-loaded with the purpose. However, the Args block could be slightly more compact.

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 has 5 parameters and an output schema, the description covers the necessary input context. Output schema exists, so return values are not required in description. Acceptable for a scanner tool.

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?

All 5 parameters are explained in the description with examples (e.g., exchange names like KUCOIN, BINANCE) and defaults. Since schema coverage is 0%, this description compensates well.

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?

Clearly states the tool detects coins with volume breakout and price breakout, using a specific verb and resource. It distinguishes from sibling tools like smart_volume_scanner and bollinger_scan.

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?

No explicit guidance on when to use this tool vs alternatives. Does not provide when-not usage or comparisons to siblings. Users must infer from parameter descriptions.

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