Annotate a media asset

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

Annotations (readOnlyHint=false, idempotentHint=false) indicate mutation, but the description adds return info: 'Returns the new annotation (with a stable id) and the total count.' No contradiction with annotations.

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 sentences that efficiently convey purpose and return behavior. No unnecessary words, clear and front-loaded.

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 6 parameters, 50% schema coverage, no output schema, and few annotations, the description explains the return value but fails to describe key parameters like 'project', 'name', and 'author'. The term 'pin-based' could be elaborated. Adequate but incomplete.

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 50% (3 of 6 parameters described). The description restates x/y coordinates but adds no new meaning. Required parameters 'project' and 'name' are not described, and 'author' is also missing. The description does not compensate for the low schema coverage.

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 action ('Add a pin-based comment/annotation') and the resource ('to an asset'). It distinguishes from sibling tools like add_media_comment by specifying 'pin-based' and optional coordinates.

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 implies usage for pinning annotations on assets but does not explicitly state when to use this tool versus alternatives like add_media_comment or remove_annotation. No when-not or conditions are provided.

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