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
+42-49Lines changed: 42 additions & 49 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -11,25 +11,28 @@ A Model Context Protocol (MCP) server implementation that provides database inte
11
11
The server offers these core tools:
12
12
13
13
#### 📊 Query Tools
14
+
14
15
-`read_neo4j_cypher`
15
-
- Execute Cypher read queries to read data from the database
16
-
- Input:
17
-
-`query` (string): The Cypher query to execute
18
-
-`params` (dictionary, optional): Parameters to pass to the Cypher query
19
-
- Returns: Query results as JSON serialized array of objects
16
+
17
+
- Execute Cypher read queries to read data from the database
18
+
- Input:
19
+
-`query` (string): The Cypher query to execute
20
+
-`params` (dictionary, optional): Parameters to pass to the Cypher query
21
+
- Returns: Query results as JSON serialized array of objects
20
22
21
23
-`write_neo4j_cypher`
22
-
- Execute updating Cypher queries
23
-
- Input:
24
-
-`query` (string): The Cypher update query
25
-
-`params` (dictionary, optional): Parameters to pass to the Cypher query
26
-
- Returns: A JSON serialized result summary counter with `{ nodes_updated: number, relationships_created: number, ... }`
24
+
- Execute updating Cypher queries
25
+
- Input:
26
+
-`query` (string): The Cypher update query
27
+
-`params` (dictionary, optional): Parameters to pass to the Cypher query
28
+
- Returns: A JSON serialized result summary counter with `{ nodes_updated: number, relationships_created: number, ... }`
27
29
28
30
#### 🕸️ Schema Tools
31
+
29
32
-`get_neo4j_schema`
30
-
- Get a list of all nodes types in the graph database, their attributes with name, type and relationships to other node types
31
-
- No input required
32
-
- Returns: JSON serialized list of node labels with two dictionaries: one for attributes and one for relationships
33
+
- Get a list of all nodes types in the graph database, their attributes with name, type and relationships to other node types
34
+
- No input required
35
+
- Returns: JSON serialized list of node labels with two dictionaries: one for attributes and one for relationships
33
36
34
37
### 🏷️ Namespacing
35
38
@@ -62,21 +65,20 @@ docker run -p 8000:8000 \
62
65
The server supports different transport protocols depending on your deployment:
63
66
64
67
-**STDIO** (default for local development): Standard input/output for Claude Desktop and local tools
65
-
-**HTTP** (default for Docker): RESTful HTTP for web deployments and microservices
68
+
-**HTTP** (default for Docker): RESTful HTTP for web deployments and microservices
66
69
-**SSE**: Server-Sent Events for legacy web-based deployments
67
70
68
71
Choose your transport based on use case:
69
-
-**Local development/Claude Desktop**: Use `stdio`
72
+
73
+
-**Local development/Claude Desktop**: Use `stdio`
70
74
-**Docker/Remote deployment**: Use `http`
71
75
-**Legacy web clients**: Use `sse`
72
76
73
77
## 🔧 Usage with Claude Desktop
74
78
75
79
### Using DXT
76
-
Download the latest `.dxt` file from the [releases page](https://github.com/neo4j-contrib/mcp-neo4j/releases/latest) and install it with your MCP client.
@@ -401,8 +396,6 @@ For development with Claude Desktop using the local source:
401
396
402
397
Replace `/path/to/mcp-neo4j-cypher` with your actual project directory path.
403
398
404
-
405
-
406
399
## 📄 License
407
400
408
401
This MCP server is licensed under the MIT License. This means you are free to use, modify, and distribute the software, subject to the terms and conditions of the MIT License. For more details, please see the LICENSE file in the project repository.
0 commit comments