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
Enhance README.md with quick start guide for clients (#394)
Enhance README.md with quick start guide for clients and update environment variable instructions. Update uv.lock to reflect package version changes and add new dependencies. Notable updates include bumping graphiti-core to 0.10.5 and adding graph-service as a dependency.
Copy file name to clipboardExpand all lines: mcp_server/README.md
+61-50
Original file line number
Diff line number
Diff line change
@@ -21,6 +21,30 @@ The Graphiti MCP server exposes the following key high-level functions of Graphi
21
21
-**Group Management**: Organize and manage groups of related data with group_id filtering
22
22
-**Graph Maintenance**: Clear the graph and rebuild indices
23
23
24
+
## Quick Start for Claude Desktop, Cursor, and other clients
25
+
26
+
1. Clone the Graphiti GitHub repo
27
+
28
+
```bash
29
+
git clone https://github.com/getzep/graphiti.git
30
+
```
31
+
32
+
or
33
+
34
+
```bash
35
+
gh repo clone getzep/graphiti
36
+
```
37
+
38
+
Note the full path to this directory.
39
+
40
+
```
41
+
cd graphiti && pwd
42
+
```
43
+
44
+
2. Install the [Graphiti prerequisites](#prerequisites).
45
+
46
+
3. Configure Claude, Cursor, or other MCP client to use [Graphiti with a `stdio` transport](#integrating-with-mcp-clients). See the client documentation on where to find their MCP configuration files.
47
+
24
48
## Installation
25
49
26
50
### Prerequisites
@@ -94,25 +118,25 @@ Before running the Docker Compose setup, you need to configure the environment v
94
118
95
119
1.**Using a .env file** (recommended):
96
120
97
-
- Copy the provided `.env.example` file to create a `.env` file:
98
-
```bash
99
-
cp .env.example .env
100
-
```
101
-
- Edit the `.env` file to set your OpenAI API key and other configuration options:
102
-
```
103
-
# Required for LLM operations
104
-
OPENAI_API_KEY=your_openai_api_key_here
105
-
MODEL_NAME=gpt-4.1-mini
106
-
# Optional: OPENAI_BASE_URL only needed for non-standard OpenAI endpoints
107
-
# OPENAI_BASE_URL=https://api.openai.com/v1
108
-
```
109
-
- The Docker Compose setup is configured to use this file if it exists (it's optional)
121
+
- Copy the provided `.env.example` file to create a `.env` file:
122
+
```bash
123
+
cp .env.example .env
124
+
```
125
+
- Edit the `.env` file to set your OpenAI API key and other configuration options:
126
+
```
127
+
# Required for LLM operations
128
+
OPENAI_API_KEY=your_openai_api_key_here
129
+
MODEL_NAME=gpt-4.1-mini
130
+
# Optional: OPENAI_BASE_URL only needed for non-standard OpenAI endpoints
131
+
# OPENAI_BASE_URL=https://api.openai.com/v1
132
+
```
133
+
- The Docker Compose setup is configured to use this file if it exists (it's optional)
110
134
111
135
2. **Using environment variables directly**:
112
-
- You can also set the environment variables when running the Docker Compose command:
113
-
```bash
114
-
OPENAI_API_KEY=your_key MODEL_NAME=gpt-4.1-mini docker compose up
115
-
```
136
+
- You can also set the environment variables when running the Docker Compose command:
137
+
```bash
138
+
OPENAI_API_KEY=your_key MODEL_NAME=gpt-4.1-mini docker compose up
139
+
```
116
140
117
141
#### Neo4j Configuration
118
142
@@ -151,23 +175,33 @@ This will start both the Neo4j database and the Graphiti MCP server. The Docker
151
175
152
176
To use the Graphiti MCP server with an MCP-compatible client, configure it to connect to the server:
153
177
178
+
> [!IMPORTANT]
179
+
> You will need the Python package manager, `uv` installed. Please refer to the [`uv` install instructions](https://docs.astral.sh/uv/getting-started/installation/).
180
+
>
181
+
> Ensure that you set the full path to the `uv` binary and your Graphiti project folder.
182
+
154
183
```json
155
184
{
156
185
"mcpServers": {
157
186
"graphiti": {
158
187
"transport": "stdio",
159
-
"command": "uv",
188
+
"command": "/Users/<user>/.local/bin/uv",
160
189
"args": [
161
190
"run",
162
-
"/ABSOLUTE/PATH/TO/graphiti_mcp_server.py",
191
+
"--isolated",
192
+
"--directory",
193
+
"/Users/<user>>/dev/zep/graphiti/mcp_server",
194
+
"--project",
195
+
".",
196
+
"graphiti_mcp_server.py",
163
197
"--transport",
164
198
"stdio"
165
199
],
166
200
"env": {
167
201
"NEO4J_URI": "bolt://localhost:7687",
168
202
"NEO4J_USER": "neo4j",
169
-
"NEO4J_PASSWORD": "demodemo",
170
-
"OPENAI_API_KEY": "${OPENAI_API_KEY}",
203
+
"NEO4J_PASSWORD": "password",
204
+
"OPENAI_API_KEY": "sk-XXXXXXXX",
171
205
"MODEL_NAME": "gpt-4.1-mini"
172
206
}
173
207
}
@@ -188,31 +222,6 @@ For SSE transport (HTTP-based), you can use this configuration:
188
222
}
189
223
```
190
224
191
-
Or start the server with uv and connect to it:
192
-
193
-
```json
194
-
{
195
-
"mcpServers": {
196
-
"graphiti": {
197
-
"command": "uv",
198
-
"args": [
199
-
"run",
200
-
"/ABSOLUTE/PATH/TO/graphiti_mcp_server.py",
201
-
"--transport",
202
-
"sse"
203
-
],
204
-
"env": {
205
-
"NEO4J_URI": "bolt://localhost:7687",
206
-
"NEO4J_USER": "neo4j",
207
-
"NEO4J_PASSWORD": "demodemo",
208
-
"OPENAI_API_KEY": "${OPENAI_API_KEY}",
209
-
"MODEL_NAME": "gpt-4.1-mini"
210
-
}
211
-
}
212
-
}
213
-
}
214
-
```
215
-
216
225
## Available Tools
217
226
218
227
The Graphiti MCP server exposes the following tools:
@@ -233,12 +242,14 @@ The Graphiti MCP server can process structured JSON data through the `add_episod
233
242
allows you to automatically extract entities and relationships from structured data:
0 commit comments