Skip to main content
Glama

Zotero Get Annotations

zotero_get_annotations

Extract highlights and notes from Zotero items or your library, with PDF fallback for missing annotations. Output as markdown or JSON.

Instructions

Get annotations (highlights and attached notes on PDF/EPUB attachments) for a specific item or across the active Zotero library. item_key: pass the parent item key OR an attachment key — both work; attachment-to-parent resolution is automatic. ALWAYS pass item_key when you know which item you want; calling without it returns every annotation in the library (potentially thousands). use_pdf_extraction=True falls back to direct PDF parsing when the Zotero API has no stored annotation record — useful for annotations made outside Zotero desktop. limit: cap on annotations returned; None (default) returns all. format='markdown' (default) returns a readable list; format='json' returns normalized records with stable keys for downstream scripts and other MCP tools. Uses Better BibTeX when Zotero desktop is running locally, otherwise the Zotero web API. Example: zotero_get_annotations(item_key='ABC12345') → every highlight/note on that paper.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
limitNoMaximum number of annotations to return
formatNo``markdown`` for human-readable output or ``json`` for normalized structured records.markdown
item_keyNoOptional Zotero item key/ID to filter annotations by parent item
use_pdf_extractionNoWhether to attempt direct PDF extraction as a fallback

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A4.8/5.0
Behavior5/5

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

With no annotations provided, the description carries the full burden of behavioral disclosure, and it excels: it explains automatic attachment-to-parent resolution, the fallback to PDF extraction, the difference between markdown and json output (with 'stable keys for downstream scripts'), and the backend selection (Better BibTeX vs web API). It also warns about the scale of results without item_key. This is thorough, non-obvious behavior that an agent needs to know.

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?

The description is a single dense paragraph, front-loaded with the core purpose and scoping rule, then covering parameters and behavior. It includes an example at the end for clarity. Every sentence adds value—no filler, no repetition of schema details. It is concise yet complete for a tool with four optional parameters.

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

Completeness5/5

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

Given the tool's moderate complexity (4 optional params, no required, output schema present), the description covers all necessary context: main use, key parameter behavior, fallback logic, output formats, backend selection, and a concrete example. The output schema handles return structure details, so the description need not enumerate return fields. Nothing an agent needs to call this correctly is missing.

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?

Although schema coverage is 100%, the description adds significant meaning beyond the schema. For item_key it clarifies that either parent or attachment keys work and resolution is automatic. For limit it explains the default returns all. For format it contrasts human-readable vs machine-stable output. For use_pdf_extraction it explains the fallback scenario. This goes well beyond the baseline 3 and provides actionable parameter semantics.

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 ('Get') and resource ('annotations (highlights and attached notes on PDF/EPUB attachments)'), and clarifies scope ('for a specific item or across the active Zotero library'). It distinguishes itself from sibling tools like zotero_get_notes by specifying it targets annotations on attachments, not standalone notes. The purpose is immediately clear and not a tautology.

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 description provides explicit usage guidance: 'ALWAYS pass item_key when you know which item you want' and warns against calling without it ('returns every annotation in the library (potentially thousands)'). It also explains when to use use_pdf_extraction=True ('when the Zotero API has no stored annotation record'). However, it does not explicitly mention alternative sibling tools (e.g., zotero_get_notes or zotero_synthesize_annotations) or state when to prefer this tool over them, so it stops short of a full routing guide.

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