workflow_sync_highlights

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

No annotations are provided, so the description carries full responsibility. It discloses key behaviors: it replaces existing highlight content, leaves metadata untouched, and returns a JSON with success, count, and message. This level of detail adequately informs an agent of side effects and safety profile.

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 concise and well-structured. It opens with a clear one-sentence purpose, followed by usage guidance, then a structured Args section with brief but sufficient definitions, and finally a Return type description. Every sentence adds value without redundancy.

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?

Given the tool has 2 simple parameters, no output schema, and no annotations, the description covers the core behavior, parameter semantics, and return format. It could be slightly more explicit about prerequisites (e.g., Zotero and Obsidian connection) and the fact that this is a write operation, but overall it is largely complete.

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?

With 0% schema description coverage, the description fully compensates. It defines 'citekey' as 'Better BibTeX citekey (used to locate the Obsidian note)' and 'item_key' as 'Zotero internal item key (needed to fetch annotations).' This adds crucial meaning beyond the parameter names alone.

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's action: 'Pull PDF annotations from Zotero and update the 'Highlights from Paper' section of the corresponding Obsidian literature note.' It uses a specific verb ('pull', 'update') and resource ('PDF annotations', 'Obsidian literature note'), and this purpose is distinct from sibling tools like workflow_sync_check or workflow_write_note.

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 provides explicit usage context: 'Run this any time after you have highlighted the PDF in Zotero.' It also clarifies behavioral constraints: 'Existing highlight content is replaced; metadata sections are untouched.' However, it does not explicitly state when not to use the tool or mention alternatives, though the specific workflow context makes the guidance clear.

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