Edit a text media asset

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

The description discloses that the prior copy is archived, indicating non-destructive behavior, which aligns with destructiveHint=false. However, it does not detail other behavioral aspects like required permissions, response format, or concurrency handling, but adds value beyond 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 efficient sentences that front-load the main action and operations, include an important behavioral note (archiving), and reference sibling tools. No extraneous information, earning its place.

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 no output schema, the description adequately covers the operation and archiving behavior. However, it does not specify what the tool returns (e.g., confirmation, version ID) or provide error handling context. It is minimally complete but could be more informative.

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?

The description mentions find, replace, append, and prepend operations but does not explain the 'project' and 'name' required parameters, nor does it provide syntax or format details. With only 50% schema description coverage, the description underperforms in adding meaning beyond the schema.

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 edits text/report assets with specific operations (find/replace, append, prepend) and archives prior versions. It explicitly distinguishes from sibling tools for images (refine_media, image generation), making its purpose unambiguous.

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 guidance on when to use (for text/report assets) and when not (use refine_media or image generation for images). It implies the tool creates new versions and archives old ones, but does not enumerate all exclusions or prerequisites.

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