amendSpreadOrder

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

With no annotations provided, the description carries the full burden of behavioral disclosure. It discloses that only unfilled/partially filled orders can be amended, response is asynchronous, and price='' keeps existing price while price='0' sets to zero. However, it omits details about permissions, rate limits, or error handling.

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 well-structured with usage scenarios and important notes. It is concise but contains a redundant 'Agent hint:' section that repeats earlier points. Overall, it is appropriately sized and front-loaded.

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 covers key usage scenarios and constraints but lacks explanation of return values (no output schema) and error conditions. The asynchronous response is noted, but more detail on order lifecycle or edge cases would improve completeness.

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 coverage is 0%, so the description must add meaning. It explains behavior for 'price' and 'qty', and notes orderId/orderLinkId usage. However, it incorrectly implies orderId/orderLinkId are required (schema shows only 'symbol' as required), creating a contradiction. The required 'symbol' parameter is not explained.

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 amends price and/or quantity of an existing spread trading order. It uses a specific verb ('Amend') and resource ('spread trading order'), distinguishing it from sibling tools like 'amendOrder' (for regular orders) and 'createSpreadOrder'.

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 clear usage scenarios: adjusting price without cancellation, modifying quantity of unfilled/partially filled orders. It specifies which parameters are needed (orderId/orderLinkId) and notes that only unfilled/partially filled orders are modifiable. However, it does not explicitly contrast with alternative tools like 'amendOrder' for non-spread orders.

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