Get Active Trading Halts

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

The description discloses behavior beyond the readOnlyHint annotation: it lists what fields are returned (ticker, market, haltCode, human-readable reason, haltedAt, scheduled resumptionAt), and clarifies that an empty list is a normal state, not an error.

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?

Three sentences: purpose and scope, field details, and usage hint. Every sentence provides value without redundancy. Front-loaded with the core action and scope.

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 zero parameters and the presence of an output schema (implied), the description covers all needed info: what is returned, the normal state, and a usage tip integrating with a sibling tool. No gaps.

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?

The input schema has zero parameters, so the baseline is 4. The description adds implicit meaning: it returns all active halts with no filtering, which is clear from context.

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 specifies the action 'List', resource 'currently-active trading halts', and the exchanges 'NASDAQ/NYSE/AMEX', directly from the 'consolidated Nasdaq Trader halt feed'. It distinguishes from siblings by mentioning 'use this to discover halted names, then get_quote for the frozen last price'.

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 explicitly advises when to use this tool: 'Halts are tradeable catalysts — use this to discover halted names, then get_quote for the frozen last price.' It provides a follow-up action but does not explicitly state when not to use it.

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