使用说明
项目简介
HeyGen MCP Server 是一个基于 Model Context Protocol (MCP) 的服务器实现,它将 HeyGen API 的功能以 MCP 工具的形式提供给 LLM 客户端,例如 Claude Desktop 或其他 Agent 应用。通过这个服务器,LLM 可以调用 HeyGen API 生成虚拟形象和视频。
主要功能点
- 获取 HeyGen 账户剩余额度: 查询您的 HeyGen 账户剩余的 API 调用额度。
- 获取可用声音列表: 获取 HeyGen API 提供的可用声音列表,用于视频生成。
- 获取虚拟形象群组列表: 检索 HeyGen 虚拟形象群组的信息。
- 获取虚拟形象群组中的虚拟形象列表: 查询特定虚拟形象群组包含的虚拟形象。
- 生成虚拟形象视频: 使用指定的虚拟形象、文本和声音生成新的虚拟形象视频。
- 获取虚拟形象视频生成状态: 查询通过 HeyGen API 生成的视频的状态。
安装步骤
-
前提条件:
- Python 3.10 或更高版本
- HeyGen API 密钥 (您可以从 HeyGen 官网 获取,每月包含 10 个免费额度)
-
安装 'uv' 包管理器 (推荐): 按照仓库 README.md 中的 Installing uv 部分的指引,根据您的操作系统 (macOS, Linux 或 Windows) 安装 'uv' 包管理器。'uv' 是一个快速的 Python 包安装和解析器,推荐用于安装本项目依赖。
服务器配置 (MCP 客户端配置)
以下是在 MCP 客户端 (例如 Claude Desktop) 中配置 HeyGen MCP Server 的示例 JSON 配置。您需要将此配置添加到您的 MCP 客户端配置文件中,以便客户端能够连接到 HeyGen MCP Server。
{ "mcpServers": { "HeyGen": { // 服务器名称,可以自定义,用于在客户端中标识该服务器 "command": "uvx", // 启动服务器的命令,这里假设 uvx 命令在您的 PATH 环境变量中 "args": ["heygen-mcp"], // 传递给命令的参数,这里 "heygen-mcp" 将会运行 heygen-mcp 包,即启动 MCP 服务器 "env": { "HEYGEN_API_KEY": "<insert-your-api-key-here>" // HeyGen API 密钥,请替换为您的实际 API 密钥 } } } }
配置说明:
- '"HeyGen"': 您为该 MCP 服务器自定义的名称,在客户端中用于识别和选择该服务器。
- '"command": "uvx"': 指定用于启动 HeyGen MCP 服务器的命令。这里使用 'uvx',它会执行 'heygen-mcp' 包的入口点。请确保 'uv' 已正确安装并且 'uvx' 命令在您的系统 PATH 环境变量中可用。
- '"args": ["heygen-mcp"]': 传递给 'uvx' 命令的参数。'["heygen-mcp"]' 指示 'uvx' 运行名为 'heygen-mcp' 的 Python 包,这将启动在 'heygen_mcp' 包中定义的 MCP 服务器。
- '"env": { "HEYGEN_API_KEY": "<insert-your-api-key-here>" }': 设置环境变量。'HEYGEN_API_KEY' 用于存储您的 HeyGen API 密钥。请务必将 '<insert-your-api-key-here>' 替换为您在 HeyGen 官网获取的实际 API 密钥。 这个 API 密钥将被服务器用来认证和访问 HeyGen API。
注意: 如果您在 Windows 上使用 Claude Desktop,可能需要在 Claude Desktop 中启用 "开发者模式" 才能使用 MCP 服务器。
基本使用方法
- 确保 HeyGen MCP Server 已按照上述配置在您的 MCP 客户端中配置。
- 启动您的 MCP 客户端 (例如 Claude Desktop)。
- 客户端应该能够检测到配置的 HeyGen MCP Server。
- 在客户端中,您可以调用 HeyGen MCP Server 提供的工具,例如 'get_remaining_credits' (获取额度), 'generate_avatar_video' (生成视频) 等,具体工具列表请参考 "主要功能点" 部分。
- 根据客户端的界面操作,即可利用 HeyGen API 的功能进行虚拟形象和视频的生成。
信息
分类
AI与计算