Skip to content

Commit dda5a7c

Browse files
mkreymanclaude
andcommitted
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]>
1 parent 183eca5 commit dda5a7c

File tree

2 files changed

+232
-144
lines changed

2 files changed

+232
-144
lines changed

README.md

Lines changed: 46 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,27 @@
11
# MCP Memory Keeper - Claude Code Context Management
22

3+
[![npm version](https://img.shields.io/npm/v/mcp-memory-keeper.svg)](https://www.npmjs.com/package/mcp-memory-keeper)
4+
[![npm downloads](https://img.shields.io/npm/dm/mcp-memory-keeper.svg)](https://www.npmjs.com/package/mcp-memory-keeper)
35
[![CI](https://github.com/mkreyman/mcp-memory-keeper/actions/workflows/ci.yml/badge.svg)](https://github.com/mkreyman/mcp-memory-keeper/actions/workflows/ci.yml)
46
[![codecov](https://codecov.io/gh/mkreyman/mcp-memory-keeper/branch/main/graph/badge.svg)](https://codecov.io/gh/mkreyman/mcp-memory-keeper)
5-
[![npm version](https://badge.fury.io/js/mcp-memory-keeper.svg)](https://badge.fury.io/js/mcp-memory-keeper)
7+
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
68

79
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.
810

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+
925
## Why MCP Memory Keeper?
1026

1127
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.
3955

4056
## Installation
4157

42-
### Method 1: NPX (Recommended)
43-
44-
The simplest way to use memory-keeper with Claude:
58+
### Recommended: NPX Installation
4559

4660
```bash
4761
claude mcp add memory-keeper npx mcp-memory-keeper
4862
```
4963

50-
That's it! This will:
64+
This single command:
5165

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
5670

57-
### Method 2: Global Installation
71+
### Alternative Installation Methods
5872

59-
If you prefer a global installation:
73+
<details>
74+
<summary>Global Installation</summary>
6075

6176
```bash
6277
npm install -g mcp-memory-keeper
6378
claude mcp add memory-keeper mcp-memory-keeper
6479
```
6580

66-
### Method 3: From Source
81+
</details>
82+
83+
<details>
84+
<summary>From Source (for development)</summary>
6785

6886
```bash
6987
# 1. Clone the repository
@@ -80,6 +98,8 @@ npm run build
8098
claude mcp add memory-keeper node /absolute/path/to/mcp-memory-keeper/dist/index.js
8199
```
82100

101+
</details>
102+
83103
## Configuration
84104

85105
### Environment Variables
@@ -96,13 +116,13 @@ Choose where to save the configuration:
96116

97117
```bash
98118
# 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
100120

101121
# 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
103123

104124
# 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
106126
```
107127

108128
#### Verify Configuration
@@ -126,20 +146,14 @@ claude mcp get memory-keeper
126146
{
127147
"mcpServers": {
128148
"memory-keeper": {
129-
"command": "node",
130-
"args": ["/absolute/path/to/mcp-memory-keeper/dist/index.js"]
149+
"command": "npx",
150+
"args": ["mcp-memory-keeper"]
131151
}
132152
}
133153
}
134154
```
135155

136-
**Important**: Replace `/absolute/path/to/mcp-memory-keeper` with the actual path where you cloned/installed the project.
137-
138-
### Example paths:
139-
140-
- macOS: `/Users/username/projects/mcp-memory-keeper/dist/index.js`
141-
- Windows: `C:\\Users\\username\\projects\\mcp-memory-keeper\\dist\\index.js`
142-
- Linux: `/home/username/projects/mcp-memory-keeper/dist/index.js`
156+
That's it! No paths needed - npx automatically handles everything.
143157

144158
### Verify Installation
145159

@@ -166,34 +180,27 @@ If Memory Keeper isn't working:
166180
```bash
167181
# Remove and re-add the server
168182
claude mcp remove memory-keeper
169-
claude mcp add memory-keeper node /absolute/path/to/mcp-memory-keeper/dist/index.js
183+
claude mcp add memory-keeper npx mcp-memory-keeper
170184

171185
# Check logs for errors
172186
# The server output will appear in Claude Code's output panel
173187
```
174188

175189
### Updating to Latest Version
176190

177-
To get the latest features and bug fixes:
191+
With the npx installation method, you automatically get the latest version every time! No manual updates needed.
178192

179-
```bash
180-
# 1. Navigate to your Memory Keeper directory
181-
cd /path/to/mcp-memory-keeper
193+
If you're using the global installation method:
182194

183-
# 2. Pull the latest changes
184-
git pull
185-
186-
# 3. Install any new dependencies (if package.json changed)
187-
npm install
188-
189-
# 4. Rebuild the project
190-
npm run build
195+
```bash
196+
# Update to latest version
197+
npm update -g mcp-memory-keeper
191198

192-
# 5. Start a new Claude session
199+
# Start a new Claude session
193200
# The updated features will be available immediately
194201
```
195202

196-
**Note**: You don't need to reconfigure the MCP server in Claude after updating. Just pull, build, and start a new session!
203+
**Note**: You don't need to reconfigure the MCP server in Claude after updating. Just start a new session!
197204

198205
## Usage
199206

0 commit comments

Comments
 (0)