Zotero Get Pdf Outline

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. It discloses the return format, the graceful handling of missing outlines, the dual key acceptance with automatic resolution, the PyMuPDF dependency, compatibility with local/web modes, and read-only nature. This is thorough and goes beyond a basic statement of function.

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

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

The description is long but every sentence adds value. It front-loads the core purpose, then covers usage, parameter semantics, scope, dependencies, and an example. There is no redundancy or filler; the structure logically guides the agent from understanding to invocation.

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

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

For a single-parameter tool, the description is remarkably complete. It covers the return format (hierarchical markdown with page numbers), the edge case of no outline, input key flexibility, dependency requirements, mode support, and read-only status. Given the output schema exists and the description aligns with it, nothing essential is missing for correct invocation.

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

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

The schema provides no description for the single parameter item_key (0% coverage). The description compensates fully by explaining that it accepts either the PDF attachment key or the parent item key, that resolution is automatic, and how to find the correct key using zotero_get_item_children. This adds crucial meaning beyond the bare schema.

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

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

The description clearly states the tool extracts the table of contents from a PDF attachment and returns a hierarchical markdown list with page numbers. It uses specific verbs and resources, and distinguishes itself from zotero_get_item_fulltext by positioning it as a lightweight orienting step. The purpose is unambiguous and well-differentiated from sibling tools.

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

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

The description explicitly recommends using this tool before zotero_get_item_fulltext, with a concrete rationale (token size comparison: <200 vs 10K+). It also states the PDF-only scope and that it returns a friendly 'no outline' message instead of failing, which guides when to expect success or failure. No alternatives are named for EPUBs, but the exclusion is clear.

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