Skip to main content

VI3ION — Measured Visual Perception for AI Agents

CI License: Apache-2.0

VI3ION is a local perception engine for AI agents. It reads images, screenshots and diagrams, and returns measured evidence instead of guesses: OCR text with pixel coordinates, geometry, per-element colours with contrast ratios, spatial relations, and version diffs between two states of the same screen.

It runs entirely on your machine, speaks the Model Context Protocol, and works with any MCP-capable agent — Claude Code, Cursor, Windsurf, Continue, Zed, OpenCode, and your own local models on Ollama, llama.cpp, LM Studio or vLLM.

  • Measured, not inferred — every value is read from the pixels and labelled as observed, inferred, or unknown.
  • Local-first — no image ever leaves the machine; the OCR engine is ONNX.
  • Agent-agnostic — one MCP server; an optional OpenCode plugin adds zero-config auto-analysis.
  • Version-aware — remembers every image it has seen and spots when the same screen changed.

Resource profile

See PERFORMANCE.md for measured peak RAM/CPU during a run alongside OpenCode (~0.6 GB peak, ~1 min cold per image, multi-threaded inference burst).

The text brief, measured

A brief that a model with no vision can reason over — no model calls, no network, ~5s on a 1919×949 screenshot:

Component Score What it measures
Brief fidelity 91.9% weighted mean across the three bundled fixtures
Text recall 85.0% share of real text that reached the brief
Text precision 92.4% share of the brief's quoted text that is really in the image
Region accuracy 99.0% matched text filed under the right region
Structure 100% composition line, colour map, shape sentences, honesty note
vi3ion brief screenshot.png    # the brief itself
vi3ion score screenshot.png    # score it against hand-transcribed ground truth
vi3ion score --all             # score every bundled fixture

Scores come from tests/fixtures/*.expected.json — hand-transcribed files of the same images — so the claim is reproducible and every regression is visible. The table above is the hard case; on a clean settings dialog the same pipeline scores 98.5%. The gap between the two is the honest story: layout and composition hold up, and what costs points is OCR, not placement. On the difficult image the loss is concentrated in three known defects — index digits read as 84/85/88/89 instead of 04/05/08/09, misread Japanese labels, and one fused word.

What it looks like

Image 1919x949 (screenshot.png). Dominant colour: #080808 (32%). Colour map: row 1, col 1: black, dark; … Left column: `"00 + "PORTFOLIO"" (uncertain) @[136, 167, 288, 181]; "BUILT TO" (split from "BUILTTO") @[121, 231, 673, 325]; … Composition: 2 tall pale columns at 28% and 72% of the width split the frame; the largest colour area is a dark red horizontal band in the bottom (17% of the frame); text is concentrated in the right and left thirds. Shapes: a horizontal band (spans most of the image width) in the bottom, dark red … a rectangular area (spans most of the image width) in the centre, grey …; two pale or white columns and a red round shape sit inside it. a tall vertical column (spans most of the image height) in the left, pale or white. …

Every quoted value keeps its pixel box, so a follow-up can crop and re-read exactly that region. Uncertain reads stay marked (uncertain); a word OCR fused is separated but recorded as (split from "BUILTTO"). Nothing is ever silently corrected.

Honest boundaries

The brief deliberately does not name objects — it says "a small rectangular area in the upper right", never "a button". Object names are the reading model's job, and keeping them out is what makes the evidence auditable. Large decorative lettering too faint for OCR is not transcribed, and the brief says so in its closing note.

How it ships

It is packaged as an installable agent skill/plugin, not a standalone product:

Layer What it is
Core Agent-independent perception pipeline (Python). Pure computation: ingestion → pixels → geometry → OCR → spatial relations → verification → text brief.
Adapter MCP server (stdio) exposing 11 tools. This is what the coding agent talks to.
Skill Written instructions (vi3ion/skill/SKILL.md, also registered with OpenCode) telling the agent when and how to call the tools.
Plugin Optional OpenCode plugin (@subadeepan_y/vi3ion-opencode) that measures attached images automatically and introduces Vi3ion to the agent.
Dashboard Local React dev dashboard (dashboard/) for testing and inspecting evidence. Never required in production.

Quickstart

# 1. install (OCR included; ~200 MB of dependencies)
pip install vi3ion

# ...or from a checkout
python -m venv .venv
.venv\Scripts\activate            # Windows  |  source .venv/bin/activate  # POSIX
pip install -e ".[dev]"

# 2. check the install
vi3ion doctor                      # OCR, RAM, registry, local runtimes, MCP entry point
vi3ion mcp-check                   # real MCP handshake: does the server start?

# 3. analyse an image from the CLI
vi3ion analyze screenshot.png --detail standard
vi3ion brief screenshot.png        # text-only brief for a vision-less model
vi3ion score screenshot.png        # brief fidelity vs fixtures/*.expected.json
vi3ion local                      # local LLM runtimes + the recommended Vi3ion role
vi3ion ingest shots\ --label run # register a screenshot folder in the image memory
vi3ion prune                   # drop remembered images whose file no longer exists
vi3ion health --tier              # config, OCR status, machine tier

# 4. optional: the local dashboard (not needed by agents)
vi3ion serve                       # API + dashboard on http://127.0.0.1:8765

# 5. run the test suite
pytest

Connect your coding agent (MCP)

Add the stdio MCP server to your agent's config:

{
  "mcpServers": {
    "VI3ION": {
      "command": "vi3ion-mcp",
      "args": [],
      "env": { "VI3ION_DATA_DIR": "~/.vi3ion" }
    }
  }
}

On Windows, prefer running the module through your interpreter instead of the generated launcher:

{
  "mcpServers": {
    "VI3ION": {
      "command": "C:\\path\\to\\python.exe",
      "args": ["-m", "vi3ion.mcp_server"],
      "env": { "VI3ION_DATA_DIR": "~/.vi3ion" }
    }
  }
}

Why: pip install -U vi3ion rewrites the vi3ion-mcp.exe launcher, and Windows refuses to replace a file that a running editor has open — the upgrade then fails with "file is being used by another process". python -m vi3ion.mcp_server is never rewritten and picks up new code immediately.

If your editor reports an MCP failure

vi3ion mcp-check      # runs a real MCP handshake and prints what happened
vi3ion doctor         # OCR, RAM, registry, local runtimes, entry point

vi3ion mcp-check spawns the server exactly like the editor does and reports the exit code and the number of tools it found. If it passes but the editor still complains, restart the editor.

See adapters/opencode/ for an OpenCode-specific example and install notes.

Local models (Ollama, llama.cpp, LM Studio, vLLM, Unsloth, …)

Vi3ion detects local runtimes, reports the models they serve and tells the agent whether it must act as the eyes or as an assistant. Local runtimes get a compact evidence tier, a token budget and a single analysis pass. See LOCAL_MODELS.md.

The evidence contract

Everything Vi3ion returns obeys one envelope (ToolResponse):

  • summary — human-readable one-liner of what was found.
  • evidence[] — items of kind text | shape | color | object | relationship | note | image, each with label, confidence, attributes, and a bounding box in original image pixels ([x0, y0, x1, y1]).
  • evidence_total / truncated — pagination awareness.
  • cached — true when the result was served from the evidence store.

Measured colours per element

Every text and shape item also carries its own measured colour in attributes:

Attribute Meaning
ink_hex, ink_rgb, ink_name the element's own colour (letter ink, or a shape's fill)
bg_hex, bg_name the local background it sits on
contrast WCAG-style luminance ratio between the two (1..21)
ink_share how much of the box the ink covers

The text brief renders the same measurement inline, unquoted so the fidelity score is unaffected:

"Save" (uncertain) ink:#f8f8f8 on:#2563eb contrast:4.9 @[373, 619, 421, 640]

verify_claim uses the same measurement, so "the text 'Save' is white" and "the Save button is blue" are answered with a verdict instead of a guess.

  • timings_ms — per-module timing breakdown.
  • verification — for verify_claim: verified | contradicted | inconclusive plus measurements, never opinions.

Coordinate space is always the original image, even for region crops (inspect_region remaps crop coordinates back).

Observed vs inferred

Evidence Marked
OCR text, shapes, colours, measured relations, geometry observed
Semantic object labels (when a provider is enabled) inferred

Agents must preserve that distinction when reporting to users.

MCP tools

Tool Purpose
inspect_image Ingest + analyse an image (by path or image_id).
inspect_region Deep-dive on [x0,y0,x1,y1]; coordinates mapped back to original.
query_evidence Query stored evidence by kind/text/region/confidence without re-analysis.
verify_claim Check a claim ("Save is aligned with Cancel") against measurements.
compare_regions Measure differences between two regions.
cross_check_text Verify an OCR reading against project source string literals.
list_images List remembered images (labels + identity metadata, including the perceptual hash).
remember_image Attach a persistent label to an image.
diff_images Compare two versions of a screen (observed text/layout changes and a pixel-level comparison).
local_stack Detect local LLM runtimes (Ollama, llama.cpp, LM Studio, vLLM, …), their models, and the recommended Vi3ion role.
doctor Self-check the setup: OCR, RAM/tier, registry, local runtimes, editor wiring.

All results are returned as JSON strings over the MCP transport.

The text brief (vi3ion brief / vi3ion score) is currently a CLI entry point rather than an MCP tool; wiring it into the adapter is a small, tracked gap rather than an implied capability.

Architecture

vi3ion/
  config.py            pydantic settings (VI3ION_* env vars)
  brief.py             the text-only brief: compose every section into one page
  image_memory.py      identity signatures, similarity, version diffs
  visual_diff.py       pixel-level comparison of two screenshots
  core/pixels/element_color.py  per-element colour measurement (ink + background)
  local_stack.py       local LLM runtime detection (Ollama, llama.cpp, LM Studio, vLLM, …)
  analyzer.py          OCR -> rows -> spatial regions -> per-region budget
  text_merge.py        split fused words, join fragments, pair numbers
  describe_shapes.py   region sentences: contours, pale columns, colour areas
  composition.py       large colour areas + "how the frame is divided"
  evaluate.py          brief-fidelity scorer against hand-transcribed truth
  colors.py            named colour set (Lab nearest-name)
  schemas/             evidence contract: BBox, Evidence, ToolResponse, claims
  storage/             SQLite schema, image store, repositories
  core/
    ingestion/         validation, EXIF orientation, dedup, thumbnails
    pixels/            CIELAB palette, statistics, colour regions
    geometry/          adaptive Canny, contours, shapes, measurements
    ocr/               rapidocr-onnxruntime (with tesseract fallback)
    semantics/         optional semantic provider (mock/remote/OpenAI-compatible)
    spatial/           scene graph, rows/columns, relationships
    verification/      claim parser + verifier
    engine.py          orchestrator (single entry to everything)
  server/              FastAPI app (dev dashboard API + static mount)
  mcp_server.py        MCP stdio server (11 tools) — the portable interface
  agent_interface/      legacy shim → vi3ion.mcp_server (kept for old launchers)
dashboard/              React + Vite dev dashboard
skill/                  the agent skill instructions
tests/                  82 tests: schema, ingestion, geometry, verification,
                        API, text merging, composition, brief fidelity

Security model

  • Server binds loopback by default (127.0.0.1).
  • Agent-supplied filesystem paths are restricted to VI3ION_ALLOWED_ROOTS (default: cwd + data dir). Anything outside is refused.
  • Images are validated at ingestion (magic bytes, format whitelist, size and pixel limits). Image content is never executed; OCR/semantics output is treated as untrusted data.
  • The MCP server never prints to stdout (that is the protocol channel).

Semantic providers (local, opt-in)

All perception beyond OCR/geometry is inferred and tagged as such. Enable providers via VI3ION_SEMANTIC_PROVIDER (comma-separated):

Value Provider Notes
mock deterministic JSON fixtures keyed by image hash default for tests; no model loaded
florence Florence-2 base (object detection + region captions) input capped at 768px, boxes mapped back
owlvit OWL-ViT open-vocabulary detector vocabulary in core/semantics/vocabulary.json (extend without code changes)
clip CLIP zero-shot scene tags top 3, marked suggested
remote OpenAI-compatible API image leaves the machine — opt-in only

Heavy models require pip install -e ".[semantic]" (torch + transformers). If a provider is enabled but its dependencies/weights are missing, it reports an error and the analysis continues with the remaining providers.

# run with all local semantic layers
VI3ION_SEMANTIC_PROVIDER=florence,owlvit,clip vi3ion analyze shot.png

Development

npm --prefix dashboard install
npm --prefix dashboard run build     # TS + Vite; dist/ mounts at server root
pytest                                # full suite

The dashboard proxies /api to the server and is only mounted when dashboard/dist exists.

Metadata

Release files for vi3ion 0.1.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for vi3ion 0.1.0
File Size Uploaded Provenance Actions
vi3ion-0.1.0.tar.gz 3.4 MB With provenance Details for vi3ion-0.1.0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for vi3ion 0.1.0
File Interpreter ABI Platform Actions
vi3ion-0.1.0-py3-none-any.whl Python 3 none any Details for vi3ion-0.1.0-py3-none-any.whl

Total release size: 6.9 MB

Release files / vi3ion-0.1.0.tar.gz

Download URL vi3ion-0.1.0.tar.gz
Size 3.4 MB
Tags Source
SHA-256 checksum
How to use checksums
04e2a65086bd5b8f9bdb6847b661140a645a66c6d39dc27d959f6d698d958f36
BLAKE2b-256 checksum
How to use checksums
f3b21f983463f4ee673bda1bad79dc69fb78ca47c132f03f47b25e6c58cbabe2
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 13, 2026.

Transparency log

Release files / vi3ion-0.1.0-py3-none-any.whl

Download URL vi3ion-0.1.0-py3-none-any.whl
Size 3.4 MB
Tags Python 3
SHA-256 checksum
How to use checksums
e07e0f5876588d65f8cd1e42bdd0ee6e095bdf3369787eed9dd64235a34e2b83
BLAKE2b-256 checksum
How to use checksums
7c0308b97235c6dab5431fbd34f1d512e06d9bd3e9bdc730fde67287b3b0983c
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 13, 2026.

Transparency log

Security for vi3ion 0.1.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

Full provenance

Both files in this release have been uploaded with provenance metadata.

Select from 2 files

Attestation for vi3ion-0.1.0.tar.gz

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 13, 2026.

Transparency log

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page