The full upstream README, mirrored here for reference. Install config, tool schemas, adoption signals, and an original overview live on the Video Frames listing page.
An MCP server that lets image-only models look at video: frames with timecodes, plus measurable video properties.
The server provides these tools:
view_frames - Sample a time range and return frames as images, each preceded by its timecodevideo_info - Container metadata, optionally with a whole-file scene/silence/loudness scanThe model you are talking to must accept image input. Without it, the returned frames are dropped or degraded to text.
This is a local server: it is not hosted anywhere, and a client has to be pointed at it. See Self-Hosted below.
That installs one console script, and the console script is the server. Point a client at it:
With no subcommand and piped stdio it speaks MCP; on a terminal it prints help instead of hanging. mcp-video-frames doctor checks the environment it will run in.
This path expects ffmpeg and ffprobe on PATH. If you would rather have them installed into a private virtual environment, along with a ready-made client config, use Self-Hosted below instead.
Installs nothing into your system Python: dependencies go into the project's own .venv/, and the client config points at that interpreter directly.
setup_mcp.py only does three things:
.venv/ in this directory (run it with any Python 3.10+ interpreter);requirements.txt into that .venv/;mcp-config.json, with the paths already filled in.Options:
If ffmpeg is missing the script offers to download a prebuilt build into .venv/ (Windows), to point at one you installed, or to skip. Nothing is ever installed system-wide.
This reports the ffmpeg/ffprobe paths and versions, whether the required filters are present, and whether the cache directory is writable — naming whatever is missing rather than leaving you to guess. It finds a venv-local ffmpeg on its own, so nothing has to be exported first.
test_server.py goes further and speaks real MCP to the server over stdio, so the whole path can be verified before any client is configured:
It checks the handshake, the tool list, the 2n + 1 content-block ordering, whether a single-frame request comes back as PNG, and that an over-limit request is refused — and that stdout stays clean for the JSON-RPC stream.
Merge the generated mcp-config.json into your client's config. If an mcpServers section already exists, just add the video-frames entry to it. run_server.py puts src/ on sys.path itself, so no PYTHONPATH is needed and nothing has to be pip installed anywhere.
Replace /path/to/mcp-video-frames with the actual path to this repository on your system. On Windows the interpreter is .venv\Scripts\python.exe.
Uninstall: delete .venv/ and remove that config entry. Nothing else was written.
ffmpeg and ffprobe. setup_mcp.py installs (or downloads) them into the project's own .venv/, and the server looks for them beside its own interpreter first, then on PATH — so a venv-local install needs no FFMPEG_PATH to be exported. ffmpeg is required; without ffprobe, metadata falls back to parsing ffmpeg's own header output (fewer fields), and doctor says so explicitlyview_framesSamples a time range and returns an interleaved timecode + image sequence. Set start and end to the same value to look at a single moment.
| Parameter | Type | Default | Notes |
|---|---|---|---|
video | string | — | absolute path (required) |
start | number | 0 | start in seconds |
end | number | start + interval | end in seconds |
interval | number | 1.0 | sampling interval, 0.05–600 s |
max_frames | integer | 12 | frames for this call; may be raised up to the image limit |
max_edge | integer | 768 | long-edge size in pixels, 64–4096 |
format | jpeg | png | jpeg for a range, png for one frame | |
quality | integer | 85 | jpeg quality, 1–100 |
The result is 2n + 1 content blocks:
The block order is load-bearing: an image without its timecode cannot be reasoned about in time. clamped reports whether the range was trimmed to the video's length, cached how many frames came from disk, and limits repeats the budget in force so the numbers do not have to be discovered by being rejected.
A range defaults to jpeg because at equal edge length it is about an order of magnitude smaller, which fits many more frames inside a client's byte budget. Ask for a single frame as png when detail matters.
Over a limit the call fails: nothing is truncated and the interval is never widened. Silently coarsening the sampling grid would invalidate the caller's assumption about time precision, so the whole call fails instead. If any single frame fails validation, no frames are returned.
video_infoReturns video metadata. detail="basic" reads container headers only and returns immediately; detail="full" adds an exhaustive whole-file scan for scene cuts, silences and EBU R128 loudness.
With detail="basic" the scene_cuts / silences / loudness / scan fields are absent rather than empty — "no value" and "not scanned" mean different things. The first full call scans the whole file; later calls reuse the cache. force=true recomputes.
Environment variables take precedence over defaults.
| Variable | Default | Purpose |
|---|---|---|
MCP_VIDEO_MAX_IMAGES | 20 | maximum images per call (the one that matters most) |
MCP_VIDEO_CACHE_DIR | .cache/ as generated by setup_mcp.py; <system temp>/mcp-video-frames-cache otherwise | cache root |
FFMPEG_PATH / FFPROBE_PATH | auto-detected | checked before PATH |
MCP_VIDEO_MAX_IMAGE_BYTES | 10485760 | per-frame byte limit |
MCP_VIDEO_MAX_TOTAL_BYTES | 41943040 | per-result total byte limit |
MCP_VIDEO_MAX_IMAGE_DIM | 8192 | per-frame edge limit |
MCP_VIDEO_CACHE_MAX_BYTES | 5368709120 | cache size limit |
MCP_VIDEO_FRAME_MAX_AGE_DAYS | 14 | frame age limit |
MCP_VIDEO_SCENE_THRESHOLD | 0.3 | scene-change sensitivity |
MCP_VIDEO_MAX_IMAGES caps how many frames one call may return. Set it to match your client: limits differ between clients, and while too low is merely conservative, too high makes the entire batch unusable. max_frames defaults to 12 and may be raised only up to this limit.
The effective limits are also stated in the tool descriptions and repeated in every view_frames result, so a caller can see them without being rejected first.
The same package ships a CLI for troubleshooting and batch work:
Without installing the project (Self-Hosted above), use the launcher for the same subcommands:
Running it with no arguments prints help; as an MCP server it takes no arguments. When stdin is a pipe (as an MCP client provides) a bare invocation starts the server, which is how nothing has to be configured for the stdio case.
doctor prints its JSON report and then a one-line human verdict ("Self-check passed" / "Self-check failed"), so it is the one subcommand whose stdout is not pure JSON. The CLI and the MCP tools call the same core functions, so behaviour cannot drift between what works in a terminal and what works for a model.
Location: depends on how the server was started.
| Deployment | Cache root |
|---|---|
setup_mcp.py (the recommended one) | .cache/ inside this project |
A plain package install with no MCP_VIDEO_CACHE_DIR | <system temp>/mcp-video-frames-cache |
The setup script configures the project-local .cache/ deliberately, together with cwd. A relative path resolves against the client's working directory, so without cwd the cache would land wherever the client happened to start — less predictable than the temp default, not more. It is already in .gitignore.
MCP_VIDEO_CACHE_DIR overrides either default, and the resolved path is printed to stderr at startup.
Everything in the cache is reproducible — deleting the directory is always safe, and only costs a re-probe.
Entries are keyed by content hash (size + mtime + the first and last 1 MB), and frames are stored individually by absolute timestamp, so overlapping views reuse work: look at 0–20 s, then 10–30 s, and 10–20 s is already on disk.
If you left the cache in the system temp directory, do not rely on the operating system to clean it up — the platforms differ too much:
| Platform | Temp-directory cleanup |
|---|---|
| Windows | Essentially none. Storage Sense runs only under disk pressure and skips files in use |
| Linux | systemd-tmpfiles ages out /tmp (~10 days); /tmp is often tmpfs and is cleared on reboot |
| macOS | $TMPDIR is cleaned by the system at unspecified times |
So the server cleans up after itself, evicting whole video entries by LRU once MCP_VIDEO_CACHE_MAX_BYTES (default 5 GB) is exceeded, plus a 14-day frame age limit (MCP_VIDEO_FRAME_MAX_AGE_DAYS).
The tiers follow recomputation cost: frames are cheap and go first, while whole-file scan results (video_info(detail="full")) are expensive to rebuild and are kept preferentially.
Eviction runs asynchronously after a tool call returns — it never blocks a response, and there is no full scan at startup.
Multiple clients share one cache. Reads and writes are guarded by a file lock, writes go through a temp file plus os.replace, and a frame that has been evicted between listing and reading is regenerated rather than reported as an error.
MIT — see LICENSE.