You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
docs: Update installation instructions to emphasize npx method
- Add npm badges and Quick Start section to README
- Update Claude Desktop App config to use npx instead of paths
- Simplify installation section with npx as recommended method
- Update troubleshooting section with npx-specific guidance
- Emphasize automatic updates with npx installation
- Move manual installation methods to collapsible sections
🤖 Generated with [Claude Code](https://claude.ai/code)
Co-Authored-By: Claude <[email protected]>
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.
8
10
11
+
## 🚀 Quick Start
12
+
13
+
Get started in under 30 seconds:
14
+
15
+
```bash
16
+
# Add memory-keeper to Claude
17
+
claude mcp add memory-keeper npx mcp-memory-keeper
18
+
19
+
# Start a new Claude session and use it!
20
+
# Try: Save a context item with mcp_context_save
21
+
```
22
+
23
+
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.
24
+
9
25
## Why MCP Memory Keeper?
10
26
11
27
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.
@@ -39,31 +55,33 @@ Claude Code users often face context loss when the conversation window fills up.
39
55
40
56
## Installation
41
57
42
-
### Method 1: NPX (Recommended)
43
-
44
-
The simplest way to use memory-keeper with Claude:
58
+
### Recommended: NPX Installation
45
59
46
60
```bash
47
61
claude mcp add memory-keeper npx mcp-memory-keeper
48
62
```
49
63
50
-
That's it! This will:
64
+
This single command:
51
65
52
-
- Always use the latest version
53
-
-Handle all dependencies automatically
54
-
-Create the data directory at `~/mcp-data/memory-keeper/`
55
-
-Work across different platforms
66
+
-✅ Always uses the latest version
67
+
-✅ Handles all dependencies automatically
68
+
-✅ Works across macOS, Linux, and Windows
69
+
-✅ No manual building or native module issues
56
70
57
-
### Method 2: Global Installation
71
+
### Alternative Installation Methods
58
72
59
-
If you prefer a global installation:
73
+
<details>
74
+
<summary>Global Installation</summary>
60
75
61
76
```bash
62
77
npm install -g mcp-memory-keeper
63
78
claude mcp add memory-keeper mcp-memory-keeper
64
79
```
65
80
66
-
### Method 3: From Source
81
+
</details>
82
+
83
+
<details>
84
+
<summary>From Source (for development)</summary>
67
85
68
86
```bash
69
87
# 1. Clone the repository
@@ -80,6 +98,8 @@ npm run build
80
98
claude mcp add memory-keeper node /absolute/path/to/mcp-memory-keeper/dist/index.js
81
99
```
82
100
101
+
</details>
102
+
83
103
## Configuration
84
104
85
105
### Environment Variables
@@ -96,13 +116,13 @@ Choose where to save the configuration:
96
116
97
117
```bash
98
118
# Project-specific (default) - only for you in this project
99
-
claude mcp add memory-keeper node /path/to/mcp-memory-keeper/dist/index.js
119
+
claude mcp add memory-keeper npx mcp-memory-keeper
100
120
101
121
# Shared with team via .mcp.json
102
-
claude mcp add --scope project memory-keeper node /path/to/mcp-memory-keeper/dist/index.js
122
+
claude mcp add --scope project memory-keeper npx mcp-memory-keeper
103
123
104
124
# Available across all your projects
105
-
claude mcp add --scope user memory-keeper node /path/to/mcp-memory-keeper/dist/index.js
125
+
claude mcp add --scope user memory-keeper npx mcp-memory-keeper
106
126
```
107
127
108
128
#### Verify Configuration
@@ -126,20 +146,14 @@ claude mcp get memory-keeper
0 commit comments