MemoryOS

🎉 If you like our project, please give us a star ⭐ on GitHub for the latest update.

MemoryOS is designed to provide a memory operating system for personalized AI agents, enabling more coherent, personalized, and context-aware interactions. Drawing inspiration from memory management principles in operating systems, it adopts a hierarchical storage architecture with four core modules: Storage, Updating, Retrieval, and Generation, to achieve comprehensive and efficient memory management. On the LoCoMo benchmark, the model achieved average improvements of 49.11% and 46.18% in F1 and BLEU-1 scores.

• Paper: https://arxiv.org/abs/2506.06326
• Website: https://baijia.online/memoryos/
• Documentation: https://bai-lab.github.io/MemoryOS/docs
• YouTube Video: MemoryOS MCP + RAG Agent That Can Remember Anything
• https://www.youtube.com/watch?v=WHQu8fpEOaU

✨Key Features

• 🏆 TOP Performance in Memory Management

The SOTA results in long-term memory benchmarks, boosting F1 scores by 49.11% and BLEU-1 by 46.18% on the LoCoMo benchmark.

• 🧠 Plug-and-Play Memory Management Architecture

Enables seamless integration of pluggable memory modules—including storage engines, update strategies, and retrieval algorithms.

• ✨ Agent Workflow Create with Ease (MemoryOS-MCP)

Inject long-term memory capabilities into various AI applications by calling modular tools provided by the MCP Server.

• 🌐 Universal LLM Support

MemoryOS seamlessly integrates with a wide range of LLMs (e.g., OpenAI, Deepseek, Qwen ...)

📣 Latest News

• [new] 🔥🔥 🔥 [2025-07-15]: 🔌 Support for Vector Database Chromadb
• [new] 🔥🔥 🔥 [2025-07-15]: 🔌 Integrate Docker into deployment
• [new] 🔥🔥 [2025-07-14]: ⚡ Acceleration of MCP parallelization
• [new] 🔥🔥 [2025-07-14]: 🔌 Support for BGE-M3 & Qwen3 embeddings on PyPI and MCP.
• [new] 🔥 [2025-07-09]: 📊 Evaluation of the MemoryOS on LoCoMo Dataset: Publicly Available 👉Reproduce.
• [new] 🔥 [2025-07-08]: 🏆 New Config Parameter
• New parameter configuration: similarity_threshold. For configuration file, see 📖 Documentation page.
• [new] [2025-07-07]: 🚀5 Times Faster
• The MemoryOS (PYPI) implementation has been upgraded: 5 times faster (reduction in latency) through parallelization optimizations.
• [new] [2025-07-07]: ✨R1 models Support Now
• MemoryOS supports configuring and using inference models such as Deepseek-r1 and Qwen3..
• [new] [2025-07-07]: ✨MemoryOS Playground Launched
• The Playground of MemoryOS Platform has been launched! 👉MemoryOS Platform. If you need an Invitation Code, please feel free to reach Contact US.
• [new] [2025-06-15]:🛠️ Open-sourced MemoryOS-MCP released! Now configurable on agent clients for seamless integration and customization. 👉 MemoryOS-MCP.
• [2025-05-30]: 📄 Paper-Memory OS of AI Agent is available on arXiv: https://arxiv.org/abs/2506.06326.
• [2025-05-30]: Initial version of MemoryOS launched! Featuring short-term, mid-term, and long-term persona Memory with automated user profile and knowledge updating.

🔥 MemoryOS Support List

Type	Name	Open Source	Support	Configuration	Description
Agent Client	Claude Desktop	❌	✅	claude_desktop_config.json	Anthropic official client
Cline	✅	✅	VS Code settings	VS Code extension
Cursor	❌	✅	Settings panel	AI code editor
Model Provider	OpenAI	❌	✅	OPENAI_API_KEY	GPT-4, GPT-3.5, etc.
Anthropic	❌	✅	ANTHROPIC_API_KEY	Claude series
Deepseek-R1	✅	✅	DEEPSEEK_API_KEY	Chinese large model
Qwen/Qwen3	✅	✅	QWEN_API_KEY	Alibaba Qwen
vLLM	✅	✅	Local deployment	Local model inference
Llama_factory	✅	✅	Local deployment	Local fine-tuning deployment

All model calls use the OpenAI API interface; you need to supply the API key and base URL.

📑 Table of Contents

• ✨ Features
• 🔥 News
• 🔍Support Lists
• 📁Project Structure
• 🎯 Quick Start
• PYPI Install MemoryOS
• MemoryOS-MCP
• MemoryOS-chromadb
• Docker
• ☑️ Todo List
• 🔬 How to Reproduce the Results in the Paper
• 📖 Documentation
• 🌟 Cite
• 🤝 Join the Community

🏗️ System Architecture

🏗️ Project Structure

memoryos/
├── __init__.py            # Initializes the MemoryOS package
├── __pycache__/           # Python cache directory (auto-generated)
├── long_term.py           # Manages long-term persona memory (user profile, knowledge)
├── memoryos.py            # Main class for MemoryOS, orchestrating all components
├── mid_term.py            # Manages mid-term memory, consolidating short-term interactions
├── prompts.py             # Contains prompts used for LLM interactions (e.g., summarization, analysis)
├── retriever.py           # Retrieves relevant information from all memory layers
├── short_term.py          # Manages short-term memory for recent interactions
├── updater.py             # Processes memory updates, including promoting information between layers
└── utils.py               # Utility functions used across the library

📖MemoryOS_PyPi Getting Started

Prerequisites

• Python >= 3.10
• conda create -n MemoryOS python=3.10
• conda activate MemoryOS

Installation

Download from PyPi

pip install memoryos-pro -i https://pypi.org/simple

Download from GitHub (latest version)

git clone https://github.com/BAI-LAB/MemoryOS.git
cd MemoryOS/memoryos-pypi
pip install -r requirements.txt

Basic Usage

import os
from memoryos import Memoryos

# --- Basic Configuration ---
USER_ID = "demo_user"
ASSISTANT_ID = "demo_assistant"
API_KEY = "YOUR_OPENAI_API_KEY"  # Replace with your key
BASE_URL = ""  # Optional: if using a custom OpenAI endpoint
DATA_STORAGE_PATH = "./simple_demo_data"
LLM_MODEL = "gpt-4o-mini"

def simple_demo():
    print("MemoryOS Simple Demo")

    # 1. Initialize MemoryOS
    print("Initializing MemoryOS...")
    try:
        memo = Memoryos(
            user_id=USER_ID,
            openai_api_key=API_KEY,
            openai_base_url=BASE_URL,
            data_storage_path=DATA_STORAGE_PATH,
            llm_model=LLM_MODEL,
            assistant_id=ASSISTANT_ID,
            short_term_capacity=7,  
            mid_term_heat_threshold=5,  
            retrieval_queue_capacity=7,
            long_term_knowledge_capacity=100,
            #Support Qwen/Qwen3-Embedding-0.6B, BAAI/bge-m3, all-MiniLM-L6-v2
            embedding_model_name="BAAI/bge-m3"
        )
        print("MemoryOS initialized successfully!\n")
    except Exception as e:
        print(f"Error: {e}")
        return

    # 2. Add some basic memories
    print("Adding some memories...")

    memo.add_memory(
        user_input="Hi! I'm Tom, I work as a data scientist in San Francisco.",
        agent_response="Hello Tom! Nice to meet you. Data science is such an exciting field. What kind of data do you work with?"
    )

    test_query = "What do you remember about my job?"
    print(f"User: {test_query}")

    response = memo.get_response(
        query=test_query,
    )

    print(f"Assistant: {response}")

if __name__ == "__main__":
    simple_demo()

📖 MemoryOS-MCP Getting Started

🔧 Core Tools

1. add_memory

Saves the content of the conversation between the user and the AI assistant into the memory system, for the purpose of building a persistent dialogue history and contextual record.

2. retrieve_memory

Retrieves related historical dialogues, user preferences, and knowledge information from the memory system based on a query, helping the AI assistant understand the user’s needs and background.

3. get_user_profile

Obtains a user profile generated from the analysis of historical dialogues, including the user’s personality traits, interest preferences, and relevant knowledge background.

1. Install dependencies

cd memoryos-mcp
pip install -r requirements.txt

2. configuration

Edit config.json：

{
  "user_id": "user ID",
  "openai_api_key": "OpenAI API key",
  "openai_base_url": "https://api.openai.com/v1",
  "data_storage_path": "./memoryos_data",
  "assistant_id": "assistant_id",
  "llm_model": "gpt-4o-mini"
  "embedding_model_name":"BAAI/bge-m3"
}

3. Start the server

python server_new.py --config config.json

4. Test

python test_comprehensive.py

5. Configure it on Cline and other clients

Copy the mcp.json file over, and make sure the file path is correct.

command": "/root/miniconda3/envs/memos/bin/python"
#This should be changed to the Python interpreter of your virtual environment

📖MemoryOS_Chromadb Getting Started

1. Install dependencies

cd memoryos-chromadb
pip install -r requirements.txt

2. Test

```bash The edit information is in comprehensive_test.py memoryos = Memoryos( user_id='travel_user_test', openai_api_key='', openai_base_url='', data_storage_path='.