updateCustomers

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

Describes patch behavior: only keys included in customer are replaced, omitted keys unchanged. Annotations indicate destructive and idempotent, and description adds useful detail without contradiction.

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 sentences: first states purpose and scope, second explains mechanics and cross-references. Every sentence is essential and well-placed.

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?

Covers purpose, mechanics, and alternatives. Lacks mention of output or errors, but cross-references to getCustomer indirectly address output. Adequate for a patch tool with simple semantics.

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?

Adds meaning beyond schema by explaining the partial update semantics (patch). Schema has 50% coverage; description compensates with clear explanation of how parameters interact.

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?

States it applies a differential patch to customer attributes (name, contact, address, etc.). Explicitly distinguishes from siblings like updateCustomerMembership, postCustomerPoints, getCustomer, getCustomers.

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?

Clearly says when to use (to update customer attributes via patch) and provides explicit alternatives for membership changes, point balance, viewing current values, and condition search.

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