qbo_credit_memos_update

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

No annotations are provided, so the description must cover behavioral details. It mentions 'sparse-update' implying only provided fields change, and notes required fields. However, it does not explicitly state that omitted fields remain unchanged, or disclose any side effects, permissions, or response behavior. Adequate but not comprehensive.

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 two sentences, front-loaded with the main action, and contains no extraneous information. Every word earns its place.

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 (9 parameters, nested objects) and no output schema, the description lacks explanation of the return value (e.g., the updated record). It references Line briefly but relies on schema for details. Adequate but incomplete for a tool with nested parameters.

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 description coverage is 100%, so baseline is 3. The description adds minimal extra meaning: it reinforces the sparse nature and the necessity of SyncToken and Id. However, most parameter details are already in the schema, and the description does not significantly enhance understanding.

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 'Sparse-update an existing CreditMemo record', specifying the verb (sparse-update) and resource (CreditMemo). It effectively distinguishes from sibling tools like qbo_credit_memos_create and qbo_credit_memos_list.

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 context: 'Only provided fields are changed; Id and SyncToken are required.' It implies when to use the tool (partial updates) and notes the prerequisite of fetching the record for SyncToken. However, it does not explicitly exclude other tools or mention alternatives.

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