Skip to main content
Glama

Zotero Get Annotations

zotero_get_annotations

Retrieve highlights and their comments from Zotero for one item or an entire library. Optionally parse the PDF directly to capture annotations made in other readers.

Instructions

Get PDF/EPUB annotations (highlights and their comments) for one item, or for the whole active library when item_key is omitted (can be thousands, so pass item_key when you know it). item_key: the parent item or an attachment. use_pdf_extraction=True parses the PDF itself when Zotero has no stored annotations (e.g. ones made in another reader). limit: default all. format: 'markdown' (default) or 'json' (normalized records).

Tool call template

This tool declares no required parameters. Add optional parameters from the input schema as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {},
    "name": "zotero_get_annotations"
  }
}

Input Schema

NameRequiredDescriptionDefault
limitNo
formatNomarkdown
item_keyNo
use_pdf_extractionNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A4.4/5.0
Behavior4/5

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

With no annotations provided, the description carries the burden and does well: it discloses the large-result risk, the PDF-parsing fallback behavior, the default-unlimited limit, and output format choices. It stops short of explicitly stating read-only status or error behavior, but the operation is clearly framed as retrieval.

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

Conciseness4/5

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

The description is compact and front-loads the primary purpose before parameter notes. It uses telegraphic fragments for each parameter but remains clear and avoids unnecessary 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?

Given four optional parameters, no annotations, and no output schema, the description covers the key calling decisions and output format choices. It could add a brief note on read-only behavior or authentication, but is otherwise complete for correct invocation.

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

Parameters5/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 does: it defines item_key as a parent item or attachment, explains use_pdf_extraction's fallback role, states that limit defaults to all, and describes format values and markdown/json output meaning.

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?

The description states a specific verb and resource: 'Get PDF/EPUB annotations (highlights and their comments)' and clarifies scope for one item versus the whole active library. This lets an agent distinguish it from siblings such as zotero_get_item_fulltext and zotero_synthesize_annotations without opening the schema.

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?

It gives clear conditions for key parameters: pass item_key when known because library-wide results can be thousands, and use use_pdf_extraction=True when Zotero has no stored annotations. It does not explicitly name alternative sibling tools to use instead, but the usage context is strong.

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