xero_update_credit_note

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

With no annotations, the description should disclose behavioral traits like modification, authentication requirements, or side effects. It only describes API routing, not what the operation does at a behavioral level.

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 short but not effectively structured. It leads with a tautology ('Xero connector operation update_credit_note') and wastes space on routing details. Every sentence should earn its place, but here they are uninformative.

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?

Although an output schema exists, the description fails to provide necessary context for an update operation, such as what field can be updated, prerequisites, or confirmation of changes. It is incomplete for effective agent use.

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 single parameter 'arguments' is described as a 'JSON string of arguments for the connector operation', adding minimal meaning. The schema has 0% description coverage, and the description does not detail what keys or values are expected in the JSON string.

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 only states it is a 'Xero connector operation update_credit_note' and mentions routing details. It does not explicitly state that the tool updates a credit note in Xero, leaving the purpose vague and relying solely on the name.

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?

No guidance is provided on when to use this tool versus alternatives like xero_create_credit_note or xero_list_credit_notes. The description omits any context about prerequisites or typical use cases.

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