Skip to main content
Glama

Zotero Update Annotation

zotero_update_annotation

Update an existing Zotero annotation’s highlight text, comment, color, or tags—including adding or removing tags—to correct and refine notes while preserving its PDF position.

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.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "annotation_key": "<annotation_key>"
    },
    "name": "zotero_update_annotation"
  }
}

Input Schema

NameRequiredDescriptionDefault
tagsNo
textNo
colorNo
commentNo
add_tagsNo
remove_tagsNo
annotation_keyYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A3.7/5.0
Behavior3/5

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

With no annotations supplied, the description carries the full burden. It does add genuine behavioral context beyond the schema: position, page and sortIndex are anchored to PDF/EPUB geometry and cannot be changed, and tags versus add_tags/remove_tags are mutually exclusive. It omits, however, what happens to fields not supplied (left unchanged vs nulled), whether write authorization is required, and what the call returns.

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 tight sentences, front-loaded with purpose, then editable fields, then the tag-editing rule, then the immutability caveat. No filler or repetition.

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?

For a 7-parameter mutation tool with no annotations and no output schema, the description covers the important ground: which fields are editable, how tags can be edited two ways, and what cannot be changed. The remaining gap is the semantics of omitted parameters and any write-authorization requirement, which matters given the sibling zotero_authorize_local_writes.

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 must compensate, and it largely does: it explains text, comment, color (with the hex format '#ffd400'), tags, add_tags and remove_tags, plus the mutual exclusivity rule. Only annotation_key is left unexplained, and the requiredness/null-default behavior of the optional fields is not addressed.

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

Purpose4/5

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

The description opens with a specific verb and resource ("Update an existing Zotero annotation") and immediately enumerates the editable fields, so an agent knows exactly what the tool touches. It does not explicitly distinguish itself from siblings like zotero_batch_update or zotero_create_annotation, but the word "existing" and the field list make the scope unambiguous.

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

Usage Guidelines3/5

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

Usage is only implied: the description explains the internal choice between wholesale tag replacement and incremental add/remove, which is real guidance, but it never says when to pick this tool over zotero_batch_update or zotero_update_item, nor does it state prerequisites such as authorization for writes.

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