UnrealUGC

UnrealUGC MCP 服务

这是 UnrealUGC 的官方 Model Context Protocol 服务。它为兼容 MCP 的助手提供 11 个类型化工具，用于浏览创作者和模型、估算积分成本，以及生成 AI UGC 视频广告。

此代码仓库仅包含公开的 MCP 适配器。UnrealUGC 应用和后端仍为私有。

前置条件

• Node.js 20 或更高版本
• UnrealUGC API 密钥，可在 Dashboard → Settings → API Keys 中获取

API 密钥以 usk_live_ 开头，应保存在 MCP 客户端的环境设置中，切勿提交到代码仓库。

本地 stdio 设置

无需全局安装此软件包。MCP 客户端可以使用 npx 启动它。

Claude Desktop

将此服务添加到 Claude Desktop 配置中：

{
  "mcpServers": {
    "unrealugc": {
      "command": "npx",
      "args": ["-y", "@unrealugc/mcp"],
      "env": {
        "UNREALUGC_API_KEY": "usk_live_..."
      }
    }
  }
}

Claude Code

claude mcp add unrealugc --env UNREALUGC_API_KEY=usk_live_... -- npx -y @unrealugc/mcp

Codex

[mcp_servers.unrealugc]
command = "npx"
args = ["-y", "@unrealugc/mcp"]

[mcp_servers.unrealugc.env]
UNREALUGC_API_KEY = "usk_live_..."

Cursor、Windsurf、OpenClaw 和其他 stdio MCP 客户端使用相同的命令和环境变量。

托管式 Streamable HTTP 设置

支持远程 MCP 的客户端无需运行本地进程即可连接：

URL: https://unrealugc.com/api/mcp
Authorization: Bearer usk_live_...

请参阅 MCP 设置指南，了解针对各客户端的说明。

工具

工具	用途
get_me	确认 API 密钥对应的账户、套餐和余额
get_credits	查看订阅积分池和已购买积分池
list_models	浏览可用的视频模型及其功能
list_creators	浏览素材库创作者和自定义虚拟形象
list_voices	浏览素材库语音和自定义语音
list_projects	查找产品和营销活动项目
create_project	创建用于归类相关生成任务的项目
list_videos	使用筛选条件和分页浏览生成记录
get_video	轮询生成任务并获取其输出 URL
estimate_video_cost	在消耗积分前，根据脚本估算积分成本
generate_video	启动异步视频生成任务

generate_video 支持原生语音或指定语音、无声反应／补充镜头片段、逐场景视觉指导，以及并行或顺序生成多个片段。

生成流程

1. 调用 list_models 和 list_creators。
2. 使用拟定的脚本调用 estimate_video_cost。
3. 如果需要考虑预算，请检查 get_credits。
4. 调用 generate_video。
5. 大约每 15 秒轮询一次 get_video，或使用 UnrealUGC Webhook 接收完成事件。

环境变量

变量	必填	默认值
UNREALUGC_API_KEY	是	—
UNREALUGC_BASE_URL	否	https://unrealugc.com
UNREALUGC_REQUEST_TIMEOUT_MS	否	30000

UNREALUGC_BASE_URL 用于 UnrealUGC 的开发和暂存环境。

开发

npm ci
npm run check
npm pack --dry-run

提交拉取请求前，请参阅 CONTRIBUTING.md。安全问题请按照 SECURITY.md 中的说明报告。

链接

• UnrealUGC MCP 概览
• MCP 文档
• REST API 文档
• UnrealUGC 控制面板

许可证

MIT © Next MVP Solutions LLC