Skip to content

CHANGELOG.md

Latest commit

 

History

History
115 lines (92 loc) · 5 KB

CHANGELOG.md

File metadata and controls

115 lines (92 loc) · 5 KB
Raw

Changelog

1.2

Added

  • Multi-Tenant Support with User Isolation

    • Complete per-user memory isolation via user_id field
    • Automatic user summary generation and management
    • User-scoped queries, stats, and memory operations
    • REST API endpoints:
      • GET /users/:userId/summary - Get user memory summary
      • GET /users/:userId/stats - Get user statistics
      • POST /memory/add with user_id field
      • POST /memory/query with filters.user_id
    • Database schema with user_id indexing for performance
    • Migration tool preserves user isolation during import
    • Full user namespace separation in memory storage

  • Migration Tool for Competitor Import

    • Standalone CLI tool to migrate from Zep, Mem0, and Supermemory to OpenMemory
    • API-based architecture (no backend dependencies required)
    • Automatic rate limiting for billion-scale exports:
      • Zep: 1 req/s (session-based iteration)
      • Mem0: 20 req/s (user-based export with Token authentication)
      • Supermemory: 5-25 req/s (document pagination)
    • Features:
      • Preserves user isolation and metadata
      • JSONL export format for portability
      • Built-in verification via OpenMemory API
      • Progress tracking and resume support
      • Automatic retry on rate limit (429) errors
    • Reads backend configuration from root .env file (OM_PORT, OM_API_KEY)
    • Environment variable fallback chain: CLI flags → OPENMEMORY_* → OM_* → defaults
    • Example: node migrate/index.js --from mem0 --api-key KEY --verify
    • Full documentation in migrate/README.md

  • HYBRID Tier Performance Mode

    • New tier achieving 100% keyword match accuracy with synthetic embeddings
    • BM25 scoring algorithm for relevance ranking
    • Exact phrase matching with case-insensitive search
    • N-gram keyword extraction (unigrams, bigrams, trigrams)
    • Performance: 800-1000 QPS, 0.5GB RAM per 10k memories
    • Configurable via OM_TIER=hybrid, OM_KEYWORD_BOOST, OM_KEYWORD_MIN_LENGTH
    • Best for: Documentation search, code search, technical references

  • Memory Compression Engine: Auto-compresses chat/memory content to reduce tokens and latency

    • 5 compression algorithms: whitespace, filler, semantic, aggressive, balanced
    • Auto-selects optimal algorithm based on content analysis
    • Batch compression support for multiple texts
    • Live savings metrics (tokens saved, latency reduction, compression ratio)
    • Real-time statistics tracking across all compressions
    • Integrated into memory storage with automatic compression
    • REST API endpoints: /api/compression/compress, /api/compression/batch, /api/compression/analyze, /api/compression/stats
    • Example usage in examples/backend/compression-examples.mjs

  • VS Code Extension with AI Auto-Link

    • Auto-links OpenMemory to 6 AI tools: Cursor, Claude, Windsurf, GitHub Copilot, Codex
    • Dual mode support: Direct HTTP or MCP (Model Context Protocol)
    • Status bar UI with clickable menu for easy control
    • Toggle between HTTP/MCP mode in real-time
    • Zero-config setup - automatically detects backend and writes configs
    • Performance optimizations:
      • ESH (Event Signature Hash): Deduplicates ~70% redundant saves
      • HCR (Hybrid Context Recall): Sub-80ms queries with sector filtering
      • MVC (Micro-Vector Cache): 32-entry LRU cache saves ~60% embedding calls
    • Settings for backend URL, API key, MCP mode toggle
    • Postinstall script for automatic setup

  • API Authentication & Security

    • API key authentication with timing-safe comparison
    • Rate limiting middleware (configurable, default 100 req/min)
    • Compact 75-line auth implementation
    • Environment-based configuration

  • CI/CD

    • GitHub Action for automated Docker build testing
    • Ensures Docker images build successfully on every push

Changed

  • Optimized all compression code for maximum efficiency
  • Removed verbose comments and long variable names
  • Active voice, casual naming convention throughout compression engine
  • Streamlined memory routes with integrated compression
  • Ultra-compact compression implementation (<100 lines core logic)

Fixed

  • MCP Tool Names (Breaking Change): Changed from dot notation to underscores for Windsurf IDE compatibility

    • openmemory.query → openmemory_query
    • openmemory.store → openmemory_store
    • openmemory.reinforce → openmemory_reinforce
    • openmemory.list → openmemory_list
    • openmemory.get → openmemory_get
    • Complies with MCP naming rule: ^[a-zA-Z0-9_-]{1,64}$

  • PostgreSQL Custom Table Name: Fixed hardcoded memories table in openmemory://config resource

    • Now correctly uses OM_PG_TABLE environment variable
    • Exports memories_table from database module with fully-qualified name
    • Fixes "relation 'memories' does not exist" error with custom table names
    • Works for both PostgreSQL (with schema) and SQLite

Fixed

  • VS Code extension connection issues (health endpoint)
  • MCP protocol integration for AI tools
  • Extension now properly passes MCP flag to all writers