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
Copy file name to clipboardExpand all lines: docs/examples/mcp.mdx
+75-6Lines changed: 75 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -190,8 +190,58 @@ To configure the Claude Desktop App to connect to your MCP server, follow these
190
190
191
191
5. The configuration file is named `claude_desktop_config.json`. Edit the file to include the MCP stdio mode.
192
192
193
-
Here is an example of working in the development environment with `uv`. In order to call the command,
194
-
you need to have `uv` installed and issue `uv build` to build the project first.
193
+
#### Option 1: Using Docker Compose (Recommended)
194
+
195
+
This is the recommended method for running MemMachine locally using Docker. It's the easiest way to get started.
196
+
197
+
**Step 1: Start MemMachine with Docker Compose**
198
+
199
+
First, start MemMachine using the provided script:
200
+
201
+
```
202
+
./memmachine-compose.sh
203
+
```
204
+
205
+
This will start all required services (PostgreSQL, Neo4j, and MemMachine) in Docker containers. The MemMachine container will be named `memmachine-app`.
206
+
207
+
**Step 2: Configure Claude Desktop**
208
+
209
+
Edit `claude_desktop_config.json` with the following configuration:
210
+
211
+
```
212
+
{
213
+
"mcpServers": {
214
+
"memmachine": {
215
+
"command": "docker",
216
+
"args": [
217
+
"exec",
218
+
"-e",
219
+
"MM_USER_ID=Your Name",
220
+
"-i",
221
+
"memmachine-app",
222
+
"/app/.venv/bin/memmachine-mcp-stdio"
223
+
],
224
+
"env": {
225
+
"MEMORY_CONFIG": "/app/configuration.yml",
226
+
"PYTHONUNBUFFERED": "1"
227
+
}
228
+
}
229
+
}
230
+
}
231
+
```
232
+
233
+
Replace `Your Name` with your desired user ID. The `memmachine-app` is the default container name created by the Docker Compose setup.
234
+
235
+
**Configuration Details:**
236
+
-`memmachine-app`: The Docker container name (default from `memmachine-compose.sh`)
237
+
-`MEMORY_CONFIG`: Path to the configuration file inside the container
238
+
-`MM_USER_ID`: Your user identifier for memory sessions
239
+
-`PYTHONUNBUFFERED`: Ensures immediate output from Python
240
+
241
+
#### Option 2: Using UV (Development Environment)
242
+
243
+
Here is an example of working in the development environment with `uv`. In order to call the command,
244
+
you need to have `uv` installed and issue `uv build` to build the project first.
0 commit comments