wafeq_credit_notes_line_items_partial_update

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

Annotations already provide the write nature (readOnlyHint=false), non-destructive hint, open-world hint, and idempotency hint. The description adds the HTTP verb and 'partial update' semantics, but does not disclose any additional behavior such as field-level merge behavior, validation effects, or permission requirements.

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 repeats the same information three times: the first line, the standalone sentence 'Partial update credit note line item', and the following 'Endpoint for partially updating an existing credit note line item.' The useful path information is present but the redundancy wastes space.

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?

With no output schema and only moderate schema description coverage, the description should clarify the response behavior, the partial-update semantics, and any important side effects. It does none of these. The reader is left to infer what the API returns and what happens to unspecified fields.

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 endpoint path adds meaning by showing that credit_note_id and id are path parameters. The nested body properties are individually described in the schema. However, the description itself adds no parameter-level guidance, and the body description in the schema is oddly phrased about augmenting custom_fields rather than explaining the partial-update payload.

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 operation ('partial update'), the resource ('credit note line item'), and the exact HTTP method and path (PATCH /credit-notes/{credit_note_id}/line-items/{id}/). This distinguishes it from the sibling full-update and retrieve tools based on the 'partial' qualifier and resource naming.

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?

Usage context is only implied by the phrase 'partially updating an existing credit note line item.' The description does not explicitly explain when to prefer this over the sibling wafeq_credit_notes_line_items_update, nor does it state that only provided fields are affected while omitted fields are left unchanged.

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