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
+79-20Lines changed: 79 additions & 20 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,21 +1,16 @@
1
-
# Neo4j MCP Server
1
+
# 🔍⁉️ Neo4j MCP Server
2
2
3
-
## Overview
4
-
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 when an Anthropic API key is provided.
3
+
## 🌟 Overview
5
4
6
-
## Components
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.
7
6
8
-
### Resources
7
+
##🧩 Components
9
8
10
-
### Prompts
11
-
The server provides a demonstration prompt:
12
-
-`mcp-demo`: Interactive prompt that guides users through database operations
13
-
- Generates appropriate database schemas and sample data
9
+
### 🛠️ Tools
14
10
15
-
### Tools
16
-
The server offers six core tools:
11
+
The server offers these core tools:
17
12
18
-
#### Query Tools
13
+
#### 📊 Query Tools
19
14
-`read-neo4j-cypher`
20
15
- Execute Cypher read queries to read data from the database
21
16
- Input:
@@ -26,21 +21,21 @@ The server offers six core tools:
26
21
- Execute updating Cypher queries
27
22
- Input:
28
23
-`query` (string): The Cypher update query
29
-
- Returns: a result summary counter with `{ nodes_updated: number, relationships_created: number, ... }`
24
+
- Returns: A result summary counter with `{ nodes_updated: number, relationships_created: number, ... }`
30
25
31
-
#### Schema Tools
26
+
#### 🕸️ Schema Tools
32
27
-`get-neo4j-schema`
33
28
- Get a list of all nodes types in the graph database, their attributes with name, type and relationships to other node types
34
29
- No input required
35
30
- Returns: List of node label with two dictionaries one for attributes and one for relationships
36
31
37
-
## Usage with Claude Desktop
32
+
## 🔧 Usage with Claude Desktop
38
33
39
-
### Released Package
34
+
### 💾 Released Package
40
35
41
36
Can be found on PyPi https://pypi.org/project/mcp-neo4j-cypher/
42
37
43
-
Add the server to your `claude_desktop_config.json` with configuration of
38
+
Add the server to your `claude_desktop_config.json` with configuration of:
44
39
45
40
* db-url
46
41
* username
@@ -63,7 +58,7 @@ Add the server to your `claude_desktop_config.json` with configuration of
63
58
}
64
59
```
65
60
66
-
Here is an example connection for the movie database with Movie, Person (Actor, Director), Genre, User and ratings.
61
+
Here is an example connection for the movie database with Movie, Person (Actor, Director), Genre, User and ratings:
67
62
68
63
```json
69
64
{
@@ -79,7 +74,56 @@ Here is an example connection for the movie database with Movie, Person (Actor,
# Create and activate virtual environment using uv
118
+
uv venv
119
+
source .venv/bin/activate # On Unix/macOS
120
+
.venv\Scripts\activate # On Windows
121
+
122
+
# Install dependencies including dev dependencies
123
+
uv pip install -e ".[dev]"
124
+
```
125
+
126
+
### 🔧 Development Configuration
83
127
84
128
```json
85
129
# Add the server to your claude_desktop_config.json
@@ -102,6 +146,21 @@ Here is an example connection for the movie database with Movie, Person (Actor,
102
146
}
103
147
```
104
148
105
-
## License
149
+
### 🐳 Docker
150
+
151
+
Build and run the Docker container:
152
+
153
+
```bash
154
+
# Build the image
155
+
docker build -t mcp/neo4j-cypher:0.1.1 .
156
+
157
+
# Run the container
158
+
docker run -e NEO4J_URL="bolt://host.docker.internal:7687" \
159
+
-e NEO4J_USERNAME="neo4j" \
160
+
-e NEO4J_PASSWORD="your-password" \
161
+
mcp/neo4j-cypher:0.1.1
162
+
```
163
+
164
+
## 📄 License
106
165
107
166
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