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: servers/mcp-neo4j-cypher/README.md
+57-33Lines changed: 57 additions & 33 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,7 +2,18 @@
2
2
3
3
## 🌟 Overview
4
4
5
-
A Model Context Protocol (MCP) server implementation that provides database interaction and allows graph exploration capabilities through Neo4j. This server enables running Cypher graph queries, analyzing complex domain data, and automatically generating business insights that can be enhanced with Claude's analysis.
5
+
A Model Context Protocol (MCP) server implementation that provides database interaction and allows graph exploration capabilities through Neo4j. This server enables running Cypher graph queries, analyzing complex domain data, and automatically generating business insights that can be enhanced further with an application's analysis tools.
6
+
7
+
This MCP server facilitates Text2Cypher workflows like the one detailed below.
8
+
9
+
* Blue steps are handled by the agent
10
+
* Purple by the Cypher or another MCP server
11
+
* Green by the user
12
+
13
+
A user question is input to the process and the output is an answer generated by the agent.
@@ -47,7 +58,7 @@ This is useful when you need to connect to multiple Neo4j databases or instances
47
58
Build and run locally for testing or remote deployment:
48
59
49
60
```bash
50
-
# Build the Docker image with a custom name
61
+
# Build the Docker image with a custom name from your local version of the server
51
62
docker build -t mcp-neo4j-cypher:latest .
52
63
53
64
# Run locally (uses http transport by default for Docker)
@@ -87,15 +98,17 @@ Can be found on PyPi https://pypi.org/project/mcp-neo4j-cypher/
87
98
Add the server to your `claude_desktop_config.json` with the database connection configuration through environment variables. You may also specify the transport method and namespace with cli arguments or environment variables.
**Note**: This assumes you've built the image locally with `docker build -t mcp-neo4j-cypher:latest .`. Docker transport defaults to HTTP mode.
215
239
216
240
## 🐳 Docker Deployment
217
241
218
-
The Neo4j MCP server can be deployed using Docker for remote deployments. Docker deployment uses HTTP transport by default for web accessibility.
242
+
The Neo4j MCP server can be deployed using Docker for remote deployments. Docker deployment uses HTTP transport by default for web accessibility. In order to integrate this deployment with applications like Claude Desktop, you will have to use a proxy in your MCP configuration such as `mcp-remote`.
219
243
220
244
### 📦 Using Your Built Image
221
245
@@ -231,7 +255,7 @@ docker run --rm -p 8000:8000 \
231
255
-e NEO4J_TRANSPORT="http" \
232
256
-e NEO4J_MCP_SERVER_HOST="0.0.0.0" \
233
257
-e NEO4J_MCP_SERVER_PORT="8000" \
234
-
-e NEO4J_MCP_SERVER_PATH="/api/mcp/" \
258
+
-e NEO4J_MCP_SERVER_PATH="/mcp/" \
235
259
mcp/neo4j-cypher:latest
236
260
```
237
261
@@ -243,9 +267,9 @@ docker run --rm -p 8000:8000 \
243
267
|`NEO4J_USERNAME`|`neo4j`| Neo4j username |
244
268
|`NEO4J_PASSWORD`|`password`| Neo4j password |
245
269
|`NEO4J_DATABASE`|`neo4j`| Neo4j database name |
246
-
|`NEO4J_TRANSPORT`|`stdio` (local), `http` (Docker) | Transport protocol (`stdio`, `http`, or `sse`) |
270
+
|`NEO4J_TRANSPORT`|`stdio` (local), `http` (remote) | Transport protocol (`stdio`, `http`, or `sse`) |
|`NEO4J_MCP_SERVER_HOST`|`127.0.0.1` (local), `0.0.0.0` (Docker)| Host to bind to |
272
+
|`NEO4J_MCP_SERVER_HOST`|`127.0.0.1` (local)| Host to bind to |
249
273
|`NEO4J_MCP_SERVER_PORT`|`8000`| Port for HTTP/SSE transport |
250
274
|`NEO4J_MCP_SERVER_PATH`|`/api/mcp/`| Path for accessing MCP server |
251
275
@@ -332,7 +356,7 @@ For Claude Desktop integration with a Dockerized server using http transport:
332
356
}
333
357
```
334
358
335
-
**Note**: First start your Docker container with HTTP transport, then Claude Desktop can connect to it via the HTTP endpoint.
359
+
**Note**: First start your Docker container with HTTP transport, then Claude Desktop can connect to it via the HTTP endpoint and proxy server like `mcp-remote`.
0 commit comments