Skip to main content

HeyGen MCP Server for AI Video Creation

Project description

Heygen MCP Server ALPHA

A MCP (Model Control Protocol) server providing tools to interact with the Heygen API (V1 & V2), compatible with Claude Desktop and usable as a Python library.

License: MIT

Note: This project is in early development. While we welcome community feedback and contributions, please be aware that official support is limited.

Features

  • Provides MCP tools for Heygen API actions:
    • Get Remaining Credits
    • List Voices
    • List Avatar Groups
    • List Avatars in a Group
    • Generate Avatar Video
    • Check Video Status
  • Configurable Heygen API key via command-line or environment variable (HEYGEN_API_KEY).
  • Asynchronous API client using httpx and pydantic.
  • Command-line interface for starting the server.
  • Designed for use with Claude Desktop extensions.
  • Can be imported and used as a Python library.
  • Available as a UV tool - run with uvx heygen-mcp

Installation

Prerequisites

  • Python 3.10 or higher
  • A Heygen API key (get one from Heygen). Includes 10 Free Credits per Month

Installing uv

uv is a fast Python package installer and resolver that we recommend for installing this package.

macOS or Linux:

# Install with the official installer script
curl -LsSf https://astral.sh/uv/install.sh | sh

# Or via Homebrew (macOS)
brew install uv

Windows:

# Install with the official installer script in PowerShell
irm https://astral.sh/uv/install.ps1 | iex

# Or via Scoop
scoop install uv

For other installation methods, see the uv documentation.

Usage

Quickstart with Claude Desktop

  1. Get your API key from HeyGen.
  2. Install uv package manager (see Installing uv section above).
  3. Go to Claude > Settings > Developer > Edit Config > claude_desktop_config.json to include the following:
{
  "mcpServers": {
    "HeyGen": {
      "command": "uvx",
      "args": ["heygen-mcp"],
      "env": {
        "HEYGEN_API_KEY": "<insert-your-api-key-here>"
      }
    }
  }
}

If you're using Windows, you'll need to enable "Developer Mode" in Claude Desktop to use the MCP server. Click "Help" in the hamburger menu at the top left and select "Enable Developer Mode".

Available MCP Tools

The server provides the following tools to Claude:

  • get_remaining_credits: Retrieves the remaining credits in your Heygen account.
  • get_voices: Retrieves a list of available voices from the Heygen API (limited to first 100 voices).
  • get_avatar_groups: Retrieves a list of Heygen avatar groups.
  • get_avatars_in_avatar_group: Retrieves a list of avatars in a specific Heygen avatar group.
  • generate_avatar_video: Generates a new avatar video with the specified avatar, text, and voice.
  • get_avatar_video_status: Retrieves the status of a video generated via the Heygen API.

Development

Running with MCP Inspector

To run the server locally with the MCP Inspector for testing and debugging:

uv --with "mcp[cli]" dev heygen_mcp/server.py

This will start the server in development mode and allow you to use the MCP Inspector to test the available tools and functionality.

Roadmap

  • Tests
  • CICD
  • Photo Avatar APIs Support
  • SSE And Remote MCP Server with OAuth Flow
  • Translation API Support
  • Template API Support
  • Interactive Avatar API Support

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

License

This project is licensed under the MIT License - see the LICENSE file for details.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

heygen_mcp-0.0.1.tar.gz (10.5 kB view details)

Uploaded Source

Built Distribution

heygen_mcp-0.0.1-py3-none-any.whl (9.2 kB view details)

Uploaded Python 3

File details

Details for the file heygen_mcp-0.0.1.tar.gz.

File metadata

  • Download URL: heygen_mcp-0.0.1.tar.gz
  • Upload date:
  • Size: 10.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.6.14

File hashes

Hashes for heygen_mcp-0.0.1.tar.gz
Algorithm Hash digest
SHA256 213552ea34db864fcb86bb1909407e6ae60db3471fa86746e05f2eb494ffd757
MD5 a59d9b42e825b3486a6ec5bfdb65e588
BLAKE2b-256 07720984fdf48df1b086e9e1b54782e608c061c6b0c758df590c0bdbe440fa9f

See more details on using hashes here.

File details

Details for the file heygen_mcp-0.0.1-py3-none-any.whl.

File metadata

File hashes

Hashes for heygen_mcp-0.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 c025aabc42dd886770a7a607f974c8c2ddd179b4c72c717acfce3e0499344eee
MD5 8cfb835730e9ca75c2ee8d9ab0c09a36
BLAKE2b-256 a412d5985c0bbf38e8b73fdfcfa1dcd424be150ae297ef5c7e151b1a4787d98b

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page