Skip to main content
Glama

Zotero Get Pdf Outline

zotero_get_pdf_outline

Retrieve a PDF's table of contents with page numbers from a Zotero item or attachment to find the pages you need before targeted reading.

Instructions

Return a PDF's table of contents with page numbers, usually under 200 tokens: find the pages you need, then read them with zotero_read_pdf_pages instead of the full text. item_key: the parent item or the PDF attachment. Says so when the PDF has no outline. PDFs only; needs PyMuPDF (the [pdf] extra).

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": {
      "item_key": "<item_key>"
    },
    "name": "zotero_get_pdf_outline"
  }
}

Input Schema

NameRequiredDescriptionDefault
item_keyYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A4.6/5.0
Behavior4/5

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

With no annotations, the description carries the full burden and does well: it discloses approximate output size (usually under 200 tokens), the empty-result behavior ('Says so when the PDF has no outline'), and a runtime dependency ('needs PyMuPDF (the [pdf] extra)'). It stops short of noting whether the item_key must be a PDF rather than any attachment type, or what happens on a mis-typed key.

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?

Four short sentences, each carrying distinct information — purpose, workflow, parameter, edge case, scope, dependency. The primary action is front-loaded and there is no filler.

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 one-parameter read tool with no output schema and no annotations, the definition covers purpose, routing, edge case, and dependency. Only minor gaps remain: the shape of the returned outline and behavior for non-PDF items are not spelled out.

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 coverage is 0%, so the description must compensate, and it does: item_key is described as 'the parent item or the PDF attachment,' resolving the real ambiguity of which key form to pass. It does not mention the key format (e.g., a short item key versus an integer ID).

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?

States a specific verb and resource: 'Return a PDF's table of contents with page numbers.' It also differentiates itself from the full-text sibling by pointing to zotero_read_pdf_pages for page bodies, so an agent can distinguish the two without opening a schema.

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

Usage Guidelines5/5

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

Gives an explicit workflow and alternative: orient with the outline, find the pages you need, then read them with zotero_read_pdf_pages instead of the full text. It also states the scope restriction 'PDFs only,' which excludes non-PDF items.

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