Update README for Graphiti MCP server configuration and integration with Claude Desktop
- Changed server name from "graphiti" to "graphiti-memory" in configuration examples for clarity. - Added instructions for running the Graphiti MCP server using Docker. - Included detailed steps for integrating Claude Desktop with the Graphiti MCP server, including optional installation of `mcp-remote`. - Enhanced overall documentation to improve user experience and understanding of the setup process.
This commit is contained in:
parent
8959478170
commit
e311dab617
1 changed files with 49 additions and 4 deletions
|
|
@ -183,7 +183,7 @@ To use the Graphiti MCP server with an MCP-compatible client, configure it to co
|
||||||
```json
|
```json
|
||||||
{
|
{
|
||||||
"mcpServers": {
|
"mcpServers": {
|
||||||
"graphiti": {
|
"graphiti-memory": {
|
||||||
"transport": "stdio",
|
"transport": "stdio",
|
||||||
"command": "/Users/<user>/.local/bin/uv",
|
"command": "/Users/<user>/.local/bin/uv",
|
||||||
"args": [
|
"args": [
|
||||||
|
|
@ -214,7 +214,7 @@ For SSE transport (HTTP-based), you can use this configuration:
|
||||||
```json
|
```json
|
||||||
{
|
{
|
||||||
"mcpServers": {
|
"mcpServers": {
|
||||||
"graphiti": {
|
"graphiti-memory": {
|
||||||
"transport": "sse",
|
"transport": "sse",
|
||||||
"url": "http://localhost:8000/sse"
|
"url": "http://localhost:8000/sse"
|
||||||
}
|
}
|
||||||
|
|
@ -264,12 +264,18 @@ python graphiti_mcp_server.py --transport sse --use-custom-entities --group-id <
|
||||||
|
|
||||||
Hint: specify a `group_id` to namespace graph data. If you do not specify a `group_id`, the server will use "default" as the group_id.
|
Hint: specify a `group_id` to namespace graph data. If you do not specify a `group_id`, the server will use "default" as the group_id.
|
||||||
|
|
||||||
|
or
|
||||||
|
|
||||||
|
```bash
|
||||||
|
docker compose up
|
||||||
|
```
|
||||||
|
|
||||||
2. Configure Cursor to connect to the Graphiti MCP server.
|
2. Configure Cursor to connect to the Graphiti MCP server.
|
||||||
|
|
||||||
```json
|
```json
|
||||||
{
|
{
|
||||||
"mcpServers": {
|
"mcpServers": {
|
||||||
"Graphiti": {
|
"graphiti-memory": {
|
||||||
"url": "http://localhost:8000/sse"
|
"url": "http://localhost:8000/sse"
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
@ -283,6 +289,45 @@ Hint: specify a `group_id` to namespace graph data. If you do not specify a `gro
|
||||||
The integration enables AI assistants in Cursor to maintain persistent memory through Graphiti's knowledge graph
|
The integration enables AI assistants in Cursor to maintain persistent memory through Graphiti's knowledge graph
|
||||||
capabilities.
|
capabilities.
|
||||||
|
|
||||||
|
## Integrating with Claude Desktop (Docker MCP Server)
|
||||||
|
|
||||||
|
The Graphiti MCP Server container uses the SSE MCP transport. Claude Desktop does not natively support SSE, so you'll need to use a gateway like `mcp-remote`.
|
||||||
|
|
||||||
|
1. **Run the Graphiti MCP server using SSE transport**:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
docker compose up
|
||||||
|
```
|
||||||
|
|
||||||
|
2. **(Optional) Install `mcp-remote` globally**:
|
||||||
|
If you prefer to have `mcp-remote` installed globally, or if you encounter issues with `npx` fetching the package, you can install it globally. Otherwise, `npx` (used in the next step) will handle it for you.
|
||||||
|
|
||||||
|
```bash
|
||||||
|
npm install -g mcp-remote
|
||||||
|
```
|
||||||
|
|
||||||
|
3. **Configure Claude Desktop**:
|
||||||
|
Open your Claude Desktop configuration file (usually `claude_desktop_config.json`) and add or modify the `mcpServers` section as follows:
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"mcpServers": {
|
||||||
|
"graphiti-memory": {
|
||||||
|
// You can choose a different name if you prefer
|
||||||
|
"command": "npx", // Or the full path to mcp-remote if npx is not in your PATH
|
||||||
|
"args": [
|
||||||
|
"mcp-remote",
|
||||||
|
"http://localhost:8000/sse" // Ensure this matches your Graphiti server's SSE endpoint
|
||||||
|
]
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
If you already have an `mcpServers` entry, add `graphiti-memory` (or your chosen name) as a new key within it.
|
||||||
|
|
||||||
|
4. **Restart Claude Desktop** for the changes to take effect.
|
||||||
|
|
||||||
## Requirements
|
## Requirements
|
||||||
|
|
||||||
- Python 3.10 or higher
|
- Python 3.10 or higher
|
||||||
|
|
@ -292,4 +337,4 @@ capabilities.
|
||||||
|
|
||||||
## License
|
## License
|
||||||
|
|
||||||
This project is licensed under the same license as the Graphiti project.
|
This project is licensed under the same license as the parent Graphiti project.
|
||||||
|
|
|
||||||
Loading…
Add table
Reference in a new issue