get_order_by_client_id

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

With no annotations, the description should convey whether the operation is read-only, what happens if the order is not found, or any potential side effects. The description provides none of this, leaving behavioral aspects ambiguous.

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 a single, concise sentence with no redundant information. It directly states the action and the key identifier without unnecessary elaboration.

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?

The description is sufficient for a simple retrieval operation, clearly indicating the input and that 'details' are returned. While it doesn't specify the output structure or error behavior, the minimal context is adequate given the simplicity of the 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?

The single parameter client_order_id is described in the tool description as 'the clientOrderId string it was created with,' which clearly defines its purpose. Although the schema lacks a per-field description, the tool description compensates adequately for a single obvious parameter.

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 that the tool retrieves details of a single order using the clientOrderId, which is a specific and unambiguous resource identifier. It distinguishes itself from sibling tools like get_order (likely by system order ID) and list_orders by the exact field used for lookup.

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 that the tool is used when you have a clientOrderId, but it does not explicitly contrast it with other order lookup tools or state conditions for use. It lacks explicit guidance on when to prefer this over get_order or list_orders.

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