Replace order

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

No annotations provided, so description must fully disclose behavior. It states 'Only the provided fields change' and highlights the leg restriction, but does not mention prerequisites (e.g., order must be working), permissions, or error cases. Partial transparency.

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?

Two tightly written sentences. First sentence states purpose and scope. Second sentence provides a critical constraint. No unnecessary words, well-structured.

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 7 parameters, 3 enums, and no output schema, the description covers the main functional constraints. It lacks details on order state requirements but is otherwise adequate for a replace-order operation.

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 100% with individual parameter descriptions. The description adds overarching context: it modifies price, type, or time in force, and that legs are not modifiable. This adds value beyond the schema's per-parameter details.

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 modifies a working order's price, type, or time in force, and distinguishes from siblings like create_order (creation) and cancel_order (cancellation). It also explicitly notes that legs cannot be modified, adding precision.

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?

Provides explicit when-to-use: modifying a working order's price, type, or time in force. Also gives clear when-not-to-use: legs cannot be modified, advising to cancel and re-create instead. This effectively guides the agent away from incorrect usage.

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