Skip to main content
Glama

heygen_get_video_status

Read-onlyIdempotent

Check the generation status of a HeyGen video using its video ID to track processing progress and know when the video is ready.

Instructions

Check the generation status of a HeyGen video by video ID.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "api_key": "<api_key>",
      "video_id": "<video_id>"
    },
    "name": "heygen_get_video_status"
  }
}

Input Schema

NameRequiredDescriptionDefault
api_keyYesHeyGen API key
video_idYesVideo ID returned by heygen_create_avatar_video

Schema Changelog

Changes observed during successful MCP inspections.

  1. Addedv0.1.5

TDQS

A3.5/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true, idempotentHint=true, destructiveHint=false, so the safety profile is covered. The description adds no context on polling cadence, status value set, or whether a video URL is returned once complete, which is the useful behavior 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.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

A single front-loaded sentence with zero waste; verb, resource, and identifier all appear immediately.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness3/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a simple read tool with full schema and annotations, the essentials are present, but with no output schema the description should explain what a 'status' looks like (e.g., pending/completed/failed, resulting video URL). That is a real gap for a status-check tool.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 100% and both parameters are documented, including that video_id comes from heygen_create_avatar_video. The description names video ID but adds no format or usage detail beyond the schema; baseline 3 applies.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

States the specific verb ('Check'), the resource ('generation status of a HeyGen video'), and the identifying key ('by video ID'). It is clearly distinguishable from heygen_create_avatar_video and the list_* siblings, though it doesn't explicitly name an alternative.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines3/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description implies polling after video creation, but never states when to call it versus alternatives or that it's intended for polling. Usage is inferred rather than declared.

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

Deploy Server

Other Tools