Update Work Order Contract Detail Line Item

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

The description discloses the partial update behavior and return of the modified object, beyond the annotations (readOnlyHint=false, destructiveHint=false). It also provides the HTTP method (PATCH) via the endpoint path. 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 concise with four sentences, front-loaded with purpose. Minor redundancy in the second sentence ('Use this to update an existing Commitments' vs first sentence), but overall efficient.

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 purpose, partial update, required params, and API location. However, it lacks details about the nested 'contract_detail_line_item' object (e.g., typical fields), and there is no output schema. Annotations provide some context but the description could be more complete.

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 baseline is 3. The description restates required parameters but does not add meaning about parameter values, formats, or constraints beyond the schema. The note about partial update is a usage guideline, not parameter semantics.

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 (update) and resource (Detail Line Item in Work Order Contract), and distinguishes from siblings by specifying 'Work Order Contract' and 'Commitments'. It also includes the endpoint path.

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 notes 'only the supplied fields are changed' indicating partial update usage. It lists required parameters but does not explicitly compare to alternative update tools like 'update_work_order_contract' or 'update_purchase_order_contract_detail_line_item'.

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