zotero_update_annotation

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

With no annotations, the description reveals that certain fields (position/page/sortIndex) are non-editable, adding important constraints. It also explains tag update modes (wholesale vs incremental). However, it does not cover permissions, rate limits, or return behavior.

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 three sentences with no redundancy. It front-loads the purpose, then covers editable fields and special tag behavior. Every sentence adds value.

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 7 parameters and 1 required, the description explains all user-facing editable fields and tag mechanics. It leaves out error handling and output details, but the presence of an output schema mitigates the need for return value explanation.

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 schema has 0% description coverage, yet the description adds meaning by explaining text as 'highlight text', color hex format, and tag handling (wholesale via `tags` vs incremental via `add_tags`/`remove_tags`). This goes well beyond the raw schema.

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 tool updates an existing Zotero annotation and lists editable fields. It is specific enough to distinguish from create/delete tools, though it does not explicitly compare with sibling tools like zotero_update_note, which target a different resource.

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 implies usage for modifying annotations but does not provide explicit when-to-use, alternatives, or prerequisites. It does offer parameter-level guidance on tag handling (mutual exclusivity), which partly compensates.

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