IPO Orders

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

Annotations already declare readOnlyHint and idempotentHint, so the description does not contradict. It adds that the tool returns an array with specific fields and includes both active and history, but it omits pagination behavior despite the presence of page and size parameters.

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 concise with two sentences, front-loading the verb and resource. It is structured and clear, but could slightly improve by adding a note on pagination.

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 presence of an output schema, the description adequately covers the purpose and return fields. However, the lack of pagination context and the default behavior for active/history selection leaves minor gaps. Overall, it is fairly complete for a listing 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?

Schema description coverage is 100%, so parameters are already documented. The description mentions filtering by symbol, market, or status, which aligns with the schema but adds no extra meaning. Pagination parameters are not addressed in the description.

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 lists IPO orders (active and history) and specifies the exact fields returned. It also mentions filtering options, distinguishing it from the sibling tool ipo_order_detail which likely returns a single order detail.

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 implies usage by stating 'List IPO orders' and notes filtering by symbol, market, or status. However, it does not explicitly provide when to use this tool versus alternatives like ipo_order_detail, nor does it mention any prerequisites or exclusions.

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