zotero_create_annotation

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

With no annotations, description carries full burden. It discloses requirements (PyMuPDF, writable library), explains that text must exist in the text layer (scanned PDFs won't work), and how coordinates are derived. Lacks details on error behavior (e.g., text not found) but is otherwise thorough.

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?

Well-structured with main purpose first, then differentiator, parameter details, requirements, and example. Slightly verbose in repeating schema descriptions but every sentence earns its place.

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?

Covers purpose, when to use, parameters, prerequisites, and provides an example. Output schema exists so return values are not needed. Missing error handling details (e.g., if text not found) but still quite complete for a creation tool.

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?

Schema coverage is high (all params described), but description adds critical context: attachment_key is NOT the parent key, page indexing differs for PDF vs EPUB, and text is exact for coordinate lookup. Example further clarifies usage.

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?

Description clearly states it creates a TEXT-HIGHLIGHT annotation on PDF/EPUB attachments, explicitly distinguishing from the sibling tool zotero_create_area_annotation for rectangular selections. The verb 'create', resource 'annotation', and type 'text-highlight' are all precise.

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?

Provides explicit when-to-use (for text highlights) and when-not-to-use (for rectangular selections, use area annotation). Also includes prerequisites (PyMuPDF, writable library) and guidance on finding attachment keys via zotero_get_item_children.

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