manage_annotation

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

Annotations already declare readOnlyHint=false, destructiveHint=true and idempotentHint=true. The description adds real behavioral context by disclosing that an update replaces the prior note content, which is exactly the destructive semantic an agent needs to see before overwriting. It still omits whether the target document must already be in the library and what the response contains.

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?

Two short sentences, with the core action stated first and the destructive overwrite caveat immediately after. No filler and nothing redundant with the title or 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?

With annotations covering write/destructive/idempotent signals and no output schema to explain, the main open questions are permissions on the library and what the call returns. The description addresses the update semantics but leaves those gaps, making it adequate rather than 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?

Schema description coverage is 75% with three self-explanatory required fields (library_id, bibcode, content), so the schema carries most of the semantic load. The description adds the replace-vs-append behavior of content but says nothing about response_format, which has an enum and no schema description.

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 gives a specific verb pair and resource: add or update an annotation/note for a document in a library. The write orientation implicitly separates it from the read/delete siblings get_annotation and delete_annotation, but it never names them, so differentiation is inferred rather than stated.

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?

Usage is implied by 'Add or update' plus the note that updating replaces existing content, so an agent can tell this is the create/overwrite path. There is no explicit guidance on when to prefer it over get_annotation, delete_annotation, or manage_documents, and no stated prerequisites such as required library permissions.

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