Skip to main content
Glama

Zotero Search By Citation Key

zotero_search_by_citation_key

Retrieve a single Zotero item's metadata using its exact BetterBibTeX citation key; returns not-found if no matching key exists.

Instructions

Look up a single Zotero item by its BetterBibTeX citation key (e.g. 'Smith2024' or 'cladderMicus2018'). Returns that one item's metadata, or a not-found message if no item has that key. citekey: the citation key exactly as assigned by BetterBibTeX (case-sensitive). In local mode: queries the running Better BibTeX plugin via its HTTP API (Zotero desktop must be running and have BBT installed). In web mode: scans the 'Extra' field of items for 'Citation Key:' lines — slower, and may miss items whose keys aren't persisted to Extra. Requires the Better BibTeX plugin in the user's Zotero install. For partial-key or free-text lookup, use zotero_search_items. Example: zotero_search_by_citation_key(citekey='hasan2026mcp') → metadata for that single item.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
citekeyYesThe BetterBibTeX citation key to search for (e.g., 'Smith2024')

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A5/5.0
Behavior5/5

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

No annotations are provided, so the description carries the full burden. It discloses the return behavior (metadata or not-found message), local/web execution differences, the requirement that Zotero desktop and Better BibTeX are running, and the limitation that web mode may miss keys not persisted to Extra. This is thorough for a read-style lookup tool.

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 front-loaded with the core purpose, then efficiently covers modes, limitations, and alternatives. Every sentence adds useful information, and the final example reinforces practical usage without padding.

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 that the tool has a single parameter, an output schema is present, and there are many sibling search tools, the description is complete. It covers prerequisites, mode-specific behavior, failure cases, alternative routing, and parameter nuance, leaving no critical gap for correct invocation.

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 the schema already describes citekey at 100% coverage, the description adds crucial semantics beyond it: the key must be 'exactly as assigned by BetterBibTeX' and is 'case-sensitive.' It also provides a concrete invocation example, which helps the agent construct valid calls.

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 action ('Look up a single Zotero item by its BetterBibTeX citation key') and gives concrete examples. It clearly distinguishes this tool from sibling zotero_search_items by emphasizing exact-key lookup versus partial/free-text search.

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?

The description explicitly says when not to use this tool: 'For partial-key or free-text lookup, use zotero_search_items.' It also explains the two operational modes (local vs web) and the plugin requirement, so an agent can determine when invocation is appropriate.

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