oxframe

io.github.oxygenframePublished by GitHub account oxygenframev0.24.3Updated Oct 29, 2026

Make videos from code: check scenes frame by frame, inspect nodes, render a frame, search the docs.

VerifiedSTDIODesktop onlyDeveloper ToolsMedia & Design

Overview

AI-generated overview

Local MCP server for oxframe, a code-based video tool: lets an assistant check scenes, inspect nodes, render frames and search the docs.

What you can do
  • Check a project: compile and produce a storyboard plus a report of problems.
  • Inspect a scene: read the node tree at a given time, optionally with render passes.
  • Render: draw a single frame or a render graph, or run a full render.
  • Browse components: list the components available to a project.
  • Search the oxframe documentation.
When to use it
Useful when building or debugging oxframe video projects in code and you want an assistant to verify visual changes, inspect scene structure at a timestamp, or render frames without opening the editor.
Requirements
Runs as a local process over stdio, started with the oxframe command and the mcp argument. Needs the oxframe CLI installed (Cargo package oxframe-cli, or a prebuilt binary) and, for rendering, Rust, a C linker and ffmpeg. No accounts, API keys or environment variables are declared.
Before you install
The project is under very active development and its API is not stable, so pin the exact version and check the changelog before upgrading. Rendering writes output files into the project. The CLI checks crates.io once a day for newer versions unless OXFRAME_NO_UPDATE_CHECK is set. The README says the CLI itself makes no network requests, but publishing uploads to oxframe.dev.

Installation

In SourceWeft

  1. Open oxframe in the dashboard and add it to a workspace.
  2. Enable the server for the chats that should use its tools.

Desktop only via STDIO. STDIO servers start a local process, so they need the SourceWeft desktop host.

Other MCP clients

Follow the launch instructions in the repository.

README

oxframe-cli

[crates.io] [ci] [docs] [license]

Status: oxframe is under very active development. The API is not stable yet and may change from version to version. Pin the exact version in your Cargo.toml and check the changelog before upgrading.

The oxframe command for oxframe projects: create, preview with hot reload, render, check.

sh
cargo install oxframe-cli          # or a prebuilt binary:#   Linux, macOS:  curl -fsSL https://github.com/oxygenframe/oxframe-cli/releases/latest/download/install.sh | sh#   Homebrew:      brew install oxygenframe/tap/oxframe#   Windows:       powershell -ExecutionPolicy Bypass -c "irm https://github.com/oxygenframe/oxframe-cli/releases/latest/download/install.ps1 | iex"oxframe init hello && cd hellooxframe dev --open                 # editor on http://127.0.0.1:3000/?token=…oxframe render                     # out/hello.mp4oxframe publish --title "Hello"    # upload to oxframe.dev, print a link with a playeroxframe check                      # compile, then storyboard + report.jsonoxframe inspect --at 2.5           # scene tree at that time, as JSON (--graph adds passes)oxframe snapshot --at 1.5          # one frame as PNG in out/snapshots/oxframe agents                     # refresh AGENTS.md and the Claude Code skilloxframe upgrade                    # move the project to this CLI's SDK versionoxframe doctor                     # Rust, a C linker, ffmpeg: what is missing and how to fix itoxframe transcribe vo/intro.wav    # word times of a recorded voice-over (whisper.cpp, local)

Updating

sh
cargo install oxframe-cli --force  # the CLIoxframe upgrade                    # then, in each project: SDK pin, Cargo.lock, agent files

Projects pin the SDK (oxframe = "=0.22.0"), so a new release never changes an existing project by itself. Once a day the CLI checks crates.io in the background (cargo search) and mentions a newer version; set OXFRAME_NO_UPDATE_CHECK=1 to turn that off (it is off on CI).

Full reference: https://oxframe.dev/docs/cli.

AI coding agents

oxframe init writes AGENTS.md, CLAUDE.md (@AGENTS.md) and a skill in .claude/skills/oxframe/ (workflow + API cheat sheet). They tell agents to verify visual changes with oxframe check (storyboard and report.json) and never to run oxframe dev. oxframe agents refreshes them after an upgrade; files without the oxframe-agents marker (edited by you) are kept unless --force.

oxframe mcp is an MCP server over stdio with check, inspect, render_graph, render_frame, render, list_components and docs_search:

json
{ "mcpServers": { "oxframe": { "command": "oxframe", "args": ["mcp"] } } }
  • MCP Registry name: mcp-name: io.github.oxygenframe/oxframe

How oxframe dev works

browser ──WS──▶ oxframe dev (127.0.0.1:3000) ──WS──▶ <project> preview --port 0                 serves the embedded editor           restarted on every change                 watches src/, assets/, Cargo.toml → cargo build
  • Changes (debounced 200 ms) trigger cargo build; the editor shows Building…, then either Reloaded (it re-seeks to the same frame) or the compiler errors with file and line — while the previous build keeps running.
  • The old process gets Shutdown, 2 s grace, then is killed (process tree on Windows). Crashes restart the project up to three times.
  • Security: loopback only, Origin check, one-time token in the URL; the CLI runs only cargo and your project and makes no network requests.

Exit codes: 0 ok, 1 build error, 2 environment (ffmpeg, port), 3 version mismatch.

The embedded editor

ui/dist is the editor-ui release pinned in ui.lock, packed into the binary with rust-embed (no network access in build.rs or cargo install).

sh
./scripts/fetch-ui.sh             # download the pinned releasejust build-ui ../oxframe-web       # or build it from a sibling checkoutoxframe dev --ui-dir ../oxframe-web/packages/editor-ui/dist   # develop the editor

ui/debug-client/ is a minimal single-file protocol client kept for debugging.

Development

sh
cargo test                                          # unit tests, ui.lock checkcargo test --test e2e -- --ignored --nocapture      # init → dev → reload → render (needs ../oxframe-sdk)

Licensed under MIT or Apache-2.0.

License

Licensed under either of Apache License, Version 2.0 or MIT license at your option.

Source: README.md at commit 879ec7e

Tools

0
SourceWeft started this package once in an isolated sandbox, without credentials, to list its tools. That failed: the package type cannot run in the sandbox.

Version history

6
  1. v0.24.3LatestOct 29, 2026
  2. v0.24.1Oct 26, 2026
  3. v0.24.0Oct 26, 2026
  4. v0.23.8Oct 26, 2026
  5. v0.23.4Oct 25, 2026
  6. v0.23.3Oct 25, 2026

Score

50% of the applicable checks met

How complete this listing is, computed from the registry entry, the endpoint and public sources. Not a rating of the server and not a statement that it is safe or working today: reachability is a dated check, and no installs or reviews go into the score.

  • Reached in the last 30 days25 pts

    Keep the endpoint answering the MCP handshake; SourceWeft probes it every 30 days.

  • Auth declared10 pts

    Declare the credential headers in the registry entry, or keep the endpoint answering the probe so its auth can be classified.

  • Tools listed15 pts

    Answer tools/list without a credential, or ship a package that starts in a sandbox without one.

  • DescriptionRequired15 pts
  • Logo10 pts
  • Documentation15 pts
  • License10 pts