get_order

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

The description complements the readOnlyHint annotation by detailing the output for filled orders (positionExecutions) and the rate limit policy shared with get_close_order_info. No contradictions with annotations.

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 highly concise, front-loading the core purpose. Every sentence adds value: the lookup action, identifier constraint, status list, filled order behavior, and rate limit note. No unnecessary words.

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 availability of an output schema, the description does not need to detail return values. It covers all necessary aspects: lookup mechanism, status codes, filled order details, and rate limiting, making it complete for an agent to use correctly.

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?

While the input schema already describes both parameters, the description adds critical context: 'exactly one' must be provided, and reference_id is the UUID from create_order. This significantly enhances understanding 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 verb 'look up', the resource 'order status', and the required input constraints (exactly one of order_id or reference_id). It effectively distinguishes from sibling tools like get_close_order_info, which shares a rate limit but serves a different purpose.

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 provides specific guidance that exactly one identifier must be used, and details the status codes. However, it does not explicitly state when not to use this tool or contrast it with alternatives beyond the rate-limit mention.

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