get_avatar_video_status

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

No annotations provided; description adds behavioral context about potential delays and alternative viewing via URL. Lacks details on error states, input validation, or polling behavior.

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 with no fluff; first sentence defines purpose, second adds useful context. Every sentence earns 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?

Adequate for a simple tool but incomplete: no mention of return format (status values, possible errors) or additional details about the URL. More context would reduce ambiguity.

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?

Only one parameter (video_id) with 0% schema description coverage. Description does not explain how to obtain video_id or its expected format, relying on obviousness.

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 retrieves the status of a video generated via the HeyGen API, using a specific verb and resource. It distinguishes from sibling tools like generate_avatar_video and get_avatar_groups.

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?

Implicitly indicates it is used after video generation, with context on time delays and a fallback URL. No explicit exclusions or alternative guidance, but context is clear enough.

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