Skip to content

Commit dd6f6f7

Browse files
authored
Fix: Add MCP Client Integration Guide and update installation commands (mem0ai#2956)
1 parent b6684b9 commit dd6f6f7

File tree

5 files changed

+70
-4
lines changed

5 files changed

+70
-4
lines changed

docs/docs.json

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -193,7 +193,8 @@
193193
"icon": "square-terminal",
194194
"pages": [
195195
"openmemory/overview",
196-
"openmemory/quickstart"
196+
"openmemory/quickstart",
197+
"openmemory/integrations"
197198
]
198199
},
199200
{

docs/openmemory/integrations.mdx

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
---
2+
title: MCP Client Integration Guide
3+
icon: "plug"
4+
iconType: "solid"
5+
---
6+
7+
## Connecting an MCP Client
8+
9+
Once your OpenMemory server is running locally, you can connect any compatible MCP client to your personal memory stream. This enables a seamless memory layer integration for AI tools and agents.
10+
11+
Ensure the following environment variables are correctly set in your configuration files:
12+
13+
**In `/ui/.env`:**
14+
```env
15+
NEXT_PUBLIC_API_URL=http://localhost:8765
16+
NEXT_PUBLIC_USER_ID=<user-id>
17+
```
18+
19+
**In `/api/.env`:**
20+
```env
21+
OPENAI_API_KEY=sk-xxx
22+
USER=<user-id>
23+
```
24+
25+
These values define where your MCP server is running and which user’s memory is accessed.
26+
27+
### MCP Client Setup
28+
29+
Use the `install-mcp` utility to connect a client. The general command format is as follows:
30+
31+
```bash
32+
npx install-mcp http://localhost:8765/mcp/<client-name>/sse/<user-id> --client <client-name>
33+
```
34+
35+
Replace `<client-name>` with the desired client name and `<user-id>` with the value specified in your environment variables.
36+
37+
### Example Commands for Supported Clients
38+
39+
| Client | Command |
40+
|-------------|---------|
41+
| OpenMemory | `npx install-mcp http://localhost:8765/mcp/openmemory/sse/<user-id> --client openmemory` |
42+
| Claude | `npx install-mcp http://localhost:8765/mcp/claude/sse/<user-id> --client claude` |
43+
| Cursor | `npx install-mcp http://localhost:8765/mcp/cursor/sse/<user-id> --client cursor` |
44+
| Cline | `npx install-mcp http://localhost:8765/mcp/cline/sse/<user-id> --client cline` |
45+
| RooCline | `npx install-mcp http://localhost:8765/mcp/roocline/sse/<user-id> --client roocline` |
46+
| Windsurf | `npx install-mcp http://localhost:8765/mcp/windsurf/sse/<user-id> --client windsurf` |
47+
| Witsy | `npx install-mcp http://localhost:8765/mcp/witsy/sse/<user-id> --client witsy` |
48+
| Enconvo | `npx install-mcp http://localhost:8765/mcp/enconvo/sse/<user-id> --client enconvo` |
49+
50+
### What This Does
51+
52+
Running one of the above commands registers the specified MCP client and connects it to your OpenMemory server. This enables the client to stream and store contextual memory for the provided user ID.
53+
54+
The connection status and memory activity can be monitored via the OpenMemory UI at [http://localhost:3000](http://localhost:3000).

openmemory/.gitignore

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,4 +10,5 @@ node_modules/
1010
*.log
1111
api/.openmemory*
1212
**/.next
13-
.openmemory/
13+
.openmemory/
14+
ui/package-lock.json

openmemory/README.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -96,6 +96,16 @@ pnpm install
9696
pnpm dev
9797
```
9898

99+
### MCP Client Setup
100+
101+
Use the `install-mcp` utility to connect a client. The general command format is as follows:
102+
103+
```bash
104+
npx install-mcp http://localhost:8765/mcp/<client-name>/sse/<user-id> --client <client-name>
105+
```
106+
107+
Replace `<client-name>` with the desired client name and `<user-id>` with the value specified in your environment variables.
108+
99109

100110
## Project Structure
101111

openmemory/ui/components/dashboard/Install.tsx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ export const Install = () => {
5151
const handleCopy = async (tab: string, isMcp: boolean = false) => {
5252
const text = isMcp
5353
? `${URL}/mcp/openmemory/sse/${user}`
54-
: `npx install-mcp i ${URL}/mcp/${tab}/sse/${user} --client ${tab}`;
54+
: `npx install-mcp ${URL}/mcp/${tab}/sse/${user} --client ${tab}`;
5555

5656
try {
5757
// Try using the Clipboard API first
@@ -167,7 +167,7 @@ export const Install = () => {
167167
<div className="relative">
168168
<pre className="bg-zinc-800 px-4 py-3 rounded-md overflow-x-auto text-sm">
169169
<code className="text-gray-300">
170-
{`npx install-mcp i ${URL}/mcp/${key}/sse/${user} --client ${key}`}
170+
{`npx install-mcp ${URL}/mcp/${key}/sse/${user} --client ${key}`}
171171
</code>
172172
</pre>
173173
<div>

0 commit comments

Comments
 (0)