Generalization-capable memory layer for LLMs with episodic buffers, semantic graphs, and spreading activation retrieval
Project description
Remind
Generalization-capable memory layer for LLMs. Unlike simple RAG systems that store verbatim text, Remind extracts and maintains generalized concepts from experiences, mimicking how human memory consolidates specific episodes into abstract knowledge.
Key Features
- Episodic Buffer: Raw experiences/interactions are logged as episodes
- LLM-Powered Consolidation: Episodes are processed into generalized concepts (like "sleeping" consolidates memory)
- Semantic Concept Graph: Concepts have typed relations (implies, contradicts, specializes, etc.)
- Spreading Activation Retrieval: Queries activate not just matching concepts but related ones through the graph
- Multi-Provider Support: Works with Anthropic, OpenAI, Azure OpenAI, and Ollama (local)
Architecture
┌─────────────────────────────────────────────────────────────────┐
│ LLM Provider (Abstract) │
│ (Claude / OpenAI / Azure OpenAI / Ollama) │
└─────────────────────┬───────────────────────┬───────────────────┘
│ │
read/query write/update
│ │
▼ ▼
┌─────────────────────────────────────────────────────────────────┐
│ MEMORY INTERFACE │
│ remember() / recall() │
└─────────────────────┬───────────────────────────────────────────┘
│
┌─────────────┼─────────────┐
▼ ▼ ▼
┌─────────┐ ┌──────────┐ ┌──────────────┐
│EPISODIC │ │ SEMANTIC │ │ RELATIONS │
│ BUFFER │ │ CONCEPTS │ │ GRAPH │
└─────────┘ └──────────┘ └──────────────┘
│ │ │
└──────┬──────┴──────────────┘
▼
┌─────────────────┐ ┌─────────────────┐
│ CONSOLIDATION │◄────►│ RETRIEVER │
│ (LLM-based) │ │ (Spreading Act) │
└─────────────────┘ └─────────────────┘
Environment Setup
Copy the example environment file and add your API keys:
cp .env.example .env
# Edit .env with your API keys
Using OpenAI
# Required
OPENAI_API_KEY=sk-...
# Provider selection
LLM_PROVIDER=openai
EMBEDDING_PROVIDER=openai
OpenAI can be used for both LLM and embeddings.
Using Anthropic (Claude)
# Required
ANTHROPIC_API_KEY=sk-ant-...
# Provider selection
LLM_PROVIDER=anthropic
EMBEDDING_PROVIDER=openai # Anthropic has no embeddings, use OpenAI or Ollama
Anthropic provides LLM only. Pair with OpenAI or Ollama for embeddings.
Using Azure OpenAI
# Required
AZURE_OPENAI_API_KEY=...
AZURE_OPENAI_API_BASE_URL=https://your-resource.openai.azure.com
AZURE_OPENAI_API_VERSION=2024-02-15-preview
AZURE_OPENAI_DEPLOYMENT_NAME=gpt-4
AZURE_OPENAI_EMBEDDING_DEPLOYMENT_NAME=text-embedding-3-small
# Provider selection
LLM_PROVIDER=azure_openai
EMBEDDING_PROVIDER=azure_openai
Using Ollama (Local)
No API keys required. Install Ollama and pull models:
ollama pull llama3.2 # For LLM
ollama pull nomic-embed-text # For embeddings
Optional configuration:
OLLAMA_URL=http://localhost:11434
OLLAMA_LLM_MODEL=llama3.2
OLLAMA_EMBEDDING_MODEL=nomic-embed-text
# Provider selection
LLM_PROVIDER=ollama
EMBEDDING_PROVIDER=ollama
Usage
MCP Server (for AI Agents)
Remind can run as an MCP (Model Context Protocol) server, allowing AI agents in IDEs like Cursor to use it as their memory system.
Using uv, no installation needed:
uv run remind-mcp --port 8765
Configure your MCP client (e.g., Cursor's .cursor/mcp.json):
{
"mcpServers": {
"remind": {
"url": "http://127.0.0.1:8765/sse?db=my-project"
}
}
}
The db parameter accepts a simple name which resolves to ~/.remind/{name}.db. Each project can have its own database.
Available MCP Tools:
remember- Store experiences/observationsrecall- Retrieve relevant memoriesconsolidate- Process episodes into conceptsinspect- View concepts or episodesstats- Memory statistics
Agent Instructions: Copy docs/AGENTS.md into your project's documentation to instruct AI agents how to use Remind as their memory system.
CLI
Run with uv (no install needed):
uv run remind remember "User likes Python and Rust"
uv run remind consolidate
uv run remind recall "What languages does the user know?"
Or install globally for a remind command (see Installation).
# Add episodes
remind remember "User likes Python and Rust"
remind remember "User works on backend systems"
# Run consolidation
remind consolidate
# Query memory
remind recall "What languages does the user know?"
# Inspect concepts
remind inspect
remind inspect <concept-id>
# Show statistics
remind stats
# Export/Import
remind export memory-backup.json
remind import memory-backup.json
# Entity management
remind entities # List all entities
remind entities file:src/auth.ts # Show details for a specific entity
remind mentions file:src/auth.ts # Show episodes mentioning an entity
# Episode filtering
remind decisions # Show decision-type episodes
remind questions # Show open questions/uncertainties
remind search "keyword" # Search concepts by keyword
# Session management
remind end-session # End session and consolidate pending episodes
# Use different providers
remind --llm openai --embedding openai remember "..."
remind --llm anthropic --embedding openai remember "..."
remind --llm azure_openai --embedding azure_openai remember "..."
remind --llm ollama --embedding ollama remember "..."
Python API
import asyncio
from dotenv import load_dotenv
from remind import create_memory
load_dotenv() # Load .env file
async def main():
memory = create_memory(
llm_provider="openai", # or "anthropic", "azure_openai", "ollama"
embedding_provider="openai", # or "azure_openai", "ollama"
)
# Log experiences (episodes) - fast, no LLM calls
memory.remember("User mentioned they prefer Python for backend work")
memory.remember("User is building a distributed system")
memory.remember("User values type safety")
# Run consolidation - this is where LLM work happens
result = await memory.consolidate(force=True)
print(f"Created {result.concepts_created} concepts")
# Retrieve relevant concepts
context = await memory.recall("What programming preferences?")
print(context)
asyncio.run(main())
Core Concepts
Episodes
Raw experiences - specific interactions or observations. These are temporary and get consolidated.
Concepts
Generalized knowledge extracted from episodes. Each concept has:
- Summary: Natural language description
- Confidence: How certain (0.0-1.0)
- Instance count: How many episodes support this
- Relations: Typed edges to other concepts
- Conditions: When this applies
- Exceptions: Known cases where it doesn't hold
Relations
Typed connections between concepts:
implies- If A then likely Bcontradicts- A and B are in tensionspecializes- A is a more specific version of Bgeneralizes- A is more general than Bcauses- A leads to Bcorrelates- A and B tend to co-occurpart_of- A is a component of Bcontext_of- A provides context for B
Consolidation
The "sleep" process where episodes are processed into concepts. Runs in two phases:
Phase 1 - Extraction:
- Classifies episode types (observation, decision, question, etc.)
- Extracts entity mentions (files, people, tools, concepts)
Phase 2 - Generalization:
- Identifies patterns across episodes
- Creates new generalized concepts
- Updates existing concepts
- Establishes relations
- Flags contradictions
Spreading Activation
Retrieval that goes beyond keyword matching:
- Query is embedded and matched to concepts
- Matched concepts activate related concepts through the graph
- Activation spreads with decay over multiple hops
- Highest-activation concepts are returned
Database
Remind uses SQLite for storage. All databases are stored in ~/.remind/. By default, the database is ~/.remind/memory.db.
# Uses ~/.remind/memory.db
memory = create_memory()
# Uses ~/.remind/my-project.db
memory = create_memory(db_path="my-project")
Installation
For a global remind command (optional - uv run remind works without installing):
# Using pipx (recommended)
pipx install .
# Or for development
pip install -e .
License
Apache 2.0 (LICENSE)
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file remind_mcp-0.1.0.tar.gz.
File metadata
- Download URL: remind_mcp-0.1.0.tar.gz
- Upload date:
- Size: 6.7 MB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.12.11
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
a0a1c472e4e5ccce8dec3c9887cc0851ac55450bfdbc89bc48ffb0134610ea15
|
|
| MD5 |
c426d5b6c30d323dab396977bb51523c
|
|
| BLAKE2b-256 |
b9e832bef0b77ed6311b1b3e34b77ffd18c9d749285dc3f598dd9bcaa1cde3ad
|
File details
Details for the file remind_mcp-0.1.0-py3-none-any.whl.
File metadata
- Download URL: remind_mcp-0.1.0-py3-none-any.whl
- Upload date:
- Size: 58.2 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.12.11
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
98902f4c328e5a4d47d0a13d3297dfa7faa7b8ed42a7fcd396bac0247fefec00
|
|
| MD5 |
6b566c2538945de0175fa20fd47b344a
|
|
| BLAKE2b-256 |
c53e7678606ee56933340e547cd62d5e3965a7f0b468649d98c77e11b78f5650
|