Skip to main content
Glama

Zotero Update Annotation

zotero_update_annotation

Update an existing Zotero annotation's text, comment, color, or tags. Replace tags entirely or add/remove specific ones; position and page cannot be changed.

Instructions

Update an existing Zotero annotation. Editable fields: text (highlight text), comment, color (hex like '#ffd400'), and tags. Tags can be replaced wholesale via tags, or edited incrementally via add_tags/remove_tags (mutually exclusive with tags). Position/page/sortIndex are anchored to the PDF/EPUB geometry and are not editable.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
tagsNo
textNo
colorNo
commentNo
add_tagsNo
remove_tagsNo
annotation_keyYes

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A4.2/5.0
Behavior3/5

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

With no annotations, the description carries the full burden. It usefully discloses that geometry fields are anchored and non-editable and explains the tag mutation modes. However, it does not say whether passing null leaves a field unchanged or clears it, and it does not describe response/error behavior or permissions.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Three sentences, each doing real work: purpose, editable fields, and non-editable constraints. No filler or repetition of the schema; front-loaded with the most important fact. This is near-ideal density.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given an output schema exists and sibling names are known, the description covers the calling decision: which field parameters mean, how tags work, and which properties cannot be changed. The missing piece is update semantics around null values and error cases, which would matter for a mutation tool, so it is strong but not fully complete.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 0%, so the description is the only source of parameter meaning. It defines text/comment/color with a concrete hex example and explains the three tag-related parameters and their mutual exclusivity. The required `annotation_key` is only implied by 'existing annotation', and null/default behavior is not explained, so not perfect.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

Opens with a specific verb and object ('Update an existing Zotero annotation'), then lists exactly which fields are editable. Explicitly excluding position/page/sortIndex sets it apart from create/delete/geometry tools. No ambiguity about what this tool does.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The phrase 'existing' plus the requirement of an `annotation_key` signals this is for modifying an already-created annotation, not creating one. It also gives actionable sub-guidance for tags: wholesale replacement via `tags` vs incremental `add_tags`/`remove_tags`, and states they are mutually exclusive. It does not explicitly name sibling tools or give when-not-to-use conditions, but the context is clear.

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