Content
# MCP Memory Keeper - Claude Code Context Management
[](https://www.npmjs.com/package/mcp-memory-keeper)
[](https://www.npmjs.com/package/mcp-memory-keeper)
[](https://github.com/mkreyman/mcp-memory-keeper/actions/workflows/ci.yml)
[](https://codecov.io/gh/mkreyman/mcp-memory-keeper)
[](https://opensource.org/licenses/MIT)
A Model Context Protocol (MCP) server that provides persistent context management for Claude AI coding assistants. Never lose context during compaction again! This MCP server helps Claude Code maintain context across sessions, preserving your work history, decisions, and progress.
## 🚀 Quick Start
Get started in under 30 seconds:
```bash
# Add memory-keeper to Claude
claude mcp add memory-keeper npx mcp-memory-keeper
# Start a new Claude session and use it!
# Try: Analyze the current repo and save your analysis in memory-keeper
```
That's it! Memory Keeper is now available in all your Claude sessions. Your context is stored in `~/mcp-data/memory-keeper/` and persists across sessions.
## 🚀 Practical Memory Keeper Workflow Example
### **Custom Command + CLAUDE.md = Automatic Context Management**
#### **CLAUDE.md** (condensed example)
```markdown
# Project Configuration
## Development Rules
- Always use memory-keeper to track progress
- Save architectural decisions and test results
- Create checkpoints before context limits
## Quality Standards
- All tests must pass before marking complete
- Document actual vs claimed results
```
#### **Custom Command Example: `/my-dev-workflow`**
```markdown
# My Development Workflow
When working on the provided project:
- Use memory-keeper with channel: <project_name>
- Save progress at every major milestone
- Document all decisions with category: "decision"
- Track implementation status with category: "progress"
- Before claiming anything is complete, save test results
## Workflow Steps
1. Initialize session with project name as channel
2. Save findings during investigation
3. Create checkpoint before major changes
4. Document what actually works vs what should work
```
#### **Usage Example**
```
User: /my-dev-workflow authentication-service
AI: Setting up workflow for authentication-service.
[Uses memory-keeper with channel "authentication-service"]
[... AI works, automatically saving context ...]
User: "Getting close to context limit. Create checkpoint and give me a key"
AI: "Checkpoint created: authentication-service-checkpoint-20250126-143026"
[Continue working until context reset or compact manually]
User: "Restore from key: authentication-service-checkpoint-20250126-143026"
AI: "Restored! Continuing OAuth implementation. We completed the token validation, working on refresh logic..."
```
**The Pattern:**
1. Custom command includes instructions to use memory-keeper
2. AI follows those instructions automatically
3. **When you notice the conversation getting long, YOU ask Claude to save a checkpoint** (like saving your game before a boss fight!)
4. **When Claude runs out of space and starts fresh, YOU tell it to restore using the checkpoint key**
**🎯 Key Feature:** Memory Keeper is a shared board! You can:
- Continue in the same session after reset
- Start a completely new session and restore
- Have multiple Claude sessions running in parallel, all sharing the same memory
- One session can save context that another session retrieves
This enables powerful workflows like having one Claude session doing research while another implements code, both sharing discoveries through Memory Keeper!
## Why MCP Memory Keeper?
Claude Code users often face context loss when the conversation window fills up. This MCP server solves that problem by providing a persistent memory layer for Claude AI. Whether you're working on complex refactoring, multi-file changes, or long debugging sessions, Memory Keeper ensures your Claude assistant remembers important context, decisions, and progress.
### Perfect for:
- Long coding sessions with Claude Code
- Complex projects requiring context preservation
- Teams using Claude AI for collaborative development
- Developers who want persistent context across Claude sessions
## Features
- 🔄 Save and restore context between Claude Code sessions
- 📁 File content caching with change detection
- 🏷️ Organize context with categories and priorities
- 📺 **Channels** - Persistent topic-based organization (auto-derived from git branch)
- 📸 Checkpoint system for complete context snapshots
- 🤖 Smart compaction helper that never loses critical info
- 🔍 Full-text search across all saved context
- 🕐 **Enhanced filtering** - Time-based queries, regex patterns, pagination
- 📊 **Change tracking** - See what's been added, modified, or deleted since any point
- 💾 Export/import for backup and sharing
- 🌿 Git integration with automatic context correlation
- 📊 AI-friendly summarization with priority awareness
- 🚀 Fast SQLite-based storage optimized for Claude
- 🔁 **Batch operations** - Save, update, or delete multiple items atomically
- 🔄 **Channel reassignment** - Move items between channels based on patterns
- 🔗 **Context relationships** - Link related items with typed relationships
- 👁️ **Real-time monitoring** - Watch for context changes with filters
## Installation
### Recommended: NPX Installation
```bash
claude mcp add memory-keeper npx mcp-memory-keeper
```
This single command:
- ✅ Always uses the latest version
- ✅ Handles all dependencies automatically
- ✅ Works across macOS, Linux, and Windows
- ✅ No manual building or native module issues
### Alternative Installation Methods
<details>
<summary>Global Installation</summary>
```bash
npm install -g mcp-memory-keeper
claude mcp add memory-keeper mcp-memory-keeper
```
</details>
<details>
<summary>From Source (for development)</summary>
```bash
# 1. Clone the repository
git clone https://github.com/mkreyman/mcp-memory-keeper.git
cd mcp-memory-keeper
# 2. Install dependencies
npm install
# 3. Build the project
npm run build
# 4. Add to Claude
claude mcp add memory-keeper /absolute/path/to/mcp-memory-keeper/bin/mcp-memory-keeper
```
</details>
## Configuration
### Environment Variables
#### Storage and Installation
- `DATA_DIR` - Directory for database storage (default: `~/mcp-data/memory-keeper/`)
- `MEMORY_KEEPER_INSTALL_DIR` - Installation directory (default: `~/.local/mcp-servers/memory-keeper/`)
- `MEMORY_KEEPER_AUTO_UPDATE` - Set to `1` to enable auto-updates
#### Token Limit Configuration
- `MCP_MAX_TOKENS` - Maximum tokens allowed in responses (default: `25000`, range: `1000-100000`)
- Adjust this if your MCP client has different limits
- `MCP_TOKEN_SAFETY_BUFFER` - Safety buffer percentage (default: `0.8`, range: `0.1-1.0`)
- Uses only this fraction of the max tokens to prevent overflows
- `MCP_MIN_ITEMS` - Minimum items to return even if exceeding limits (default: `1`, range: `1-100`)
- Ensures at least some results are returned
- `MCP_MAX_ITEMS` - Maximum items allowed per response (default: `100`, range: `10-1000`)
- Upper bound for result sets regardless of token limits
- `MCP_CHARS_PER_TOKEN` - Characters per token ratio (default: `3.5`, range: `2.5-5.0`) **[Advanced]**
- Adjusts token estimation accuracy for different content types
- Lower values = more conservative (safer but returns fewer items)
- Higher values = more aggressive (returns more items but risks overflow)
Example configuration for stricter token limits:
```bash
export MCP_MAX_TOKENS=20000 # Lower max tokens
export MCP_TOKEN_SAFETY_BUFFER=0.7 # More conservative buffer
export MCP_MAX_ITEMS=50 # Fewer items per response
export MCP_CHARS_PER_TOKEN=3.0 # More conservative estimation (optional)
```
#### Tool Profiles
By default, all 38 tools are exposed. To reduce context overhead in your AI assistant, you can activate a tool profile that limits which tools are available.
**Quick usage:**
```bash
# Essential tools only (8 tools)
TOOL_PROFILE=minimal npx mcp-memory-keeper
# Standard workflow set (22 tools)
TOOL_PROFILE=standard npx mcp-memory-keeper
# All tools (default)
TOOL_PROFILE=full npx mcp-memory-keeper
```
**Built-in profiles:**
| Profile | Tools | Description |
| ---------- | ----- | -------------------------------------------------------------- |
| `minimal` | 8 | Core persistence: save, get, search, status, checkpoint |
| `standard` | 22 | Daily workflow: core + git, batch ops, channels, export/import |
| `full` | 38 | All tools (default, backwards compatible) |
**Custom profiles via config file:**
Create `~/.mcp-memory-keeper/config.json` to define or override profiles:
```json
{
"profiles": {
"my_workflow": [
"context_session_start",
"context_save",
"context_get",
"context_search",
"context_checkpoint",
"context_restore_checkpoint",
"context_diff",
"context_timeline"
]
}
}
```
Then activate it: `TOOL_PROFILE=my_workflow npx mcp-memory-keeper`
Config file profiles take precedence over built-in defaults with the same name.
**Profile resolution precedence:**
| `TOOL_PROFILE` | Config file has profile? | Built-in exists? | Result |
| -------------- | ------------------------ | ---------------- | -------------------------------- |
| Set | Yes | — | Uses config file definition |
| Set | No | Yes | Uses built-in definition |
| Set | No | No | Warning + falls back to `full` |
| Not set | — | — | Uses built-in `full` (all tools) |
**Environment variables:**
| Variable | Description |
| --------------------- | ------------------------------------------------------------------------- |
| `TOOL_PROFILE` | Profile name to activate (e.g., `minimal`, `standard`, `full`, or custom) |
| `TOOL_PROFILE_CONFIG` | Override config file path (default: `~/.mcp-memory-keeper/config.json`) |
> Note: Profile resolution happens once at server startup. Changes to the env var or config file take effect on the next server restart.
**Claude Code / Claude Desktop configuration:**
```json
{
"mcpServers": {
"memory-keeper": {
"command": "npx",
"args": ["mcp-memory-keeper"],
"env": {
"TOOL_PROFILE": "minimal"
}
}
}
}
```
See `examples/config.json` for a complete example config file.
### Claude Code (CLI)
#### Configuration Scopes
Choose where to save the configuration:
```bash
# Project-specific (default) - only for you in this project
claude mcp add memory-keeper npx mcp-memory-keeper
# Shared with team via .mcp.json
claude mcp add --scope project memory-keeper npx mcp-memory-keeper
# Available across all your projects
claude mcp add --scope user memory-keeper npx mcp-memory-keeper
```
#### Verify Configuration
```bash
# List all configured servers
claude mcp list
# Get details for Memory Keeper
claude mcp get memory-keeper
```
### Claude Desktop App
1. Open Claude Desktop settings
2. Navigate to "Developer" → "Model Context Protocol"
3. Click "Add MCP Server"
4. Add the following configuration:
```json
{
"mcpServers": {
"memory-keeper": {
"command": "npx",
"args": ["mcp-memory-keeper"]
}
}
}
```
That's it! No paths needed - npx automatically handles everything.
### Verify Installation
#### For Claude Code:
1. Restart Claude Code or start a new session
2. The Memory Keeper tools should be available automatically
3. Test with: `mcp_memory_save({ key: "test", value: "Hello Memory Keeper!" })`
4. If not working, check server status:
```bash
claude mcp list # Should show memory-keeper as "running"
```
#### For Claude Desktop:
1. Restart Claude Desktop after adding the configuration
2. In a new conversation, the Memory Keeper tools should be available
3. Test with the same command above
### Troubleshooting
If Memory Keeper isn't working:
```bash
# Remove and re-add the server
claude mcp remove memory-keeper
claude mcp add memory-keeper npx mcp-memory-keeper
# Check logs for errors
# The server output will appear in Claude Code's output panel
```
### Updating to Latest Version
With the npx installation method, you automatically get the latest version every time! No manual updates needed.
If you're using the global installation method:
```bash
# Update to latest version
npm update -g mcp-memory-keeper
# Start a new Claude session
# The updated features will be available immediately
```
**Note**: You don't need to reconfigure the MCP server in Claude after updating. Just start a new session!
## Usage
### Session Management
```javascript
// Start a new session
mcp_context_session_start({
name: 'Feature Development',
description: 'Working on user authentication',
});
// Start a session with project directory for git tracking
mcp_context_session_start({
name: 'Feature Development',
description: 'Working on user authentication',
projectDir: '/path/to/your/project',
});
// Start a session with a default channel
mcp_context_session_start({
name: 'Feature Development',
description: 'Working on user authentication',
projectDir: '/path/to/your/project',
defaultChannel: 'auth-feature', // Will auto-derive from git branch if not specified
});
// Set project directory for current session
mcp_context_set_project_dir({
projectDir: '/path/to/your/project',
});
// List recent sessions
mcp_context_session_list({ limit: 5 });
// Continue from a previous session
mcp_context_session_start({
name: 'Feature Dev Continued',
continueFrom: 'previous-session-id',
});
```
### Working with Channels (NEW in v0.10.0)
Channels provide persistent topic-based organization that survives session crashes and restarts:
```javascript
// Channels are auto-derived from git branch (if projectDir is set)
// Branch "feature/auth-system" becomes channel "feature-auth-system" (20 chars max)
// Save to a specific channel
mcp_context_save({
key: 'auth_design',
value: 'Using JWT with refresh tokens',
category: 'decision',
priority: 'high',
channel: 'auth-feature', // Explicitly set channel
});
// Get items from a specific channel
mcp_context_get({ channel: 'auth-feature' });
// Get items across all channels (default behavior)
mcp_context_get({ category: 'task' });
// Channels persist across sessions - perfect for:
// - Multi-branch development
// - Feature-specific context
// - Team collaboration on different topics
```
### Enhanced Context Storage
```javascript
// Save with categories and priorities
mcp_context_save({
key: 'current_task',
value: 'Implement OAuth integration',
category: 'task',
priority: 'high',
});
// Save decisions
mcp_context_save({
key: 'auth_strategy',
value: 'Using JWT tokens with 24h expiry',
category: 'decision',
priority: 'high',
});
// Save progress notes
mcp_context_save({
key: 'progress_auth',
value: 'Completed user model, working on token generation',
category: 'progress',
priority: 'normal',
});
// Retrieve by category
mcp_context_get({ category: 'task' });
// Retrieve specific item
mcp_context_get({ key: 'current_task' });
// Get context from specific session
mcp_context_get({
sessionId: 'session-id-here',
category: 'decision',
});
// Enhanced filtering (NEW in v0.10.0)
mcp_context_get({
category: 'task',
priorities: ['high', 'normal'],
includeMetadata: true, // Get timestamps, size info
sort: 'created_desc', // created_asc/desc, updated_asc/desc, priority
limit: 10, // Pagination
offset: 0,
});
// Time-based queries (NEW in v0.10.0)
mcp_context_get({
createdAfter: '2025-01-20T00:00:00Z',
createdBefore: '2025-01-26T23:59:59Z',
includeMetadata: true,
});
// Pattern matching (NEW in v0.10.0)
mcp_context_get({
keyPattern: 'auth_.*', // Regex to match keys
category: 'decision',
});
```
### File Caching
```javascript
// Cache file content for change detection
mcp_context_cache_file({
filePath: '/src/auth/user.model.ts',
content: fileContent,
});
// Check if file has changed
mcp_context_file_changed({
filePath: '/src/auth/user.model.ts',
currentContent: newFileContent,
});
// Get current session status
mcp_context_status();
```
### Complete Workflow Example
```javascript
// 1. Start a new session
mcp_context_session_start({
name: 'Settings Refactor',
description: 'Refactoring settings module for better performance',
});
// 2. Save high-priority task
mcp_context_save({
key: 'main_task',
value: 'Refactor Settings.Context to use behaviors',
category: 'task',
priority: 'high',
});
// 3. Cache important files
mcp_context_cache_file({
filePath: 'lib/settings/context.ex',
content: originalFileContent,
});
// 4. Save decisions as you work
mcp_context_save({
key: 'architecture_decision',
value: 'Split settings into read/write modules',
category: 'decision',
priority: 'high',
});
// 5. Track progress
mcp_context_save({
key: 'progress_1',
value: 'Completed behavior definition, 5 modules remaining',
category: 'progress',
priority: 'normal',
});
// 6. Before context window fills up
mcp_context_status(); // Check what's saved
// 7. After Claude Code restart
mcp_context_get({ category: 'task', priority: 'high' }); // Get high priority tasks
mcp_context_get({ key: 'architecture_decision' }); // Get specific decisions
mcp_context_file_changed({ filePath: 'lib/settings/context.ex' }); // Check for changes
```
### Checkpoints (Phase 2)
Create named snapshots of your entire context that can be restored later:
```javascript
// Create a checkpoint before major changes
mcp_context_checkpoint({
name: 'before-refactor',
description: 'State before major settings refactor',
includeFiles: true, // Include cached files
includeGitStatus: true, // Capture git status
});
// Continue working...
// If something goes wrong, restore from checkpoint
mcp_context_restore_checkpoint({
name: 'before-refactor',
restoreFiles: true, // Restore cached files too
});
// Or restore the latest checkpoint
mcp_context_restore_checkpoint({});
```
### Context Summarization (Phase 2)
Get AI-friendly summaries of your saved context:
```javascript
// Get a summary of all context
mcp_context_summarize();
// Get summary of specific categories
mcp_context_summarize({
categories: ['task', 'decision'],
maxLength: 2000,
});
// Summarize a specific session
mcp_context_summarize({
sessionId: 'session-id-here',
categories: ['progress'],
});
```
Example summary output:
```markdown
# Context Summary
## High Priority Items
- **main_task**: Refactor Settings.Context to use behaviors
- **critical_bug**: Fix memory leak in subscription handler
## Task
- implement_auth: Add OAuth2 authentication flow
- update_tests: Update test suite for new API
## Decision
- architecture_decision: Split settings into read/write modules
- db_choice: Use PostgreSQL for better JSON support
```
### Batch Operations
Perform multiple operations atomically:
```javascript
// Save multiple items at once
mcp_context_batch_save({
items: [
{ key: 'config_api_url', value: 'https://api.example.com', category: 'note' },
{ key: 'config_timeout', value: '30000', category: 'note' },
{ key: 'config_retries', value: '3', category: 'note' },
],
});
// Update multiple items
mcp_context_batch_update({
updates: [
{ key: 'task_1', priority: 'high' },
{ key: 'task_2', priority: 'high' },
{ key: 'task_3', value: 'Updated task description' },
],
});
// Delete by pattern
mcp_context_batch_delete({
keyPattern: 'temp_*',
dryRun: true, // Preview first
});
```
### Channel Management
Reorganize context items between channels:
```javascript
// Move items to a new channel
mcp_context_reassign_channel({
keyPattern: 'auth_*',
toChannel: 'feature-authentication',
});
// Move from one channel to another
mcp_context_reassign_channel({
fromChannel: 'sprint-14',
toChannel: 'sprint-15',
category: 'task',
priorities: ['high'],
});
```
### Context Relationships
Build a graph of related items:
```javascript
// Link related items
mcp_context_link({
sourceKey: 'epic_user_management',
targetKey: 'task_create_user_api',
relationship: 'contains',
});
// Find related items
mcp_context_get_related({
key: 'epic_user_management',
relationship: 'contains',
depth: 2,
});
```
### Real-time Monitoring
Watch for context changes:
```javascript
// Create a watcher
const watcher = await mcp_context_watch({
action: 'create',
filters: {
categories: ['task'],
priorities: ['high'],
},
});
// Poll for changes
const changes = await mcp_context_watch({
action: 'poll',
watcherId: watcher.watcherId,
});
```
### Smart Compaction (Phase 3)
Never lose critical context when Claude's window fills up:
```javascript
// Before context window fills
mcp_context_prepare_compaction();
// This automatically:
// - Creates a checkpoint
// - Identifies high-priority items
// - Captures unfinished tasks
// - Saves all decisions
// - Generates a summary
// - Prepares restoration instructions
```
### Git Integration (Phase 3)
Track git changes in your project directory and save context with commits:
```javascript
// First, set your project directory (if not done during session start)
mcp_context_set_project_dir({
projectDir: '/path/to/your/project',
});
// Commit with auto-save
mcp_context_git_commit({
message: 'feat: Add user authentication',
autoSave: true, // Creates checkpoint with commit
});
// Context is automatically linked to the commit
// Note: If no project directory is set, you'll see a helpful message
// explaining how to enable git tracking for your project
```
### Context Search (Phase 3)
Find anything in your saved context:
```javascript
// Search in keys and values
mcp_context_search({ query: 'authentication' });
// Search only in keys
mcp_context_search({
query: 'config',
searchIn: ['key'],
});
// Search in specific session
mcp_context_search({
query: 'bug',
sessionId: 'session-id',
});
```
### Export/Import (Phase 3)
Share context or backup your work:
```javascript
// Export current session
mcp_context_export(); // Creates memory-keeper-export-xxx.json
// Export specific session
mcp_context_export({
sessionId: 'session-id',
format: 'json',
});
// Import from file
mcp_context_import({
filePath: 'memory-keeper-export-xxx.json',
});
// Merge into current session
mcp_context_import({
filePath: 'backup.json',
merge: true,
});
```
### Knowledge Graph (Phase 4)
Automatically extract entities and relationships from your context:
```javascript
// Analyze context to build knowledge graph
mcp_context_analyze();
// Or analyze specific categories
mcp_context_analyze({
categories: ['task', 'decision'],
});
// Find related entities
mcp_context_find_related({
key: 'AuthService',
maxDepth: 2,
});
// Generate visualization data
mcp_context_visualize({
type: 'graph',
});
// Timeline view
mcp_context_visualize({
type: 'timeline',
});
// Category/priority heatmap
mcp_context_visualize({
type: 'heatmap',
});
```
### Semantic Search (Phase 4.2)
Find context using natural language queries:
```javascript
// Search with natural language
mcp_context_semantic_search({
query: 'how are we handling user authentication?',
topK: 5,
});
// Find the most relevant security decisions
mcp_context_semantic_search({
query: 'security concerns and decisions',
minSimilarity: 0.5,
});
// Search with specific similarity threshold
mcp_context_semantic_search({
query: 'database performance optimization',
topK: 10,
minSimilarity: 0.3,
});
```
### Multi-Agent System (Phase 4.3)
Delegate complex analysis tasks to specialized agents:
```javascript
// Analyze patterns in your context
mcp_context_delegate({
taskType: 'analyze',
input: {
analysisType: 'patterns',
categories: ['task', 'decision'],
},
});
// Get comprehensive analysis
mcp_context_delegate({
taskType: 'analyze',
input: {
analysisType: 'comprehensive',
},
});
// Analyze relationships between entities
mcp_context_delegate({
taskType: 'analyze',
input: {
analysisType: 'relationships',
maxDepth: 3,
},
});
// Create intelligent summaries
mcp_context_delegate({
taskType: 'synthesize',
input: {
synthesisType: 'summary',
maxLength: 1000,
},
});
// Get actionable recommendations
mcp_context_delegate({
taskType: 'synthesize',
input: {
synthesisType: 'recommendations',
analysisResults: {}, // Can pass previous analysis results
},
});
// Chain multiple agent tasks
mcp_context_delegate({
chain: true,
taskType: ['analyze', 'synthesize'],
input: [{ analysisType: 'comprehensive' }, { synthesisType: 'recommendations' }],
});
```
Agent Types:
- **Analyzer Agent**: Detects patterns, analyzes relationships, tracks trends
- **Synthesizer Agent**: Creates summaries, merges insights, generates recommendations
### Session Branching & Merging (Phase 4.4)
Explore alternatives without losing your original work:
```javascript
// Create a branch to try something new
mcp_context_branch_session({
branchName: 'experimental-refactor',
copyDepth: 'shallow', // Only copy high-priority items
});
// Or create a full copy
mcp_context_branch_session({
branchName: 'feature-complete-copy',
copyDepth: 'deep', // Copy everything
});
// Later, merge changes back
mcp_context_merge_sessions({
sourceSessionId: 'branch-session-id',
conflictResolution: 'keep_newest', // or "keep_current", "keep_source"
});
```
### Journal Entries (Phase 4.4)
Track your thoughts and progress with timestamped journal entries:
```javascript
// Add a journal entry
mcp_context_journal_entry({
entry: 'Completed the authentication module. Tests are passing!',
tags: ['milestone', 'authentication'],
mood: 'accomplished',
});
// Entries are included in timeline views
mcp_context_timeline({
groupBy: 'day',
});
```
### Timeline & Activity Tracking (Phase 4.4)
Visualize your work patterns over time:
```javascript
// Get activity timeline
mcp_context_timeline({
startDate: '2024-01-01',
endDate: '2024-01-31',
groupBy: 'day', // or "hour", "week"
});
// Enhanced timeline (NEW in v0.10.0)
mcp_context_timeline({
groupBy: 'hour',
includeItems: true, // Show actual items, not just counts
categories: ['task', 'progress'], // Filter by categories
relativeTime: true, // Show "2 hours ago" format
itemsPerPeriod: 10, // Limit items shown per time period
});
// Shows:
// - Context items created per day/hour
// - Category distribution over time
// - Journal entries with moods and tags
// - Actual item details when includeItems: true
```
### Progressive Compression (Phase 4.4)
Save space by intelligently compressing old context:
```javascript
// Compress items older than 30 days
mcp_context_compress({
olderThan: '2024-01-01',
preserveCategories: ['decision', 'critical'], // Keep these
targetSize: 1000, // Target size in KB (optional)
});
// Compression summary shows:
// - Items compressed
// - Space saved
// - Compression ratio
// - Categories affected
```
### Cross-Tool Integration (Phase 4.4)
Track events from other MCP tools:
```javascript
// Record events from other tools
mcp_context_integrate_tool({
toolName: 'code-analyzer',
eventType: 'security-scan-complete',
data: {
vulnerabilities: 0,
filesScanned: 150,
important: true, // Creates high-priority context item
},
});
```
## Documentation
- **[Quick Start Examples](./EXAMPLES.md)** - Real-world scenarios and workflows
- **[API Reference](./API.md)** - Complete tool documentation with all parameters and examples
- **[Recipe Book](./RECIPES.md)** - Common patterns and best practices for daily development
- **[Troubleshooting Guide](./TROUBLESHOOTING.md)** - Common issues and solutions
- **[Architecture Overview](./ARCHITECTURE.md)** - System design and technical details
- **[Contributing Guide](./CONTRIBUTING.md)** - How to contribute to the project
- **[Changelog](./CHANGELOG.md)** - Version history and release notes
## Development
### Running in Development Mode
```bash
# Install dependencies
npm install
# Run tests
npm test
# Run tests with coverage
npm run test:coverage
# Run with auto-reload
npm run dev
# Build for production
npm run build
# Start production server
npm start
```
### Project Structure
```
mcp-memory-keeper/
├── src/
│ ├── index.ts # Main MCP server implementation
│ ├── utils/ # Utility modules
│ │ ├── database.ts # Database management
│ │ ├── validation.ts # Input validation
│ │ ├── git.ts # Git operations
│ │ ├── knowledge-graph.ts # Knowledge graph management
│ │ ├── vector-store.ts # Vector embeddings
│ │ └── agents.ts # Multi-agent system
│ └── __tests__/ # Test files
├── dist/ # Compiled JavaScript (generated)
├── context.db # SQLite database (auto-created)
├── EXAMPLES.md # Quick start examples
├── TROUBLESHOOTING.md # Common issues and solutions
├── package.json # Project configuration
├── tsconfig.json # TypeScript configuration
├── jest.config.js # Test configuration
└── README.md # This file
```
### Testing
The project includes comprehensive test coverage:
```bash
# Run all tests
npm test
# Run tests in watch mode
npm run test:watch
# Generate coverage report
npm run test:coverage
# Run specific test file
npm test -- summarization.test.ts
```
Test categories:
- **Unit Tests**: Input validation, database operations, git integration
- **Integration Tests**: Full tool workflows, error scenarios, edge cases
- **Coverage**: 97%+ coverage on critical modules
## Feature Status
| Feature | Maturity | Version | Use Case |
| ---------------- | --------- | ------- | -------------------------- |
| Basic Save/Get | ✅ Stable | v0.1+ | Daily context management |
| Sessions | ✅ Stable | v0.2+ | Multi-project work |
| File Caching | ✅ Stable | v0.2+ | Track file changes |
| Checkpoints | ✅ Stable | v0.3+ | Context preservation |
| Smart Compaction | ✅ Stable | v0.3+ | Pre-compaction prep |
| Git Integration | ✅ Stable | v0.3+ | Commit context tracking |
| Search | ✅ Stable | v0.3+ | Find saved items |
| Export/Import | ✅ Stable | v0.3+ | Backup & sharing |
| Knowledge Graph | ✅ Stable | v0.5+ | Code relationship analysis |
| Visualization | ✅ Stable | v0.5+ | Context exploration |
| Semantic Search | ✅ Stable | v0.6+ | Natural language queries |
| Multi-Agent | ✅ Stable | v0.7+ | Intelligent processing |
### Current Features (v0.10.0)
- ✅ **Session Management**: Create, list, and continue sessions with branching support
- ✅ **Channels**: Persistent topic-based organization (auto-derived from git branch)
- ✅ **Context Storage**: Save/retrieve context with categories (task, decision, progress, note) and priorities
- ✅ **Enhanced Filtering**: Time-based queries, regex patterns, sorting, pagination
- ✅ **File Caching**: Track file changes with SHA-256 hashing
- ✅ **Checkpoints**: Create and restore complete context snapshots
- ✅ **Smart Compaction**: Never lose critical context when hitting limits
- ✅ **Git Integration**: Auto-save context on commits with branch tracking
- ✅ **Search**: Full-text search across all saved context
- ✅ **Export/Import**: Backup and share context as JSON
- ✅ **SQLite Storage**: Persistent, reliable data storage with WAL mode
- ✅ **Knowledge Graph**: Automatic entity and relationship extraction from context
- ✅ **Visualization**: Generate graph, timeline, and heatmap data for context exploration
- ✅ **Semantic Search**: Natural language search using lightweight vector embeddings
- ✅ **Multi-Agent System**: Intelligent analysis with specialized analyzer and synthesizer agents
- ✅ **Session Branching**: Create branches to explore alternatives without losing original context
- ✅ **Session Merging**: Merge branches back with conflict resolution options
- ✅ **Journal Entries**: Time-stamped entries with tags and mood tracking
- ✅ **Enhanced Timeline**: Activity patterns with item details and relative time
- ✅ **Progressive Compression**: Intelligently compress old context to save space
- ✅ **Cross-Tool Integration**: Track events from other MCP tools
### Roadmap
#### Phase 4: Advanced Features (In Development)
- 🚧 **Knowledge Graph**: Entity-relation tracking for code understanding
- 🚧 **Vector Search**: Semantic search using natural language
- 📋 **Multi-Agent Processing**: Intelligent analysis and synthesis
- 📋 **Time-Aware Context**: Timeline views and journal entries
#### Phase 5: Documentation & Polish
- ✅ **Examples**: Comprehensive quick-start scenarios
- ✅ **Troubleshooting**: Common issues and solutions
- 🚧 **Recipes**: Common patterns and workflows
- 📋 **Video Tutorials**: Visual guides for key features
#### Future Enhancements
- [ ] Web UI for browsing context history
- [ ] Multi-user/team collaboration features
- [ ] Cloud sync and sharing
- [ ] Integration with other AI assistants
- [ ] Advanced analytics and insights
- [ ] Custom context templates
- [ ] Automatic retention policies
## Upgrading
### Database path change (v0.12.x+)
Prior to this release, the server resolved `context.db` relative to the process's current working directory. The database now lives at an absolute path:
- **Default:** `~/mcp-data/memory-keeper/context.db`
- **Custom:** set `DATA_DIR=/your/path` — the server will use `$DATA_DIR/context.db`
If you have existing data in a `context.db` in your old working directory, move it to the new location before restarting the server:
```bash
mkdir -p ~/mcp-data/memory-keeper
cp /path/to/old/context.db ~/mcp-data/memory-keeper/context.db
```
If `DATA_DIR` is set, use that path as the destination instead of `~/mcp-data/memory-keeper/`.
The server will print a warning to stderr if it detects a `context.db` in the current directory that differs from the configured data directory, including the exact `cp` command to run.
### From-source install command change
If you registered memory-keeper using `node dist/index.js` directly, update your MCP config to use the bin wrapper instead:
```bash
# remove the old entry
claude mcp remove memory-keeper
# add the updated entry
claude mcp add memory-keeper /absolute/path/to/mcp-memory-keeper/bin/mcp-memory-keeper
```
## Contributing
Contributions are welcome! Please feel free to submit a Pull Request.
1. Fork the repository
2. Create your feature branch (`git checkout -b feature/AmazingFeature`)
3. Commit your changes (`git commit -m 'Add some AmazingFeature'`)
4. Push to the branch (`git push origin feature/AmazingFeature`)
5. Open a Pull Request
## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
## Author
Mark Kreyman
## Acknowledgments
- Built for the Claude Code community
- Inspired by the need for better context management in AI coding sessions
- Thanks to Anthropic for the MCP protocol
## Support
If you encounter any issues or have questions:
- Open an issue on [GitHub](https://github.com/mkreyman/mcp-memory-keeper/issues)
- Check the [MCP documentation](https://modelcontextprotocol.io/)
- Join the Claude Code community discussions
## Keywords
Claude Code context management, MCP server, Claude AI memory, persistent context, Model Context Protocol, Claude assistant memory, AI coding context, Claude Code MCP, context preservation, Claude AI tools
