English Français العربية

io.github.egocen-vivideo/vivideo

السجل الرسمي التسويق والمبيعات

AI video generation via the Vivideo API: auto or manual mode, avatars, voices, brand kits.

الشيفرة المصدرية التوثيق

التثبيت

أضف هذا إلى إعدادات MCP في عميلك (Claude Desktop: claude_desktop_config.json، وCursor: ‏.cursor/mcp.json، ويستخدم VS Code وغيره الصيغة نفسها «mcpServers»).

Remote (streamable-http)
Claude Code 
claude mcp add --transport http vivideo 'https://api.vivideo.ai/mcp' --header 'Authorization: <Bearer vv_live_... — your Vivideo API key, created in the app under Settings > More > API Keys.>'
إعداد JSON (Claude Desktop وCursor وVS Code) 
{
    "mcpServers": {
        "vivideo": {
            "type": "http",
            "url": "https://api.vivideo.ai/mcp",
            "headers": {
                "Authorization": "<Bearer vv_live_... — your Vivideo API key, created in the app under Settings > More > API Keys.>"
            }
        }
    }
}
NPM package @vivideo/mcp
Claude Code 
claude mcp add vivideo -e 'VIVIDEO_API_KEY=<your vivideo_api_key>' -- npx -y @vivideo/mcp@1.0.2
إعداد JSON (Claude Desktop وCursor وVS Code) 
{
    "mcpServers": {
        "vivideo": {
            "command": "npx",
            "args": [
                "-y",
                "@vivideo/mcp@1.0.2"
            ],
            "env": {
                "VIVIDEO_API_KEY": "<your vivideo_api_key>"
            }
        }
    }
}

متغيرات البيئة

  • VIVIDEO_API_KEY إلزامي سري Your Vivideo API key (vv_live_...), created in the app under Settings > More > API Keys.

التوثيق

مأخوذ من ملف README للمشروع على GitHub ويُحدَّث أسبوعيًا. تفتح الروابط على GitHub.

المحتويات
  1. Vivideo Toolchain
  2. Architecture
  3. Quick start
  4. Docs
  5. Authentication & security
  6. Not included (honest scope)
  7. Development

Vivideo Toolchain

The developer + agent integration layer for the Vivideo API — a shared client, an MCP server, a CLI, and Skills. Agents are a primary user, not an afterthought.

Everything sits on top of the public API (the source of truth). No backend business logic is duplicated here — the toolchain only adds client-side ergonomics and guardrails.

vivideo-toolchain/            npm workspaces monorepo (TypeScript)
├── packages/core   @vivideo/core   one typed API client + guardrails (shared)
├── packages/mcp    @vivideo/mcp    MCP server (stdio) — 13 agent tools
├── packages/cli    @vivideo/cli    `vivideo` CLI — humans, scripts, CI, agents
├── skills/                          reusable agent Skills (SKILL.md)
└── docs/                            installation, configuration, workflows

Architecture

One client, one set of types, derived from packages/core/openapi.yaml. The MCP server and CLI both call @vivideo/core — there is exactly one representation of each request/response, so the tools, CLI, docs and OpenAPI stay consistent.

@vivideo/core adds only client-side concerns, never business logic:

GuardrailWhat it does
Rate limitingToken-bucket cap on request rate (default 8/s) — the client can't become a request flood.
Concurrency capSemaphore limits in-flight requests (default 4).
Bounded retriesRetries only retryable failures, with full-jitter backoff, capped attempts.
Honors Retry-AfterOn 429 it waits the API-specified delay before retrying.
IdempotencyEvery video-create sends an Idempotency-Key; retries reuse it → no duplicate charges.
TimeoutsPer-request AbortController timeout (default 30s).
Safe waitingwaitForVideo polls at the API's suggested interval, with a hard timeout — never a while(true).
Secret redactionAPI keys / signing secrets are stripped from every log, error, and output.

These complement — and never bypass — the API's own auth, rate limits, idempotency, credit checks, premium gates, ownership and error model.

Quick start

# from the repo (until packages are published to npm)
npm install
npm run build

# authenticate (stored 0600 in ~/.vivideo/config.json), or use VIVIDEO_API_KEY
export VIVIDEO_API_KEY="vv_live_..."   # from https://app.vivideo.ai/account/api-keys

# CLI
node packages/cli/dist/index.js account
node packages/cli/dist/index.js create auto --prompt "A 20s product teaser" --wait

# MCP server (stdio) — point an MCP client at this command
node packages/mcp/dist/index.js

Once published: npm i -g @vivideo/cli (gives vivideo), and npx @vivideo/mcp for the server.

Docs

Authentication & security

  • Keys are read from (in order): explicit option → VIVIDEO_API_KEY env → ~/.vivideo/config.json (written owner-only 0600).
  • The key is never printed — all output passes through secret redaction; configure stores it without echoing it.
  • Keys are account-scoped secrets. Keep them server-side; one per integration so a leak is revocable in isolation.

Not included (honest scope)

  • Cancellation — the public API has no cancel endpoint, so no cancel tool/command is offered. Failed/stuck renders are auto-refunded by the API.
  • Agent/chat mode — not exposed by the public API, so not in the toolchain.
  • Nothing here publishes to npm, provisions DNS, or deploys — those are external steps (see the final section of docs/mcp.md).

Development

npm run build       # build all three packages (tsc -b)
npm run typecheck   # type-check the whole workspace
npm test            # vitest

Requires Node ≥ 18.17.

الأسئلة الشائعة

ما هو io.github.egocen-vivideo/vivideo؟

AI video generation via the Vivideo API: auto or manual mode, avatars, voices, brand kits.

كيف أثبّت io.github.egocen-vivideo/vivideo؟

يعمل كخادم بعيد. في Claude Code: claude mcp add --transport http vivideo 'https://api.vivideo.ai/mcp' --header 'Authorization: <Bearer vv_live_... — your Vivideo API key, created in the app under Settings > More > API Keys.>'. وفي العملاء الآخرين، الصق إعداد JSON من هذه الصفحة في إعدادات MCP الخاصة بهم.

هل يحتاج io.github.egocen-vivideo/vivideo إلى مفتاح API؟

نعم. يتطلب VIVIDEO_API_KEY, Authorization، وتضبطها في إعداداته.

هل io.github.egocen-vivideo/vivideo مفتوح المصدر؟

نعم. شيفرته متاحة على GitHub بترخيص MIT.

من يصون io.github.egocen-vivideo/vivideo؟

ينشره egocen-vivideo. يدرجه AI.tn لكنه لا يصونه ولا يوصي به.

من سجل MCP الرسمي. الإدراج ليس توصية: راجع شيفرة الخادم وصلاحياته قبل منحه الوصول إلى بياناتك.