# Instavar MCP server

> Enables AI agents to create, scaffold, and manage video projects using Remotion and HyperFrames templates through local or hosted workflows.

- Repository: https://github.com/instavar/mcp-server
- Page: https://hostedmcp.org/servers/instavar/mcp-server
- Transport: stdio, remote
- Stars: 0
- Latest version: 0.7.1

## Install

### Claude Code

```sh
claude mcp add --env 'INSTAVAR_API_KEY=<YOUR_INSTAVAR_API_KEY>' mcp-server -- npx -y @instavar/mcp-server
```

### Cursor (`~/.cursor/mcp.json`)

```json
{
  "mcpServers": {
    "mcp-server": {
      "command": "npx",
      "args": [
        "-y",
        "@instavar/mcp-server"
      ],
      "env": {
        "INSTAVAR_API_KEY": "<YOUR_INSTAVAR_API_KEY>"
      }
    }
  }
}
```

### VS Code (`.vscode/mcp.json`)

```json
{
  "servers": {
    "mcp-server": {
      "type": "stdio",
      "command": "npx",
      "args": [
        "-y",
        "@instavar/mcp-server"
      ],
      "env": {
        "INSTAVAR_API_KEY": "<YOUR_INSTAVAR_API_KEY>"
      }
    }
  }
}
```

### VS Code CLI

```sh
code --add-mcp '{"name":"mcp-server","type":"stdio","command":"npx","args":["-y","@instavar/mcp-server"],"env":{"INSTAVAR_API_KEY":"<YOUR_INSTAVAR_API_KEY>"}}'
```

### Claude Desktop (`claude_desktop_config.json`)

```json
{
  "mcpServers": {
    "mcp-server": {
      "command": "npx",
      "args": [
        "-y",
        "@instavar/mcp-server"
      ],
      "env": {
        "INSTAVAR_API_KEY": "<YOUR_INSTAVAR_API_KEY>"
      }
    }
  }
}
```

### Codex

```sh
codex mcp add mcp-server --env 'INSTAVAR_API_KEY=<YOUR_INSTAVAR_API_KEY>' -- npx -y @instavar/mcp-server
```

### Codex config.toml (`~/.codex/config.toml`)

```toml
[mcp_servers.mcp-server]
command = "npx"
args = ["-y", "@instavar/mcp-server"]

[mcp_servers.mcp-server.env]
INSTAVAR_API_KEY = "<YOUR_INSTAVAR_API_KEY>"
```

### Gemini CLI

```sh
gemini mcp add -s user -e 'INSTAVAR_API_KEY=<YOUR_INSTAVAR_API_KEY>' mcp-server npx -- -y @instavar/mcp-server
```

### Gemini settings.json (`~/.gemini/settings.json`)

```json
{
  "mcpServers": {
    "mcp-server": {
      "command": "npx",
      "args": [
        "-y",
        "@instavar/mcp-server"
      ],
      "env": {
        "INSTAVAR_API_KEY": "<YOUR_INSTAVAR_API_KEY>"
      }
    }
  }
}
```

## Environment variables

| Name | Required | Secret | Description |
|---|---|---|---|
| `INSTAVAR_API_KEY` | no | yes | Optional key from https://instavar.com/studio/settings that unlocks hosted workflows. |
| `INSTAVAR_BASE_URL` | no | no | Override the Instavar API host. Defaults to https://instavar.com. |

## Tools (15)

- `get_creative_guide`: Read practical guidance before drafting concise plain or poetic copy, choosing carousel stories, designing visuals or recording human feedback. Returns guidance for the calling assistant to apply, not generated copy or saved feedback. Omit guideId to list guides. (read-only)
- `prepare_announcement`: Prepare one paired announcement-card-v1 template, continue its caller-held project, edit copy or switch frameworks. Returns source files for local rendering. For the paired announcement-card-v1 or a HyperFrames announcement request, use prepare_announcement. Never infer a framework from creative wording. Omit framework unless the user explicitly chooses one or says no preference. If needs-selection, ask the user. Continue with the latest returned project and expectedRevision; apply edits through edits before switching. Keep the returned project document for later calls. Never describe this caller-held document as a saved hosted project. VideoSpec templates use prepare_video_template in either framework. (read-only)
- `prepare_video_template`: Validate one VideoSpec against the paired template contract and return local source for the chosen framework, or switch an existing project's framework. For a VideoSpec template in Remotion or HyperFrames, use prepare_video_template with the VideoSpec. Never infer a framework from creative wording; omit framework unless the user chose one or said no preference, and ask the user on needs-selection. Continue with the returned project: edit project.spec, then call again to regenerate or to switch frameworks. A rejected field is unsupported in both frameworks; fix it rather than dropping it. The tool returns local source and commands; it does not render, save or upload. (read-only)
- `get_capabilities`: Call first. Reports free local features and optional account features. (read-only)
- `list_carousel_templates`: List the account-free editorial carousel story structures. (read-only)
- `get_carousel_schema`: Return the JSON Schema for deterministic Instavar carousel decks. (read-only)
- `scaffold_carousel_deck`: Build a deterministic editorial carousel deck from accepted copy. This does not render, save, or publish it. (read-only)
- `list_templates`: List the published video template families, each available in Remotion and HyperFrames, and optionally filter by output aspect ratio. (read-only)
- `get_template`: Get one template's purpose, aspect ratios, scene kinds, and example identifier. (read-only)
- `get_video_schema`: Return the published JSON Schema for VideoSpec version 1.0. (read-only)
- `get_example`: Return a valid starter example for one template family. (read-only)
- `propose_video_storyboard`: Turn an ordinary video request into a three-beat visual proposal and recommended template. Pass templateId to preserve an accepted template when changing only the aspect; omit it for a new direction. This tool does not generate images, save a project, render, or publish. (read-only)
- `scaffold_video_spec`: Return a deterministic VideoSpec skeleton. This tool does not generate creative copy or write files. (read-only)
- `get_render_instructions`: Return the clone, install, validate, preview, render, and QA workflow. (read-only)
- `diagnose_render_error`: Classify a local validation or render error and return a safe next step. (read-only)

## FAQ

### Do I need an account or API key to use Instavar?

No, you can use the free local templates for Remotion from Claude Code or Codex without an account or API key.

### What does the hosted Studio workflow provide?

Adding an API key unlocks a hosted workflow that includes creating, rendering, approving, publishing, and viewing metrics.

### How do I use the hosted tools?

To unlock hosted Studio tools, you must create an API key at the Instavar website and add it to your MCP client configuration as an environment variable.
