Quickstart — Claude Desktop
- Get your API key from app.hoox.video → Settings → API Keys. An Enterprise plan is required to access the API.
-
Install
uv(Python package manager): macOS / LinuxWindows (PowerShell)If you run into issues, see the uv installation documentation. -
Open your
claude_desktop_config.json(Claude → Preferences → Developer → Edit Config) and add the"mcpServers"block alongside your existing settings:
Before
After
Add the "mcpServers" block to your existing config file — keep your other settings intact.
Other MCP clients
For Cursor, OpenClaw, Claude Code, or any other compatible client:Example prompts
Hoox credits are required to use the MCP tools.
Generate a full video
Generate a full video
List avatars and voices
List avatars and voices
Create a custom avatar
Create a custom avatar
Duplicate a video
Duplicate a video
Full script-to-MP4 workflow
Full script-to-MP4 workflow
Available tools
Voices
| Tool | Description |
|---|---|
list_voices | List available voices with optional filters (language, gender, tags) |
get_voice | Get details for a voice by ID |
list_resource_voices | Simplified voice list optimized for generation |
Avatars
| Tool | Description |
|---|---|
list_avatars | List available avatars with optional filters (gender, tags) |
get_avatar | Get full details for an avatar and its looks |
get_avatar_look | Get details for a specific look |
create_avatar | Create a new avatar from a prompt or reference images |
edit_avatar | Edit an existing look to create a new variation |
get_avatar_status | Check the creation status of an avatar |
list_resource_avatars | Simplified avatar list optimized for generation |
Script
| Tool | Description |
|---|---|
generate_script | Generate a video narration script from a prompt |
Video generation
| Tool | Description |
|---|---|
start_generation | Start an AI video generation job |
get_generation_status | Check the status and progress of a generation job |
Export
| Tool | Description |
|---|---|
start_export | Start exporting a generated video to MP4 |
get_export_status | Check the status of an export job |
Video management
| Tool | Description |
|---|---|
duplicate_video | Duplicate a completed video, optionally changing the voice or avatar |
Typical workflow
Troubleshooting
"HOOX_API_KEY is required"
"HOOX_API_KEY is required"
Make sure the
HOOX_API_KEY environment variable is set in your MCP client configuration. The key must start with hx_live_ or hx_.Error plan_required (403)
Error plan_required (403)
Your Hoox account must have an Enterprise plan to use the API. Upgrade at app.hoox.video.
Error insufficient_credits (402)
Error insufficient_credits (402)
Your workspace has run out of credits. Top up from the Hoox dashboard under Settings → Billing.
Error rate_limit_exceeded (429)
Error rate_limit_exceeded (429)
The API allows 100 requests per minute on the Enterprise plan. Wait a moment before retrying.
Tool not showing up in Claude Desktop / Cursor
Tool not showing up in Claude Desktop / Cursor
- Check that
hoox-mcpis installed:pip install hoox-mcporuvx hoox-mcp --help - Restart your MCP client after updating the configuration
- Check your client’s logs for connection errors
- macOS:
~/Library/Logs/Claude/mcp-server-hoox.log - Windows:
%APPDATA%\Claude\logs\mcp-server-hoox.log
Generation stuck in "processing"
Generation stuck in "processing"
Video generation can take 1–5 minutes depending on duration and options. Use
get_generation_status to monitor progress. If the job is stuck for more than 10 minutes, check the error field in the status response.
