---
canonical_url: "https://docs.composio.dev/toolkits/cardboard_mcp"
markdown_url: "https://docs.composio.dev/toolkits/cardboard_mcp.md"
product: "platform"
version: null
last_updated: null
---

# Cardboard MCP

Edit videos with Cardboard’s provider-hosted MCP server: create projects, bring in media, cut and caption timelines, generate media and export MP4s. Requires a Cardboard plan; editing, generation and exports use the signed-in user’s credits.

- **Category:** model context protocol
- **Auth:** DCR_OAUTH
- **Composio-managed OAuth available?** No
- **Tools:** 49
- **Triggers:** 0
- **Slug:** `CARDBOARD_MCP`
- **Version:** 00000000_00

## Tools

### Account usage

**Slug:** `CARDBOARD_MCP_ACCOUNT_USAGE`

The person's Cardboard subscription and what it has left: exports, usage, generative credits and when they renew. For questions like "what plan am I on?", "how many exports do I have left?" or "I want to upgrade", and before work their subscription may not cover.

### Apply timeline

**Slug:** `CARDBOARD_MCP_APPLY_TIMELINE`

Changes the timeline. `edits` are exact { oldText, newText } replacements copied from print_timeline, with its header `rev`; text outside them stays as it is, and edits saved since that rev merge in item by item. An edit that does not match exactly once changes nothing, and print_timeline shows the current text. `source`, the whole file, is for rewriting most of the timeline.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `rev` | integer | No | With edits: the `cardboard:rev` from the header they were copied from, so edits saved since then merge in. Omit to edit the current timeline. |
| `edits` | array | No | Exact, non-overlapping replacements against the timeline you read, applied as one batch. To insert, replace a unique anchor with the anchor and the new JSX. |
| `prefer` | string ("file" | "editor") | No | Who wins when this call and an edit saved since the timeline was printed both changed an item: file, this call (default), or editor, the saved edit. |
| `source` | string | No | Full timeline.tsx text, only to rewrite most of the timeline. |
| `project` | string | Yes | Project id or exact name |

### Cancel job

**Slug:** `CARDBOARD_MCP_CANCEL_JOB`

Stop a running job: an export stops and leaves no file. Work that cannot stop once started says so and ends on its own; a generation always runs to the end.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `job_id` | string | Yes | The job id a Cardboard tool handed back |

### Caption from transcript

**Slug:** `CARDBOARD_MCP_CAPTION_FROM_TRANSCRIPT`

A <track kind="caption"> for the current timeline built from the media transcripts (transcribing any not cached yet, in seconds). Its items carry captionText and captionWordTimings, so later edits can restyle and retime them. With `apply`, the track goes onto the timeline above the footage and the result is a summary. Without it the timeline is not changed and the result is the JSX for apply_timeline; the first <track> draws on top, so a caption track placed after the footage draws under it and does not show.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `apply` | boolean | No | Add the track to the timeline instead of returning it |
| `preset` | string | No | Caption preset id |
| `project` | string | Yes | Project id or exact name |
| `language` | string | No |  |
| `trackName` | string | No |  |
| `wordsPerCaption` | integer | No |  |

### Capture web page

**Slug:** `CARDBOARD_MCP_CAPTURE_WEB_PAGE`

Screenshot a web page in a headless Chrome: the first screen, the full page, or one element. With a project the image is imported into it; without one it comes back in the result. With scroll it records the page scrolling instead, as a video clip for the project.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `url` | string | Yes | The page to capture |
| `wait` | number | No | Seconds to let the page settle after it loads |
| `scale` | number | No | Device pixel ratio (default 2) |
| `theme` | string ("light" | "dark" | "force-dark" | "system") | No | light (default) or dark pick the site’s own theme; force-dark also darkens a page with no dark theme; system follows the capturing browser |
| `width` | integer | No | Viewport width in CSS pixels (default 1440) |
| `height` | integer | No | Viewport height in CSS pixels (default 900) |
| `scroll` | boolean | No | Record the page scrolling down from the top as a video clip (1920x1080, 30 fps) imported into the project, rather than a still. For a shot of the site being scrolled: sticky headers stay in view and the page’s own motion plays, where a full page is one tall still the edit has to pan over. The view is 1440x810 unless width and height say otherwise. Needs project; not with fullPage or selector. |
| `project` | string | No | Import the image into this project |
| `fullPage` | boolean | No | Capture the whole scrollable page |
| `selector` | string | No | Capture only the first element matching this CSS selector |
| `fullMotion` | boolean | No | Keep the page’s animations; by default it is asked for reduced motion so stills do not catch a transition |
| `scrollScreens` | number | No | How far it scrolls, in heights of the view (default 3); a page that ends sooner stops at its end |
| `scrollSeconds` | number | No | How long the scroll takes, in seconds (default 6) |

### Card state

**Slug:** `CARDBOARD_MCP_CARD_STATE`

For Cardboard's card: a fresh session and the project's latest preview and export.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `render` | boolean | No | Also render the newest edit, for a card that plays rendered files |
| `project` | string | Yes | Project id |

### Check timeline

**Slug:** `CARDBOARD_MCP_CHECK_TIMELINE`

Report what apply_timeline would change for the same edits or source, without writing.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `rev` | integer | No | With edits: the `cardboard:rev` from the header they were copied from, so edits saved since then merge in. Omit to edit the current timeline. |
| `edits` | array | No | Exact, non-overlapping replacements against the timeline you read, applied as one batch. To insert, replace a unique anchor with the anchor and the new JSX. |
| `prefer` | string ("file" | "editor") | No | Who wins when this call and an edit saved since the timeline was printed both changed an item: file, this call (default), or editor, the saved edit. |
| `source` | string | No | Full timeline.tsx text, only to rewrite most of the timeline. |
| `project` | string | Yes | Project id or exact name |

### Create project

**Slug:** `CARDBOARD_MCP_CREATE_PROJECT`

Create an empty project.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes |  |

### Detect scenes

**Slug:** `CARDBOARD_MCP_DETECT_SCENES`

Shot changes in a video, as source seconds (offline).

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `media` | string | Yes | Media id or file name as shown in the timeline.tsx header |
| `project` | string | Yes | Project id or exact name |
| `threshold` | number | No |  |

### Detect silence

**Slug:** `CARDBOARD_MCP_DETECT_SILENCE`

Silent stretches in a media file’s audio (offline). Source seconds.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `media` | string | Yes | Media id or file name as shown in the timeline.tsx header |
| `project` | string | Yes | Project id or exact name |
| `minDuration` | number | No | Shortest stretch reported in seconds (default 0.5) |
| `thresholdDb` | number | No | Level treated as silence (default -30) |

### Docs

**Slug:** `CARDBOARD_MCP_DOCS`

Cardboard's documentation by topic. `cardboard` is Cardboard's editing guide, the one its own editor agent follows, with these tools in place of `cb`: the editing loop, elements, seeing and hearing an edit, captions, generated media, color, the player in the chat and replies after an edit. The other topics each cover a command or technique (source, look, code, synced-captions, motion-graphics, color-grading, 3d-scenes, ...). No topic lists them.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `topic` | string | No |  |

### Download media

**Slug:** `CARDBOARD_MCP_DOWNLOAD_MEDIA`

Download what a link points at into a project: the video behind a post on YouTube, X, Instagram, TikTok or another video site, or a video, audio or image file. An image joins the project as a photo. It joins the project with the same thumbnails, waveform and proxy as any other media.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `url` | string | Yes | Link to the post, or to a video, audio or image file |
| `project` | string | Yes | Project id or exact name |
| `audioOnly` | boolean | No | Take the audio track alone, as m4a |
| `maxHeight` | integer | No | Cap the video height, e.g. 1080 |

### Export video

**Slug:** `CARDBOARD_MCP_EXPORT_VIDEO`

Render the project in Cardboard's export pool, from the originals in Cardboard's storage. Hands back a job at once (an export takes minutes for a long edit): job_status follows the render and returns the export's id and a link to the file, and cancel_job stops it. Cardboard's card plays the project's newest preview or export and offers its newest export's download; show_preview opens it. For when the user wants the file; check an edit with look and verify_timeline instead.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `format` | string ("mp4" | "webm" | "mov" | "mkv") | No |  |
| `project` | string | Yes | Project id or exact name |
| `quality` | string ("very low" | "low" | "medium" | "high" | "very high") | No |  |
| `frameRate` | number | No |  |
| `resolution` | string ("720p" | "1080p" | "4k") | No |  |

### Filmstrip

**Slug:** `CARDBOARD_MCP_FILMSTRIP`

Evenly spaced frames of a video tiled into one image, left to right then down, with the source time of each tile.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `count` | integer | No |  |
| `every` | number | No | Seconds between tiles instead of count |
| `media` | string | Yes | Media id or file name as shown in the timeline.tsx header |
| `columns` | integer | No |  |
| `project` | string | Yes | Project id or exact name |
| `tileWidth` | integer | No |  |

### Generate image

**Slug:** `CARDBOARD_MCP_GENERATE_IMAGE`

Generate a still image from a prompt with a hosted model and put it on the timeline as an image item. The still takes its place on the timeline at `start` straight away, and the finished image fills it when the run ends. Quality `standard` (default) or `best` (holds fine detail and spells lettering, signage and title text reliably; costs more). `image` lists project images (id or file name) to redraw or take from, such as a product shot to put in a new scene; `standard` takes up to 6, `best` up to 4, and an edit at `best` costs more than drawing from text. `durationSeconds` is how long the still sits on the timeline (default 5). Returns at once with the generation id; generation_status with `wait: true` waits on the run and fills the still when it ends. Costs credits; the error says what to fix.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | Item name; default: the prompt, shortened |
| `wait` | boolean | No | true waits for the result in this call (a long run hands back a job); default: return at once |
| `image` | array | No | Images to redraw or take from: media ids or names |
| `model` | string | No | Exact image model id; overrides quality |
| `start` | number | No | Timeline seconds; default: after the track’s last clip |
| `track` | string | No | Track name or id; default: first video track or a new "Generated" one |
| `aspect` | string ("1:1" | "16:9" | "9:16" | "4:3" | "3:4") | No | Default: the project’s, or the closest the model renders |
| `prompt` | string | Yes | What the image should show; quote any words it has to spell |
| `project` | string | Yes | Project id or exact name |
| `quality` | string ("standard" | "best") | No |  |
| `durationSeconds` | number | No | How long the still sits on the timeline |

### Generate music

**Slug:** `CARDBOARD_MCP_GENERATE_MUSIC`

Compose instrumental music with Sonilo and place it on a "Music" track: a pending audio item is filled with the finished track. `sections` change the mood at seconds into the track, not timeline time: the first starts at 0, each at least 5 s after the one before, the last at least 5 s before the end. `auto` builds them from the timeline instead: quiet where people speak (cached transcripts), energy elsewhere, an accent where a title appears. `dryRun` returns the duration and sections it would send, free, without generating. Costs credits.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `auto` | boolean | No | Build the sections from speech and titles; not with `sections` |
| `name` | string | No | Item name; default: the prompt, shortened |
| `start` | number | No | Timeline seconds; default 0 |
| `track` | string | No | Track name or id; default: a "Music" track, created if missing |
| `dryRun` | boolean | No | Return what would be sent, and generate nothing |
| `prompt` | string | Yes | The overall style |
| `project` | string | Yes | Project id or exact name |
| `sections` | array | No | Mood changes, seconds into the track |
| `durationSeconds` | integer | No | Whole seconds; default: from `start` to the end of what is on screen (of the timeline, when only sound) |

### Generate sfx

**Slug:** `CARDBOARD_MCP_GENERATE_SFX`

Generate a sound effect with ElevenLabs and place it on an "SFX" track: a pending audio item is filled with the MP3. Place one per moment, with `start` at the timeline second it belongs to. Costs credits.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | Item name; default: the prompt, shortened |
| `start` | number | No | Timeline seconds; default: after the SFX track’s last item |
| `track` | string | No | Track name or id; default: an "SFX" track, created if missing |
| `prompt` | string | Yes | The sound, e.g. "fast cinematic whoosh into an impact" |
| `project` | string | Yes | Project id or exact name |
| `durationSeconds` | number | No | Seconds; default 5 |

### Generate video

**Slug:** `CARDBOARD_MCP_GENERATE_VIDEO`

Generate a video clip from a prompt with a hosted model and put it on the timeline. The clip takes its place on the timeline at `start` straight away, and the finished video fills it when the run ends. Quality `standard` (default, Kling: 5 or 10 s, 16:9 / 9:16 / 1:1, silent) or `best` (Veo 3.1: 4 / 6 / 8 s, 16:9 / 9:16, optional audio, costs more). `model: "wan-3.0"` takes any length from 2 to 30 s in one generation, 16:9 / 9:16 / 1:1 at 720p unless `resolution` says otherwise, with free synchronised audio; it cuts between listed scenes itself and keeps the same people across them, so a story of several scenes that fits in 30 s and starts from nothing is one Wan 3.0 run (name each recurring person once with their look, then the scenes in order) rather than a clip per scene. A 30 s take waits about twelve minutes. `model: "gemini-omni-flash"` is 3-8 s at 720p (1080p when `resolution` asks for it), 16:9 / 9:16, always with native audio, and holds a four-scene story in 8 s. `image` turns a project image into the first frame and routes on its own to Hailuo 02 (standard) or Kling 3 Pro (best), which animate a still faithfully; describe only the motion. `ref` lists stills and videos the model works from rather than starts on (a product, a place, a move to copy): name them `@Image1`, `@Image2`… and `@Video1`… in the prompt in the order given. `model: "seedance-2.5"` takes up to 9 stills and 3 videos (30 s of video in all; `clip.mp4#2-8` sends seconds 2 to 8, and each second sent bills like a generated one at a lower rate); Seedance refuses any ref showing a real-looking person, so it takes no cast; MiniMax H3 and Wan 3.0 take stills only. People who must come back in another video, or in a scene you will redo on its own: write them as `@Name` in the prompt and describe the action, not the person. The first time a name is used, pass `character: ["Name: who they are, hair, wardrobe"]`; the job draws a reference sheet, keeps it in the project (the timeline header lists the cast; the sheet stills stay out of media listings) and later shots just say @Name. Cast everyone who recurs, kids included, or they change every shot. Cast shots at standard run 5-15 s on MiniMax H3 straight from the sheet stills; at best, 3-10 s on Kling 3 Pro from a drawn first frame for one person, or 2-30 s on Wan 3.0 from the sheet for two. A shot with more than one @Name goes to best on its own unless `quality` or `model` is given. `motion` only applies to the first-frame recipe. Open a cast shot medium or closer on one action so the face is large enough to keep; a wide, fast, many-body frame comes back with the face deformed. Returns at once with the generation id; generation_status with `wait: true` waits up to about half a minute at a time and fills the pending clip when the run ends. Costs credits; the error says what to fix.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `ref` | array | No | Reference stills and videos (media ids or names; a video takes #from-to), @Image1/@Video1 in order |
| `name` | string | No | Clip name; default: the prompt, shortened |
| `seed` | integer | No |  |
| `wait` | boolean | No | true waits for the result in this call (a long run hands back a job); default: return at once |
| `audio` | boolean | No | Generate sound (best tier only) |
| `image` | string | No | First frame: media id or file name |
| `model` | string | No | Exact model id; overrides quality |
| `start` | number | No | Timeline seconds; default: after the track’s last clip |
| `track` | string | No | Track name or id; default: first video track or a new "Generated" one |
| `aspect` | string ("16:9" | "9:16" | "1:1") | No | Default: the project’s, or the closest the model renders |
| `motion` | string | No | With a cast member: the action alone for the video model; the prompt then shapes the first frame |
| `prompt` | string | Yes | What the clip should show; be concrete about subject, motion and camera |
| `project` | string | Yes | Project id or exact name |
| `quality` | string ("standard" | "best") | No |  |
| `character` | array | No | "Name: description" for each @Name in the prompt the project does not know yet |
| `resolution` | string ("480p" | "720p" | "1080p") | No | Where the model offers a choice; 720p when unset. Each size bills its own rate |
| `negativePrompt` | string | No |  |
| `durationSeconds` | integer | No | Clip length; each model offers a fixed set |

### Generate voice

**Slug:** `CARDBOARD_MCP_GENERATE_VOICE`

Narrate text with a hosted ElevenLabs v3 voice and place it on the timeline: a pending audio item is filled with the MP3, and its word timings are stored as the media’s transcript. `voice` is an ElevenLabs voice id or the exact name of one of the account’s voices (default: its most recent); `docs` topic `voice` has the detail.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | Item name; default: the text, shortened |
| `text` | string | Yes | What to say; audio tags like [whispers] are allowed |
| `speed` | number | No | 1 is the voice’s own pace |
| `start` | number | No | Timeline seconds; default: after the audio track’s last item |
| `style` | number | No | How strongly the voice performs the text |
| `track` | string | No | Track name or id; default: first audio track or a new "Voiceover" one |
| `voice` | string | No | Voice id or exact name; default: the account’s most recent voice |
| `project` | string | Yes | Project id or exact name |
| `language` | string | No | BCP-47 code when the text is not in the voice’s default language |
| `stability` | number | No | Snaps to 0 (creative), 0.5 (natural) or 1 (robust) |
| `targetDuration` | number | No | Seconds the narration should fit |

### Generation status

**Slug:** `CARDBOARD_MCP_GENERATION_STATUS`

The state of a generation started by generate_video or generate_image. `wait: true` waits up to about 30 seconds: once the run ends it fills the pending clip it was placed for, otherwise it says how far the run has got, and a later call waits again.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes |  |
| `wait` | boolean | No |  |

### Grab frame

**Slug:** `CARDBOARD_MCP_GRAB_FRAME`

One frame of a video or image at a source time, returned as an image.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `at` | number | No |  |
| `media` | string | Yes | Media id or file name as shown in the timeline.tsx header |
| `width` | integer | No |  |
| `project` | string | Yes | Project id or exact name |

### Job status

**Slug:** `CARDBOARD_MCP_JOB_STATUS`

Waits on a job a Cardboard tool handed back in place of its result (export_video does after a few seconds, any other tool once it runs past about 40 seconds). Returns that tool's result once the job ends; a job still running after about 40 seconds comes back as it stands, with its progress (e.g. "Rendering 40%"), and a later call waits again.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `wait` | boolean | No | false answers at once with the job as it stands (default: wait) |
| `job_id` | string | Yes | The job id a Cardboard tool handed back |

### List media

**Slug:** `CARDBOARD_MCP_LIST_MEDIA`

Media in a project, each marked present or missing. Cast reference-sheet stills are left out unless `all` is set.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `all` | boolean | No | Include cast reference-sheet stills |
| `project` | string | Yes | Project id or exact name |

### List projects

**Slug:** `CARDBOARD_MCP_LIST_PROJECTS`

The account’s Cardboard projects with their ids, the most recently edited first, as text that reaches only you: the person sees none of it. show_projects lists the same projects for them, in a card in the chat. Lists the newest 10 unless `limit` says otherwise, and `total` counts every one that matches; `search` keeps those whose name contains it.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | How many to list (default 10) |
| `search` | string | No | Part of a project name, in any case |

### List voices

**Slug:** `CARDBOARD_MCP_LIST_VOICES`

The account’s own voices for generate_voice: favourites, recent voices and its clones.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `ownedOnly` | boolean | No | Only the account’s clones |

### Look

**Slug:** `CARDBOARD_MCP_LOOK`

Composited frames of the timeline as the player shows them, returned as images.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `at` | string | No | One frame at this timeline second, or a list of seconds (default 0) |
| `every` | number | No |  |
| `range` | array | No | [from, to] in seconds, with every |
| `sheet` | boolean | No | Return one labelled contact sheet instead of separate frames |
| `stats` | boolean | No | Measure exposure, range, color casts, saturation and dominant hues of the frames |
| `width` | integer | No | Downsample the frames to this width |
| `format` | string ("png" | "jpeg") | No |  |
| `compare` | boolean | No | Also render each frame with color work off, as a before/after |
| `project` | string | Yes | Project id or exact name |
| `reference` | string | No | Image or video (media name or id) to measure and compare against; tiled beside the frames |

### Matte media

**Slug:** `CARDBOARD_MCP_MATTE_MEDIA`

Separate the subject of a video or image from its background on a hosted GPU (costs credits); video mattes find people, image mattes the main subject. Returns a grayscale matte file, white = subject: MP4 for video, PNG for an image. Cached per media, stretch and mode.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `to` | number | No | Source seconds to stop at; one matte covers at most 5 minutes |
| `fast` | boolean | No | A lighter model that skips still frames (soft mattes only) |
| `from` | number | No | Source seconds to start at |
| `media` | string | Yes | Media id or file name |
| `project` | string | Yes | Project id or exact name |
| `occlusion` | boolean | No | A hard mask of the person, for text behind them, instead of a soft matte |

### Measure loudness

**Slug:** `CARDBOARD_MCP_MEASURE_LOUDNESS`

Integrated loudness (LUFS), loudness range, true peak and mean/max volume of a media file (offline).

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `media` | string | Yes | Media id or file name as shown in the timeline.tsx header |
| `project` | string | Yes | Project id or exact name |

### Print timeline

**Slug:** `CARDBOARD_MCP_PRINT_TIMELINE`

The canonical timeline.tsx for a project: header (aspect, duration, media table, diagnostics, rev) and the tree. A timeline longer than one result comes back in parts by line, and `from` reads on. apply_timeline takes edits copied from this text.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `from` | integer | No | First line, from 1 (default 1) |
| `lines` | integer | No | How many lines (default: as many as one result holds) |
| `project` | string | Yes | Project id or exact name |

### Probe media

**Slug:** `CARDBOARD_MCP_PROBE_MEDIA`

What a media file is: kind, duration, size, frame rate, codec, audio.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `media` | string | Yes | Media id or file name as shown in the timeline.tsx header |
| `project` | string | Yes | Project id or exact name |

### Project status

**Slug:** `CARDBOARD_MCP_PROJECT_STATUS`

How a project's uploads, edits, preview renders, playback in the chat and exports went in the last 6 hours, as the person's cards showed them, and why something failed when Cardboard can tell. `now` is where things stand; `events` is what happened, oldest first, each with how long ago. In an event, `status` and `cause` are Cardboard's verdict (`cause` from a fixed list); `error` is the failing part's own message, as evidence; `measurements` are the numbers behind it; `involves` names the file, timeline item id or second it concerns; `retryMayHelp` says whether the same work again could go differently. Its fields are for working out a cause. The person sees the cards, not this: what they want from it is a sentence or two on what they'll notice and what happens next, not the events, codes, field names or timings. Opens no card.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `project` | string | Yes | Project id or exact name |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `now` | object | Yes | Where things stand. |
| `events` | array | Yes | What happened in the last 6 hours, oldest first. |
| `project` | string | Yes | The project's name. |

### Read recipe

**Slug:** `CARDBOARD_MCP_READ_RECIPE`

Read a file of the recipe a project was started from: its brief (recipe/RECIPE.md), its data such as recipe/structure.json, the person's answers (recipe/inputs.json, which lists their own files under the media field as they upload them), a file you wrote, or one of its pictures, which comes back as an image. A folder lists its files.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `path` | string | Yes | A file or folder under recipe/, such as recipe/RECIPE.md |
| `project` | string | Yes | Project id or exact name |

### Search footage

**Slug:** `CARDBOARD_MCP_SEARCH_FOOTAGE`

Video footage for a shot, found across stock libraries (Pexels, Pixabay), archives (Internet Archive, Wikimedia Commons) and, on plans with web footage, YouTube, ranked by how well each clip shows `query`. Each result has its length, license and the link download_media takes to bring it into a project. Video only; it finds no photos.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | How many results (default 10, at most 50) |
| `query` | string | Yes | What the shot should show, in plain language |
| `maxDuration` | number | No | Prefer clips no longer than this, in seconds |
| `minDuration` | number | No | Leave out clips shorter than this, in seconds |
| `orientation` | string ("landscape" | "portrait" | "square") | No |  |

### Search music

**Slug:** `CARDBOARD_MCP_SEARCH_MUSIC`

Tracks from Cardboard's music library, ranked by how well each fits `query`, `genre` and `mood`; a filter nothing matches is dropped and the result says so. Each has its length, tempo, energy, sections with their times, the stretches quiet enough to sit under speech, a volume for each kind of mix, and the link download_media takes to bring it into a project. Free.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `mood` | string ("calm" | "chill" | "confident" | "dramatic" | "inspirational" | "melancholic" | "mysterious" | "playful" | "tense" | "upbeat") | No |  |
| `genre` | string ("acoustic" | "ambient" | "cinematic" | "electronic" | "folk" | "funk" | "pop" | "rock") | No |  |
| `limit` | integer | No | How many results (default 10, at most 20) |
| `query` | string | No | A vibe, instrument or name, like "upbeat lo-fi guitar" |

### Search sfx

**Slug:** `CARDBOARD_MCP_SEARCH_SFX`

Sound effects from Cardboard's library, ranked by how well each fits `query` within `category`. Each has its length, when it suits, a volume, and the link download_media takes to bring it into a project. Free.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | How many results (default 10, at most 20) |
| `query` | string | No | The sound, like "punch impact" or "whoosh" |
| `category` | string ("typing" | "camera" | "impact" | "ui" | "transition" | "misc") | No | typing (keyboard, mouse), camera (shutter, film, vinyl), impact (hit, punch, boom), ui (alerts, dings), transition (whoosh, riser), misc (foley, footsteps) |

### Search transcript

**Slug:** `CARDBOARD_MCP_SEARCH_TRANSCRIPT`

Find a phrase across every media of a project that has a transcript (from transcribe_media). Returns source times per media and timeline times through the clips that play them.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `phrase` | string | Yes |  |
| `project` | string | Yes | Project id or exact name |

### Search voices

**Slug:** `CARDBOARD_MCP_SEARCH_VOICES`

Search the ElevenLabs voice library, most-used voices first; needs a query or a filter. Page with `cursor`.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `query` | string | No | A name, or a description like "warm british narrator" |
| `accent` | string | No | e.g. british, american, indian |
| `cursor` | string | No | Next page of the same search |
| `gender` | string ("male" | "female" | "neutral") | No |  |
| `language` | string | No | e.g. en, es, hi |

### Send feedback

**Slug:** `CARDBOARD_MCP_SEND_FEEDBACK`

Sends a report to Cardboard's team: something in Cardboard that went wrong (`bug`), something the person asked for that Cardboard can't do yet (`request`), or anything else the person wants the team to hear (`feedback`). People at Cardboard read each report with the person's name and email, so it goes only once the person says yes. The result gives the report's reference.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `kind` | string ("bug" | "request" | "feedback") | Yes | bug: something in Cardboard went wrong; request: something the person wants that Cardboard can't do yet; feedback: anything else for the team |
| `message` | string | Yes | What happened or what the person wants, in plain words: what they asked for, what Cardboard did, and any error or ref a tool gave. People at Cardboard read it, so only what's about Cardboard. |
| `project` | string | No | The project it concerns, by id or exact name, when there is one |

### Show preview

**Slug:** `CARDBOARD_MCP_SHOW_PREVIEW`

Opens Cardboard's player in the chat on a project's latest edit, and on its export once one finishes: the person watches the export there and saves the file with its Download button. apply_timeline, undo_timeline and caption_from_transcript with apply show nothing in the chat by themselves, so this player is how the person sees what they changed: one call once a reply's edits are done shows them the result.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `project` | string | Yes | Project id or exact name |

### Show projects

**Slug:** `CARDBOARD_MCP_SHOW_PROJECTS`

Lists the person’s Cardboard projects for them, in a card in the chat: the most recently edited first, each with a picture from its footage, how long it runs and when it was last edited. They can search the list there and pick a project. The result tells you how many there are and names the newest six, with when each was edited. In ChatGPT a pick puts "Let's work on …" in their message box for them to send; in Claude the card turns into that project's player and notes which project they opened, which reaches you with their next message.

### Show recipes

**Slug:** `CARDBOARD_MCP_SHOW_RECIPES`

What Cardboard can make: shows the person Cardboard's recipes in a card in the chat, the answer when they ask what Cardboard can make or do: finished edits by Cardboard's team, each a starting point that makes the person's own footage into that kind of video (a travel montage, a podcast clip, a brand launch film, captions for a talking video, an effect). Each plays its edit with its name, what it makes and its size; the person can open one to watch it with sound, switch to a kind, search them, and pick one there. When the person has said what they want to make, read the docs topic `recipes`, which lists every recipe with what it makes, and pass `picks`: only the recipes that make that whole kind of video, best first (one or two is fine; an effect, a title or a caption style is not a whole video), with `heading` saying what they are for; `also`: recipes of other kinds the same footage would suit, so they can change their mind; and `filters`: a few short guesses at what they want, each with the recipes it fits. The card shows those first and keeps every other recipe a tap away. Call show_recipes without them first if you do not yet know the slugs. `search` is for words the person asked to search for, not for finding what fits their idea: it finds recipes by what the words mean as well as the words themselves, and leads the card with them. The result names the matching recipes with their slugs, for start_recipe. A recipe marked usesGeneration makes some shots with generation, which costs credits.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `also` | array | No | Slugs of recipes of other kinds the same footage suits, at most 6 |
| `picks` | array | No | Slugs of the recipes that make the kind of video the person asked for, best first, at most 6; fewer is better than one that doesn't fit |
| `search` | string | No | Words the person asked to search the recipes for, e.g. "travel" or "podcast". To suggest recipes for what they want to make, pass picks instead |
| `filters` | array | No | At most 5 guesses at what the person wants, each a label of a word or two (e.g. "Calm", "With captions") and the slugs it fits, from any recipe |
| `heading` | string | No | What the picks are for, a few words starting with "For", e.g. "For your trip" |

### Start recipe

**Slug:** `CARDBOARD_MCP_START_RECIPE`

Makes a new project from one of Cardboard's recipes: the recipe's brief, graphics and data in its recipe/ folder, the recipe's own media in the project, and the person's answers in recipe/inputs.json. When the recipe takes media, the result opens upload_media's card on the new project unless `upload` is false. `answers` holds the person's answers to the recipe's questions by id, as far as they have given them; the result names the questions still open.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | The new project's name; the recipe's name when left out |
| `recipe` | string | Yes | The recipe's slug from show_recipes, or its exact name |
| `upload` | boolean | No | False when the video's media is about a subject rather than the person's own life (a history explainer, a city, a public figure), so you find it on the web or generate it instead of asking them to upload; true or left out opens the upload card for their own footage |
| `answers` | object | No | The person's answers by question id, such as { "about": "A week in Lisbon" } |
| `aspect_ratio` | string | No | A size the recipe offers, such as 9:16; the recipe's own when left out |

### Timeline history

**Slug:** `CARDBOARD_MCP_TIMELINE_HISTORY`

Saved timeline revisions, newest first.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `project` | string | Yes | Project id or exact name |

### Transcribe media

**Slug:** `CARDBOARD_MCP_TRANSCRIBE_MEDIA`

The transcript of a media file’s audio (any video or audio in the project), with per-word timings, in seconds. It uses Cardboard’s transcription, and the result is kept with the project for every later call. `timeline: true` maps times through the clips that play the media instead of source seconds.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `to` | number | No | Stop before this second (default: the end) |
| `from` | number | No | Start at this second (default 0) |
| `force` | boolean | No | Re-transcribe even when cached |
| `media` | string | Yes | Media id or file name as shown in the timeline.tsx header |
| `format` | string ("text" | "words" | "json" | "srt" | "vtt") | No | text (default), words ([mm:ss.mmm] word lines), srt, vtt or json |
| `project` | string | Yes | Project id or exact name |
| `language` | string | No | BCP-47 code; default detects |
| `timeline` | boolean | No |  |

### Undo timeline

**Slug:** `CARDBOARD_MCP_UNDO_TIMELINE`

Restore the previous timeline revision, or a specific rev from timeline_history.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `rev` | integer | No |  |
| `project` | string | Yes | Project id or exact name |

### Upload media

**Slug:** `CARDBOARD_MCP_UPLOAD_MEDIA`

Opens Cardboard's upload card in the chat, where the person picks video, audio or photo files (JPEG, PNG, HEIC, WebP or GIF) on their device and uploads them into a project; the card says when each has uploaded, and photos join the project as images. It is how footage and photos the person has, or is about to send, reach Cardboard: files attached to the chat itself stay with the chat. Documents such as a brief, script or shot list are not uploaded: the card takes none, and one attached to the chat is read there. On a phone, Photos hands over a copy of a video, which is fine for previews: before export_video, ask whether to replace those clips with their originals, and if so call this with `replace` for each.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `goal` | string | No | What the person asked to make, as a short phrase the card shows after 'Ready to make', addressed to them and in their language: 'your 1-minute travel montage', 'her birthday video'. Leave it out when they haven't said. |
| `project` | string | Yes | Project id or exact name |
| `replace` | string | No | Media id of a clip uploaded from a phone, to replace with its original before an export |

### Verify timeline

**Slug:** `CARDBOARD_MCP_VERIFY_TIMELINE`

Lint the timeline: overlaps, gaps, off-screen text, clips past their source, missing media.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `project` | string | Yes | Project id or exact name |

### Waveform image

**Slug:** `CARDBOARD_MCP_WAVEFORM_IMAGE`

The audio of a media file drawn as an image.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `media` | string | Yes | Media id or file name as shown in the timeline.tsx header |
| `width` | integer | No |  |
| `height` | integer | No |  |
| `project` | string | Yes | Project id or exact name |

### Waveform levels

**Slug:** `CARDBOARD_MCP_WAVEFORM_LEVELS`

Peak and RMS audio levels (0-1) sampled across a media file; for finding silence, beats or the loudest moment.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `media` | string | Yes | Media id or file name as shown in the timeline.tsx header |
| `points` | integer | No |  |
| `project` | string | Yes | Project id or exact name |
