Skip to main content
Glama

@zvid/mcp

Official Zvid agent and MCP server. Creator follows a quality-first workflow: plan the brief, adapt designed examples or library assets, validate exact project JSON, save a reviewable draft, then render only after approval. Automation and Developer add trusted direct operations.

Meaningful charts and diagrams

Use build_data_visual for a bar chart, a line chart with numeric x coordinates, percentage progress bars, or a small directed acyclic diagram. It is available in Creator, Automation and Developer, runs locally, and spends no credits. It returns a static SVG in normal Zvid project JSON, the input specification and the calculated geometry.

Each visual needs a title, its purpose, and caller-supplied source information. Charts also require units and at least two labeled numeric values (one for progress bars). Diagrams require named nodes and explicit labeled relationships. Missing inputs, invalid numbers, unsupported connections and layouts that cannot fit readable labels return status: "omitted" with reasons and no payload or visual. Invalid tool argument types are rejected before generation. Do not fabricate a replacement.

For example, after the user supplies these survey results:

{
  "kind": "bar",
  "title": "Survey responses",
  "purpose": "Compare the supplied response percentages",
  "source": { "kind": "user-provided", "label": "Customer survey, October 2026" },
  "unit": "%",
  "data": [
    { "label": "Option A", "value": 25 },
    { "label": "Option B", "value": 75 }
  ]
}

Source information is recorded and displayed, not independently verified. Include the relevant period and scope. Explicitly requested mock data uses source.kind: "illustrative" and allowIllustrative: true; its output visibly says Illustrative data. Never treat the example above or library defaults as facts about a user.

Bars share a scale that includes zero, including negative values. Line points use actual numeric x spacing; supply strictly increasing data[].x and xUnit. Progress bars use kind: "progress", unit: "%", and one or more data: [{label: "Completion", value: 75}] entries. Their scale is always 0–100: the printed 75% and the 75%-filled track are calculated from the same value. Zero has no visible fill; 100 fills the whole track. Decimals are preserved and out-of-range values are rejected, never clamped. Rebuild the complete visual when a template value changes. Keep fill and percentage synchronized throughout any animation, or use the static visual. Progress bars, rings and gauges from the library are treated as quantitative visuals; unverified geometry is not safe to reuse just because its label changes. Rings/gauges are not generated by this builder. Diagrams use nodes: [{id, label}] and edges: [{from, to, label}]; the bounded layout rejects cycles, skipped levels and crossing connections. Limits are eight chart values or six diagram nodes/eight edges, with further limits when the requested canvas cannot hold the labels. Simplify or split dense visuals.

The returned payload can become an image draft, or its visual can be placed in a video scene of the same dimensions. Validate the final composition remotely and inspect its preview. Keep specification outside the render payload and rebuild the entire visual whenever data changes. Swapping SVG labels or adding template placeholders does not recalculate geometry.

The MCP excludes known decorative charts and chart/diagram examples without declared binding from automatic recommendations and the example start/draft/render shortcuts. Automatic brief-only fallbacks also avoid copying sample chart data or diagram relationships. These rules override guidance to preserve an example's layout. Arbitrary supplied SVG/HTML/images and existing saved templates still require review: schema validation cannot prove their factual accuracy.

Related MCP server: video-render-mcp

Authentication

There are exactly two ways to authenticate. Every setup below uses one of them:

#

Method

Works with

What you need

1

OAuth — sign in with your Zvid account (recommended)

Hosted endpoint https://mcp.zvid.io/mcp

A Zvid account and any OAuth-capable Streamable HTTP MCP client. No API key to create or paste.

2

API key (zvid_…)

Hosted endpoint via the X-Api-Key header, or local stdio / self-hosted

A key from app.zvid.io/api-keys; Node.js ≥ 18 for stdio

Method 1 — OAuth sign-in. Add https://mcp.zvid.io/mcp to your MCP client and sign in when prompted. The endpoint publishes OAuth discovery metadata, uses authorization code + PKCE with the single scope zvid:mcp, and issues short-lived access tokens with rotating refresh tokens (revocable per RFC 7009). This is what the client-specific instructions below use.

Method 2 — API key. Create a key at app.zvid.io/api-keys, then either:

  • Hosted: send it in the X-Api-Key header on https://mcp.zvid.io/mcp — for programmatic clients that cannot run an OAuth flow, or legacy access.

  • Local stdio / self-hosted: pass it via ZVID_API_KEY / --api-key as shown in Local stdio / self-hosted setup. The stdio transport is API-key only, because MCP OAuth is defined for HTTP transports.

The hosted endpoint is https://mcp.zvid.io/mcp. It accepts both authentication methods: OAuth sign-in (method 1 — used by the client instructions below) and an API key in the X-Api-Key header (method 2).

Claude Code

claude mcp add --transport http zvid https://mcp.zvid.io/mcp
claude mcp login zvid

You can also open /mcp inside Claude Code and authenticate there.

OpenAI Codex

Register the server, then authenticate from MCP settings or the command line:

codex mcp add zvid --url https://mcp.zvid.io/mcp
codex mcp login zvid

The dashboard stores the default tool profile and maximum credits per render for MCP clients. A client may connect with concrete values in the endpoint, for example https://mcp.zvid.io/mcp?profile=creator&maxRenderCredits=60; this is connection configuration and cannot be changed by the model during a conversation. The default per-render credit limit is 120, and the dashboard limit, when set, is a hard ceiling: the effective limit is the lower of the dashboard value and the value requested in the endpoint.

The official n8n workflow copies both dashboard defaults into its workflow JSON when downloaded. Each workflow can then choose another concrete profile and credit ceiling locally without updating the dashboard or any other workflow.

Local stdio / self-hosted setup

The npm/stdio entry point uses an API key (authentication method 2). Configuration resolution is CLI flags, then environment, then ~/.zvid-mcp.json:

npx -y @zvid/mcp --api-key zvid_your_key_here --api-url http://localhost:4000

Env var

CLI flag

Required

Default

Purpose

ZVID_API_KEY

--api-key zvid_…

stdio only

—

Zvid API key

ZVID_API_URL

--api-url http://…

no

https://api.zvid.io

Orchestrator base URL

ZVID_MCP_PROFILE

--profile creator

no

creator

Tool profile

ZVID_MCP_MAX_RENDER_CREDITS

—

no

120

Legacy/fallback hosted limit; dashboard and explicit n8n values take precedence

ZVID_MCP_MAX_BULK_ITEMS

—

no

25

Automation/developer bulk-call item ceiling

ZVID_MCP_QUOTE_SECRET

—

hosted

process-random

Shared HMAC secret for multi-instance quotes

For a self-hosted OAuth deployment, keep the resource and issuer identical on both services:

Service

Variable

Production default

Orchestrator

OAUTH_ISSUER

https://api.zvid.io

Orchestrator

OAUTH_MCP_RESOURCE

https://mcp.zvid.io/mcp

Orchestrator

OAUTH_CONSENT_URL

https://app.zvid.io/oauth/authorize

MCP

ZVID_MCP_RESOURCE

https://mcp.zvid.io/mcp

MCP

ZVID_OAUTH_ISSUER

https://api.zvid.io

The orchestrator also accepts OAUTH_ACCESS_TOKEN_TTL_SECONDS and OAUTH_REFRESH_TOKEN_TTL_SECONDS; their defaults are one hour and 30 days.

From a checkout:

cd mcp && npm install && npm run build
claude mcp add zvid --env ZVID_API_KEY=zvid_your_key_here -- node /absolute/path/to/mcp/dist/index.js

Default Creator workflow

The default creator profile is the former Advanced authoring surface. It exposes planning, designed examples, creative-library search, stock media, schema/docs, repair, validation, projects and templates alongside approval-aware draft tools.

Creator deliberately rejects create_media and revise_media calls that omit the complete project payload. This prevents a weak model from improvising a poor layout from a brief. The agent must plan, adapt or assemble an exact payload, validate it remotely, fix every error and layout warning, and only then save the draft. create_media remains non-spending; render_media still requires the user-approved signed quote.

When the user asks for a reusable template rather than a one-off video or image, create_media_template saves a parameterized project — a top-level variables object of safe defaults referenced via {{name}} placeholders — as a persistent tpl_… template. It returns the declared variables, a credit estimate for rendering the untouched defaults, and an editor deep link (https://editor.zvid.io/?template=<id>). create_media_from_template then instantiates the template with new variable values as an approval-gated draft with a signed quote. Neither call spends credits. In the creator profile create_media_template requires the complete parameterized payload, mirroring create_media.

Rendering is deliberately separate from drafting. Quote tokens are HMAC-signed, expire after 15 minutes, bind the draft ID, project version, canonical payload hash, media type and estimated credits, and are revalidated immediately before submission. An idempotency UUID prevents retry duplication.

Capability profiles

Profile

Intended use

Surface

readonly

Inspection

get_media, list_media, get_account

creator

Most users

Quality authoring, libraries, validation, projects/templates and approved renders

automation

Trusted workflows

Creator tools plus direct renders, capped bulk rendering and webhook operations

developer

Full API development

Every registered non-destructive/raw tool

Update and delete tools remain disabled in every profile. Stored webhook secrets are redacted by get_webhook; only create_webhook returns a new secret. MCP bulk calls normally allow at most 25 items, subject to account limits. The direct REST API's 500-item hard cap does not raise this tool ceiling; split work into appropriately sized batches.

The server also publishes four user-invoked workflow prompts (product promo, social reel, thumbnail and square post) and safe MCP resources at zvid://authoring/guidelines and zvid://account/summary.

Creator, Automation and Developer tools

The following low-level capabilities are available only in the profiles described above:

Tool

Description

build_data_visual

Build a bar chart, numeric-x line chart, percentage progress bar or directed diagram from supplied data and source details. Returns calculated SVG geometry, or omits the visual when inputs or layout are insufficient. Free; no persistence or rendering.

plan_creative_video

Plan-aware storyboard and art direction from a brief — plus libraryCandidates: published examples ranked against the brief with an adapt-vs-assemble decision. Supports consistent, fresh, and explore modes, recent-asset exclusions, brand tokens, style packs, and scene recipes

find_matching_examples

Rank the entire published examples library against a brief (category synonyms, aspect/duration fit) and return candidates with thumbnails plus a decision: adapt-example, adapt-or-assemble, or assemble-similar (with design-template/canvas-preset/shape modules)

start_from_example

Fetch an example's render-ready project JSON plus an adaptation map (variables, text/media slots, scene summary, fonts) and the adaptation contract — the premium path: keep the layout, swap copy/media/brand. Suggests free alternatives when a premium example is plan-locked

render_from_example

Automation/Developer direct render: example slug + variable values saves a template, validates and queues a spending render. Creator uses create_media_from_example, then approved render_media

search_creative_library

Search complete examples, animated Design Studio templates, canvas presets, or shapes; results include preview/thumbnail metadata when published

get_creative_asset

Fetch metadata and full JSON content for one creative-library item

list_stock_providers / search_stock_media

Discover stock capabilities and search Zvid's stock library for render-ready media URLs

get_project_schema

Live caller-plan-aware JSON Schema (draft 2020-12) for a project payload or full render request, plus validation notes, professional authoring guidelines, and required workflow; falls back to the bundled default schema when the endpoint is unavailable

validate_project_json

Validate a payload before rendering — field-level errors, free. Also lints layout: overlapping texts, x/y ignored by presets, off-canvas boxes, padding cut-offs, low contrast. remote: true also runs the live API validator with your plan's real limits

list_supported_elements

All element types (IMAGE, VIDEO, GIF, SVG, TEXT, AUDIO, SUBTITLE, SCENE) with required fields

get_element_docs

Per-element docs: every field, constraints, gotchas, and a valid example

get_example_payload

Validated example payloads: promo video, template render, still image, subtitles, webhook flow

repair_project_json

Conservative auto-fix for invalid payloads with an explanation of every change

create_render

Queue a video render from a project JSON (payload) or a template + variables

create_image_render

Queue a still-image render (PNG/JPEG/WebP; supports snapshotTime, quality, transparent)

get_render

Job state (waiting|active|completed|failed), progress, output url + thumbnailUrl

list_renders

List render jobs (filter by type)

create_bulk_render

One template/payload × N variable sets → N jobs (MCP default maximum 25; account limits also apply)

get_bulk_render / list_bulk_renders

Inspect bulk batches

list_templates / get_template

Browse owned templates; get_template returns the full project JSON

create_template / duplicate_template

Create a plan-validated reusable template or make an active editable copy

preview_template

Dry-run variable resolution + validation — costs no credits

list_projects / get_project / create_project

Editor draft projects (open at https://editor.zvid.io/?project=<id>)

list_webhooks / create_webhook / get_webhook / test_webhook / list_webhook_deliveries

Webhook endpoints for render.completed / render.failed (HMAC-SHA256 signed)

get_credits / get_usage_stats

Credit balance and usage

Schema-aware authoring

The schema tools use a shared module (../schema, vendored as src/zvidSchema.ts) that is maintained alongside backend validation and parity-tested against it. get_project_schema prefers the current caller-plan-aware endpoint. A result marked live: false is a bundled fallback, not proof of the current account's limits. Use validate_project_json with remote: true to validate the exact project before rendering. Local schemas cannot prove that remote media will download or that a composition is visually correct.

The server also advertises this workflow as MCP instructions, so compliant clients receive it at initialize time. The example-first flow for an AI client authoring a video:

  1. plan_creative_video with the brief, format, duration, brand and variation mode. The response includes ranked libraryCandidates and a decision.

  2. Decision adapt-example: inspect the example with start_from_example, then provide new variable values to create_media_from_example to save a reviewable draft and receive a credit quote. Preserve its layout and animation unless the task requires changes. Supported variables, conditions and iteration resolve in inline projects as well as stored templates; a stored template is useful for reuse, not a prerequisite for substitution.

  3. Decision assemble-similar (or nothing close on inspection): assemble the planned scene recipes from the returned design-templates, canvas-presets and shapes modules (or search_creative_library). Never force an unrelated full-video template.

  4. Use search_stock_media for topic-specific visuals and music for each scene — full-quality src URLs, natural size ≥ the canvas.

  5. When composing, call get_project_schema / list_supported_elements / get_element_docs for the exact shape.

  6. Run validate_project_json (add remote: true to check against the caller's real plan) and fix every error and layout warning. Use repair_project_json only for mechanical mistakes.

  7. In the default Creator profile, save the exact validated payload with create_media (or use the template/example draft tools). Review the draft and quote, revise if needed, and call render_media with the approved quote token. Track the result with get_media or get_render until completion. In Automation/Developer, direct create_render, create_image_render and render_from_example calls submit immediately and spend credits; they do not create a pre-render draft for approval.

For stills or quick "make something like X" requests without a full plan, start at find_matching_examples (type: "image" for stills).

Variation behavior:

  • consistent derives a stable seed from the brief (or accepts variationSeed) for reproducible automations.

  • fresh produces one new direction and expects recent library assets to be excluded.

  • explore returns 2-5 materially different style/layout/storyboard directions, not recolors of one payload.

For a reusable template, replace the final render with create_template. Later use get_template to inspect it, preview_template before rendering, and duplicate_template for a safe editable copy. Update and delete mutations are intentionally not exposed as MCP tools.

Example prompts

  • "Create a valid Zvid JSON payload for a 10-second promo video with a headline and background music."

  • "Plan three genuinely different 9:16 creative directions for this product launch, avoid these recently used example slugs, then build the strongest one."

  • "Validate this payload before rendering and explain anything that's wrong."

  • "Show me the required fields for a TEXT visual."

  • "What subtitle animation modes does Zvid support?"

  • "This payload fails — repair it and tell me what you changed."

  • "Render a 1080p video from template tpl_… with title 'Summer Sale' and give me the link when it's done."

  • "Preview template tpl_… with these variables and tell me if anything fails validation."

  • "Create a webhook pointing at https://example.com/hooks/zvid for completed and failed renders."

  • "How many credits do I have left, and what did I spend this month?"

Webhook signature verification

Registered webhook deliveries are signed: X-Zvid-Signature: sha256=<hex> where the hex value is HMAC_SHA256(secret, "<X-Zvid-Timestamp>.<raw body>"). Save the secret (whsec_…) returned once by create_webhook; get_webhook redacts it. Verify the original raw request bytes before parsing the event.

Per-request webhookUrl callbacks are not signed and do not share the registered webhook secret. Both callback types use an event envelope; see webhook documentation for the exact body and verification guidance.

Development

npm install
npm run build     # tsc → dist/
npm test          # unit + in-memory MCP round-trip tests
# real E2E against a local orchestrator:
ZVID_API_KEY=zvid_… ZVID_API_URL=http://localhost:4000 node scripts/e2e-local.mjs

Publishing (manual)

@zvid/mcp 0.1.0 was available on npm when checked on 22 September 2026. The hosted service and a particular installed npm version may expose different revisions; query the connected client's actual capabilities.

npm. Bump version in package.json, then npm publish from mcp/ (public access is set via publishConfig). The prepublishOnly hook builds dist/.

Official MCP Registry (registry.modelcontextprotocol.io) — lists the server for discovery in MCP-aware clients. It reads server.json; ownership of the io.zvid/* namespace is proven with a DNS TXT record on zvid.io (or switch the mcpName/server.json name to io.github.Zvid-io/zvid-mcp to verify via GitHub instead). After npm publish:

# one-time: install the publisher CLI, then log in (DNS or GitHub)
mcp-publisher login dns --domain zvid.io      # or: mcp-publisher login github
mcp-publisher publish                          # reads ./server.json

Keep versions in sync on every release — a mismatch blocks the registry publish. Update all three together: package.json version, server.json version, and server.json packages[0].version. The server name must match in both files: package.json mcpName == server.json name.

Community and support

Join the Zvid community on Discord to ask questions, discuss video automation workflows, and share what you build. For private account or billing questions, contact us at https://zvid.io/contact.

Available Tools

42 tools
create_bulk_renderCreate bulk renderAInspect

Queue N renders from one template/payload and a list of per-item variable sets (max 500 items, plan-limited). Validation is best-effort per item: valid items queue, invalid ones are reported in itemErrors. Returns bulkId + jobIds.

Inputs: items (required), kind, name, payload, +4 more.

create_image_renderCreate image renderAInspect

Queue a still-image render (PNG/JPEG) from a project JSON or an image-type template. Overrides support snapshotTime, quality and transparent. Returns a jobId to poll with get_render. For NEW creative stills, first run find_matching_examples with type: "image" and adapt a library example via start_from_example instead of composing from scratch.

Inputs: payload, template, overrides, variables, +1 more.

create_projectCreate projectBInspect

Save a new editor draft project. It becomes editable at https://zvid.io/editor?project=.

Inputs: name (required), payload (required).

create_renderCreate video renderAInspect

Queue a video render. Provide either a full project JSON as payload or a template ID (optionally with variables). Returns a jobId to poll with get_render. Credits are reserved up front. For NEW creative content do not hand-compose the payload: run plan_creative_video (or find_matching_examples) first and adapt a library example via start_from_example, then validate_project_json before rendering.

Inputs: payload, template, overrides, variables, +1 more.

create_templateCreate templateAInspect

Create a reusable template from complete project JSON. Read get_project_schema first; every placeholder must have a safe default and video-template scenes need explicit durations. The backend validates the template against this account's plan before saving it. This is also the render path for adapted library examples that use variables/condition/iterate: create_template -> preview_template -> create_render { template, variables }.

Inputs: name (required), payload (required), description.

create_webhookCreate webhookBInspect

Register a webhook endpoint for render events. The response includes the signing secret (whsec_...) shown in full only here and on get_webhook — deliveries are signed with HMAC-SHA256 in the X-Zvid-Signature header.

Inputs: url (required), events (required), description.

delete_projectDelete projectBInspect

Permanently delete a draft project.

Inputs: projectId (required).

delete_templateArchive templateAInspect

Archive an active template owned by this account. Archived templates cannot be rendered or updated, so call this only when the user explicitly asks to remove it.

Inputs: templateId (required).

delete_webhookDelete webhookCInspect

Delete a webhook endpoint.

Inputs: webhookId (required).

duplicate_templateDuplicate templateAInspect

Create an editable copy of an owned template, including archived templates. The copy is active and counts against the account's template quota.

Inputs: templateId (required).

find_matching_examplesFind matching library examplesAInspect

Match a brief against the ENTIRE published examples library (hundreds of professionally designed, render-ready projects) and return ranked candidates with thumbnails/previews plus a decision: "adapt-example" (strong match — call start_from_example), "adapt-or-assemble", or "assemble-similar" (compose from the returned design-template/canvas-preset/shape modules). Use this before authoring any project JSON by hand; matching runs over full metadata with category synonyms, so it finds examples the plain search_creative_library query cannot.

Inputs: brief (required), type, limit, duration, +6 more.

get_bulk_renderGet bulk renderBInspect

Get a bulk render batch by ID (blk_...) including its jobs' states.

Inputs: bulkId (required).

get_creative_assetGet a creative-library assetAInspect

Get metadata and, by default, the full JSON content for one creative-library item. Examples are complete projects — when you intend to ADAPT one, prefer start_from_example (it also returns an adaptation map and contract). Design templates/canvas presets/shapes are reusable modules and must be composed into a project.

Inputs: kind (required), slug (required), includeContent.

get_creditsGet credit balanceBInspect

Get the account's credit balance (total balance, subscription credits, and add-on credit pack balance).

Inputs: no named parameters.

get_element_docsGet element docsAInspect

Get concise docs for one element type — required fields, every supported field with constraints, gotchas, and a valid example. Types: IMAGE, VIDEO, GIF, SVG, TEXT, AUDIO, SUBTITLE, SCENE (case-insensitive).

Inputs: element (required).

get_example_payloadGet example payloadAInspect

Get one of five GENERIC starter payloads for a common flow: promo-video (10s scene-based hook/value/CTA with scrim + flex-centered card), template-render (variables), still-image (transparent PNG, single html card), subtitles (karaoke captions), webhook-flow (per-job webhookUrl). These are schema scaffolds, NOT the designed library — for premium creative work use find_matching_examples / start_from_example first and fall back here only when no library example fits. Omit name to list all examples.

Inputs: name.

get_projectGet projectAInspect

Get a draft project (prj_...) including its project JSON.

Inputs: projectId (required).

get_project_schemaGet project JSON SchemaAInspect

Get the JSON Schema (draft 2020-12) for a Zvid render payload — element types, required fields, enums, defaults, min/max bounds and URL restrictions — plus notes for cross-field rules the schema cannot express (timing checks, plan limits, sanitizer rules). Use target: "render-request" for the full request envelope (payload XOR template + variables/overrides/webhookUrl). Derived from the backend validation code, which always wins over docs.

Inputs: target.

get_renderGet render statusAInspect

Get a render job's state (waiting|active|completed|failed), progress (0-100), and — when completed — the output url and thumbnailUrl.

Inputs: jobId (required).

get_templateGet templateAInspect

Get a template by ID including its full project JSON (inspect it to discover the variables it expects).

Inputs: templateId (required).

get_usage_statsGet usage statsBInspect

Get render/credit usage statistics for a timeframe (e.g. 7d, 30d, 90d).

Inputs: timeframe.

get_webhookGet webhookAInspect

Get a webhook endpoint (whk_...) including its signing secret and failure state.

Inputs: webhookId (required).

list_bulk_rendersList bulk rendersBInspect

List this account's bulk render batches.

Inputs: page, limit.

list_projectsList projectsBInspect

List editor draft projects saved on this account.

Inputs: page, limit.

list_rendersList rendersAInspect

List this account's render jobs, newest first. Optionally filter by type (video|image).

Inputs: page, type, limit.

list_stock_providersList configured stock-media providersAInspect

List the stock providers currently available for image, video, GIF and audio searches.

Inputs: no named parameters.

list_supported_elementsList supported elementsAInspect

List every element type a Zvid project supports (visuals: IMAGE, VIDEO, GIF, SVG, TEXT; plus AUDIO items, SUBTITLE and SCENE) with a summary and required fields. Use get_element_docs for full per-type docs and examples.

Inputs: no named parameters.

list_templatesList templatesAInspect

List this account's render templates (id, name, description).

Inputs: page, limit.

list_webhook_deliveriesList webhook deliveriesBInspect

List recent delivery attempts for a webhook endpoint (status, attempts, response codes).

Inputs: webhookId (required), page, limit.

list_webhooksList webhooksAInspect

List webhook endpoints registered on this account, plus usage vs plan limit.

Inputs: no named parameters.

plan_creative_videoPlan a professional creative videoAInspect

Turn a brief into a plan-aware storyboard, style/layout direction, scene recipes and anti-repetition rules BEFORE authoring JSON — plus libraryCandidates: concrete published examples ranked against the brief with an adapt-vs-assemble decision. Follow that decision: adapt the top example via start_from_example, or assemble from the returned design-template/canvas-preset/shape modules. Modes: consistent reuses a stable seed; fresh produces a new direction; explore returns 2-5 materially different directions.

Inputs: brief (required), brand, style, duration, +7 more.

preview_templatePreview template (dry run)AInspect

Resolve a template's variables and validate the result WITHOUT rendering or spending credits. Use this to check variable values before create_render.

Inputs: templateId (required), overrides, variables.

render_from_exampleRender an adapted library exampleAInspect

The EASIEST premium render path: pick a library example and supply new VARIABLE VALUES (copy, media URLs, colors) — the server fetches the example, saves it as a template, dry-runs your variables, and queues the render, keeping the example's designed layout/animations fully intact. Use start_from_example first to see the variable names and defaults. Provide only declared variables; unknown names are reported. Spends credits like create_render; returns jobId + the created templateId for reuse.

Inputs: slug (required), name, overrides, variables.

repair_project_jsonRepair project JSONAInspect

Attempt conservative auto-fixes on an invalid project payload (wrong-case type, clamped numbers, format conflicts like transparent+jpg, swapped begin/end timings, unknown fields, empty/impossible elements) and explain every change. Returns the repaired payload plus its validation result — problems that need real input (e.g. missing media URLs) are left as errors.

Inputs: payload (required).

search_creative_librarySearch the creative libraryAInspect

Search curated complete project examples, animated Design Studio templates, canvas motion presets, or shapes. NOTE: the server search is a plain AND-of-substrings over title/slug/description — use short single-word queries here, and prefer find_matching_examples when matching a brief to examples (it ranks the whole library with category synonyms). Inspect preview/thumbnail metadata before choosing. For fresh/explore work, exclude recent slugs returned by plan_creative_video.

Inputs: kind (required), limit, query, offset.

search_stock_mediaSearch stock mediaBInspect

Search server-configured stock image, video, GIF or music providers. Results contain preview and full-quality src URLs suitable for Zvid payloads plus dimensions/duration and attribution metadata.

Inputs: type (required), page, query, perPage, +1 more.

start_from_exampleStart from a library exampleAInspect

Fetch a library example's complete render-ready project JSON plus an ADAPTATION MAP (declared variables with defaults, text slots with current copy, media slots, scene/timing summary, fonts) and the adaptation contract. This is the premium-quality path: keep the example's layout and animations, swap copy/media/brand. When adaptationMap.recommendedWorkflow is "template-render" (variables/condition/iterate present), save the payload with create_template and render with variables instead of editing placeholders inline. Premium examples need a paid plan — if locked, free alternatives are suggested.

Inputs: slug (required).

test_webhookSend test webhookAInspect

Queue a signed test event delivery to a webhook endpoint.

Inputs: webhookId (required).

update_projectUpdate projectCInspect

Rename a draft project and/or replace its project JSON.

Inputs: projectId (required), name, payload.

update_templateUpdate templateAInspect

Rename a template, change its description, and/or replace its project JSON. Get the current template first so fields are not accidentally lost; replacement JSON is fully validated before saving.

Inputs: templateId (required), name, payload, description.

update_webhookUpdate webhookCInspect

Update a webhook's url, events, description, or enable/disable it.

Inputs: webhookId (required), url, events, status, +1 more.

validate_project_jsonValidate project JSONAInspect

Validate a Zvid project payload BEFORE rendering (free, no credits). Returns { valid, errors: [{field, message}], warnings }. Warnings include LAYOUT LINT — overlapping texts, x/y ignored by position presets, boxes extending off-canvas, padding that will get cut off, low text contrast — treat every layout warning as a fix-before-render item. Local validation mirrors the backend rules; set remote: true to ALSO run the payload through the live API validator (POST /api/render/validate/api-key — resolves templates and applies your plan's real limits).

Inputs: payload (required), kind, remote.

Tool Schema Changelog

Recent tool additions, removals, and schema changes observed during successful MCP inspections.

Loading tool schema changelog…

    TDQS

    A3.7/5.0

    Scored across 42 tools

    Disambiguation4/5

    Most tools have distinct purposes (render, template, webhook, search), but overlap exists between create_render, create_image_render, render_from_example, and create_bulk_render. However, detailed descriptions differentiate them by type and workflow.

    Naming Consistency5/5

    All tool names follow a consistent verb_noun pattern in snake_case (e.g., create_render, get_render, list_templates). No mixing of conventions.

    Tool Count4/5

    42 tools is high but justified by the broad feature set (rendering, templates, projects, webhooks, search, validation, credits). Slightly heavy but each tool serves a specific purpose.

    Completeness4/5

    Covers rendering, management, search, validation, and webhooks thoroughly. Minor gap: no tool to delete renders (though jobs are transient). Otherwise comprehensive.

    Maintenance

    ActivityMaintained
    ResponsivenessNo recent community issues

    Related MCP Connectors

    Related MCP Servers