insert_zotero_citation

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

No annotations are provided, so the description carries the full burden and does so richly. It discloses the resulting placeholder text, the need for Refresh, auto-backup behavior, atomic save, read-only access to Zotero, and refusal conditions. No major side effect is left ambiguous.

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 dense but every sentence carries operational meaning, with the core action and field type front-loaded. It avoids filler and does not simply restate the input schema.

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 complex, 9-parameter tool, the description covers workflow, side effects, failure modes, and safety context well, and an output schema exists so return-value details need not be repeated. Minor gaps remain around optional parameters such as occurrence and db_path, which keeps it from being fully exhaustive.

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 0%, yet the description compensates by mapping item_keys to search_zotero_library, page to locator, prefix/suffix to attached text, and backup to rotation-only behavior. It does not explain occurrence or db_path, but the most semantically important parameters are well covered.

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?

States a precise operation: 'Insert a REAL Zotero citation field (ADDIN ZOTERO_ITEM CSL_CITATION) after anchor_text,' and explicitly distinguishes it from generic citation insertion by noting it is built exactly as the Zotero Word plugin builds it. This clearly separates it from siblings like insert_citation or add_source.

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?

Gives explicit workflow guidance: item_keys come from search_zotero_library, detect_citation_system should run first on unfamiliar documents, and multi-item citations are refused rather than guessed. It also states preconditions such as 'only ever read' the Zotero database and refusal of documents open in Word.

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