Skip to content

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

31 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

@putervision/vision-memory-mcp

npm version Website License

@putervision/vision-memory-mcp is a zero-infrastructure, local-first Model Context Protocol (MCP) server and CLI tool that provides AI coding assistants (such as Cursor, Claude Code, Gemini, or Copilot) with visual state caching using perceptual hashing, local CLIP embeddings, and transition graphs to eliminate repetitive vision LLM calls.

🌐 Official Documentation & Website: visionmemorymcp.com


⚡ Quick Start & Installation

Prerequisites: Node.js >= 18.17.0

1. Installation

# Global installation via npm
npm install -g @putervision/vision-memory-mcp

2. Workspace Initialization

Run init in your project root to scaffold database directories, .gitignore, .env, and IDE rules:

vision-memory-mcp init --yes

3. Basic MCP Client Setup

Add to your MCP client config (e.g. .cursor/mcp.json or .vscode/mcp.json):

{
  "mcpServers": {
    "vision-memory-mcp": {
      "command": "vision-memory-mcp",
      "args": ["run"]
    }
  }
}

Alternative Options & CLI Usage Examples

# Run stdio MCP server directly via binary (after global install)
vision-memory-mcp run

# Re-initialize across all registered workspace projects
vision-memory-mcp init-global

# Health check dependencies, sharp bindings, and git safety
vision-memory-mcp doctor

# Run health diagnostics & aggregate metrics across all registered projects
vision-memory-mcp doctor-global

# Inspect stored visual states and metadata in terminal ASCII table
vision-memory-mcp inspect

# Register baseline design mockup contract (Visual SDD)
vision-memory-mcp spec set --name "Dashboard" --file ./dashboard-spec.png

# Save visual memory checkpoint snapshot
vision-memory-mcp snapshot save --name "v1.0-milestone"

# Ingest WebM / MP4 video recording into visual state memory timeline
vision-memory-mcp video ingest ./playwright-test.webm --category playwright_test

# Open interactive force-directed visual graph viewer in browser
vision-memory-mcp view

🌟 Key Highlights

  • 👁️ Perceptual Visual Caching: Sub-5ms L1/L2 dHash zero-token fast-path layout recognition.
  • 🎬 WebM & MP4 Video Ingestion: Digest E2E test recordings & screen captures into searchable keyframe visual states & state transition graphs.
  • ⚡ 27 Core MCP Tools: Full visual state ingestion, video memory parsing, evidence packs (create_evidence_pack), trajectory comparison, semantic vector retrieval, element grounding, visual SDD, and snapshot checkpoints.
  • 🔗 Dual-MCP Synergy & Immutable Evidence Packs: Deeply bridges @putervision/state-memory-mcp task DAGs with visual state memory, generating cryptographically hashable evidence packs for compliance and audit trails.
  • 📉 Up to 90% Token Savings: Caches UI states locally using dHash, local CLIP vector search, and accessibility trees to cut LLM vision costs.
  • 🚀 Sub-5ms Fast-Path Latency: Eliminates repetitive vision LLM API calls and avoids visual hallucination loops.
  • 🎯 Element Grounding & Action Target Prediction: Maps screen elements to CSS selectors and coordinates for deterministic UI interaction.
  • 🎨 Visual Spec-Driven Development (Visual SDD): Register design mockups or screenshots as perceptual baseline contracts to verify visual regression.
  • 🛡️ 100% Local-First Privacy: Local LanceDB vector store, local CLIP model, zero cloud telemetry, and PII redaction guarantees.

🚀 Architecture At a Glance

                     Incoming Screen
                            │
                            ▼
              ┌──────────────────────────────┐
              │ L1: In-Memory Cache Lookup   │ ──(Hit)──▶ Return Cached Description & Grounded Elements
              └──────────────┬───────────────┘
                             │ (Miss)
                             ▼
              ┌──────────────────────────────┐
              │ L2: Perceptual Hash Scan     │ ──(Hit)──▶ Return Cached Description & Grounded Elements
              └──────────────┬───────────────┘
                             │ (Miss)
                             ▼
              ┌──────────────────────────────┐
              │ L3: Local CLIP Vector Search │ ──(Hit)──▶ Return Semantically Close
              └──────────────┬───────────────┘
                             │ (Miss)
                             ▼
              ┌──────────────────────────────┐
              │ L4: Vision LLM Fallback      │ ──(Ingest)──▶ Save Redacted State to DB
              └──────────────┬───────────────┘

📚 Documentation Directory

Explore dedicated guides and deep dives in the docs/ directory:

Guide Description
🚀 Features & Architecture Key features, 4-tier retrieval pipeline, element grounding, and Dual MCP Synergy.
📘 Formal API Reference Complete specifications, parameters, and schemas for all 23 MCP tools.
🔌 Multi-IDE Integration Guide Step-by-step configs for Cursor, Claude Desktop, Antigravity, Windsurf, Zed, Roo Code & Agent Rules.
💻 CLI Commands Reference Full guide for all 16 CLI management, visual spec, and snapshot commands.
⚙️ Configuration Guide Complete .env environment variables, thresholds, and L4 vision fallback setup.
🔒 Storage Encryption & Security Encryption details, local storage privacy, and PII masking guarantees.
🤝 Contributing Guide Development setup, codebase structure, and submission guidelines.
🛡️ Security Policy Security vulnerability reporting and privacy disclosures.
📜 Changelog Chronological record of release features, fixes, and patch updates.

🧪 Testing

# Run full unit and integration test suite across all 37 test suites
npm run test

⚖️ License & Disclaimers

Developed and maintained by PuterVision LLC. Released under the MIT License.

  • Local Storage Guarantee: Provided "as is" without warranty. Screenshots, perceptual hashes, vector embeddings, and transition graphs are stored locally unencrypted at the application level in .vision-memory-mcp/. Zero telemetry or analytics data is ever transmitted.
  • Trademarks & Non-Affiliation: Product names (Cursor, Claude Code, Gemini, Windsurf, VS Code, Sharp, LanceDB, ONNX, HuggingFace) are property of their respective owners and used solely for compatibility identification.

About

Persistent visual cache for LLM-driven software development. Caches screenshots using perceptual hashing, vector search, and AX trees to prevent token overhead and visual hallucination loops.

Topics

Resources

Contributing

Security policy

Stars

30 stars

Watchers

0 watching

Forks

Releases

Packages

Used by

Contributors

Languages