🌐 Leer en Español: README.es.md
Note
OpenCut Controller is a robust Model Context Protocol (MCP) server designed to fully automate and control the OpenCut Video Editor directly from AI models (like Claude or agents inside n8n).
By leveraging Playwright under the hood, this server seamlessly injects into the OpenCut browser environment, granting LLMs programmatic access to manipulate the timeline, scenes, media assets, rendering engine, and more—effectively turning OpenCut into an AI-driven, headless video editing powerhouse.
- 161 Comprehensive MCP Tools: Full programmatic control over OpenCut's core editing capabilities.
- Dual Transport Support: Connect locally via
stdio(default) or integrate remotely via modernHTTP Streamabletransport. - Playwright Integration: Connects directly to the OpenCut web interface to manipulate application state in real-time.
- Contextual Resources: Inspect the editor's live state, current projects, and timeline tracks.
- Pre-built MCP Prompts: Ready-to-use templates for common high-level editing tasks.
Ensure you have Bun installed on your system.
# Clone the repository
git clone https://github.com/JXUE0/opencut-controller.git
cd opencut-controller
# Install dependencies (Playwright browsers will install automatically)
bun install
# 3. Patch the Local Editor:
# To enable MCP control, you need to apply small patches to the OpenCut source code. We provide an automated script for this:
bun run scripts/patch-editor.ts ../path-to-opencut
# 4. Install & Run Editor:
cd ../path-to-opencut
bun install
bun dev:webTip
The bun install command will automatically trigger a postinstall script to download the required Playwright Chromium binaries. No manual browser setup is needed!
The server can be launched using two different transport protocols depending on your client environment.
Ideal for standard local MCP clients like Claude Desktop.
bun run src/index.tsIdeal for integrating with external workflow tools like n8n or remote services. The server listens at http://localhost:3002/mcp.
Warning
Environment variable syntax varies depending on your operating system. Make sure to use the correct command below to prevent errors.
Linux / macOS (Bash):
TRANSPORT_TYPE=http PORT=3002 bun run src/index.tsWindows (PowerShell):
$env:TRANSPORT_TYPE="http"; $env:PORT="3002"; bun run src/index.tsThe controller exposes 161 highly granular tools to the LLM, categorized as follows:
| Category | Tools | Description |
|---|---|---|
| 📁 Project | 6 | Create, open, save, and export OpenCut projects. |
| 🎬 Scenes | 8 | Manage scene lifecycle, renaming, and active state. |
| 5 | Control timeline playback, pause, stop, and seek. | |
| ⏱️ Timeline Tracks | 7 | Add, remove, lock, and manage track visibility. |
| 🧩 Timeline Elements | 12 | Manipulate clips: trim, split, move, duplicate, and select. |
| ✨ Timeline Effects | 9 | Apply and tweak visual effects and presets. |
| 📌 Keyframes | 8 | Granular control over animation interpolation and easing. |
| 🎯 Selection/Clipboard | 10 | Standard editing operations (copy, cut, paste, delete). |
| 🕰️ History | 5 | Time-travel through undo/redo states. |
| 🎞️ Media | 10 | Import, search, trim, and optimize raw media files. |
| 📝 Text | 7 | Generate and format text overlays and animations. |
| 🎵 Audio | 11 | Search music/SFX, mix volumes, and apply audio fades. |
| 🎨 Stickers/Canvas | 11 | Add overlays, manage canvas zoom, resolution, and pan. |
| ⚙️ Transcribe/Export | 10 | Auto-transcribe audio and manage the final video rendering. |
| 🔖 Bookmarks/Panels | 10 | Navigate the UI and manage layout layouts. |
| 🔑 Auth & Storage | 13 | Manage user sessions, project state backups, and sync. |
| 🌐 API | 8 | Directly interact with OpenCut's backend endpoints. |
Resources provide context directly to the LLM about the current state of OpenCut:
opencut://projects- JSON array of all available OpenCut projects.opencut://editor/state- Live tracking of the active project, scene, playhead time, and playback status.opencut://timeline/tracks- Detailed breakdown of tracks in the active scene.
Quick-start templates for complex actions:
create_intro_video- Automates creating a 10-second intro with text overlays.add_background_music- Searches the OpenCut sound library and trims music to fit.apply_transition- Seamlessly blends two clips with a specified effect.
Make sure to replace
/absolute/path/to/opencut-controllerwith the actual path on your local machine.
To connect OpenCut Controller to your local Claude Desktop app, add the following to your claude_desktop_config.json:
{
"mcpServers": {
"opencut-controller": {
"command": "bun",
"args": ["run", "src/index.ts"],
"cwd": "/absolute/path/to/opencut-controller"
}
}
}- "Playwright browser not found": Ensure
postinstallran successfully. You can trigger it manually withbun run playwright install chromium. - "PowerShell: The term 'TRANSPORT_TYPE=http' is not recognized": You are using bash syntax in Windows. Use
$env:TRANSPORT_TYPE="http"; bun run src/index.tsinstead. - Connection Refused: Ensure OpenCut is open and accessible by Playwright.
Tip
If you encounter TypeScript errors during development or execution, you can verify your types locally by running bun run build (which executes tsc --noEmit).
Cause: You are trying to use the MCP server with the production web app (opencut.app).
Fix: You must run the OpenCut editor locally. The production site doesn't expose the internal hooks required for MCP control.
Cause: react and react-dom versions mismatch in the monorepo.
Fix: Ensure both are set to the exact same version (e.g., 19.0.0) in the root package.json and run bun install.
Cause: Missing environment variables in apps/web/.env.
Fix: Ensure you have a .env file in apps/web/. We have updated the code to make most variables optional, but BETTER_AUTH_SECRET may still be needed for some features.
Cause: The local OpenCut server (Next.js) is still compiling.
Fix: Wait until you see ✓ Ready in the editor terminal before starting the MCP server.
This project's original codebase and concept were inspired by and built upon the foundational work done in RavenMeld/OpenCut-MCP. We extend our sincere gratitude to RavenMeld for their pioneering work on connecting OpenCut via the Model Context Protocol.
This project is licensed under the MIT License.