Sync Potential Change Order Line Items

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

Annotations indicate mutation (readOnlyHint false), non-destructive, and open-world hint. The description adds that it performs partial updates ('only the supplied fields are changed') and returns the modified object. However, the description has an inconsistency mentioning 'updates the specified Change Orders' instead of line items, which reduces clarity.

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 relatively concise with three sentences plus endpoint details. It front-loads the main action. The inclusion of API path and reference adds some redundancy but is not overly verbose.

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 complexity of a sync batch operation and no output schema, the description could provide more detail on the 'updates' structure or error handling. It mentions the return object vaguely and links to external docs, which partially compensates.

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%, so parameters are already documented. The description redundantly lists required parameters without adding additional meaning about their format or usage 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 states it 'creates or updates a batch of Potential Change Order Line Items', which is a specific verb and resource. It distinguishes from sibling tools like 'create_potential_change_order_line_item' (single item) and 'sync_potential_change_orders' (different resource). However, there is minor inconsistency when it says 'Use this to update an existing Change Orders', which may confuse.

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 mentions it is for batch operations and links to documentation on sync actions. It lists required parameters. However, it does not explicitly state when to use this tool versus alternatives (e.g., single line item updates) or when not to use it.

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