Neo4j Mcpserver

🚀 Neo4j MCP Server

A Neo4j MCP server implementation for managing graph database operations via the Model Context Protocol.

🔌 Compatible with Cursor and desktop version of Claude!

🚀 Quick Start

You can directly run the server using npx:

# Use a single connection string
NEO4J_CONNECTION=neo4j+s://your-instance.databases.neo4j.io,neo4j,your-password npx neo4j-mcpserver

# Or use separate environment variables
NEO4J_URI=neo4j+s://your-instance.databases.neo4j.io NEO4J_USER=neo4j NEO4J_PASSWORD=your-password npx neo4j-mcpserver

📦 Installation

If you prefer to install globally:

npm install -g neo4j-mcpserver

Then run it:

NEO4J_CONNECTION=neo4j+s://your-instance.databases.neo4j.io,neo4j,your-password neo4j-mcpserver

📚 Documentation

Environment Variables

You can provide Neo4j connection information in two ways:

1. Use a single connection string:

   NEO4J_CONNECTION=<uri>,<user>,<password>
   

2. Use separate environment variables:

   NEO4J_URI=<your-uri>
   NEO4J_USER=<your-user>
   NEO4J_PASSWORD=<your-password>
   

You can also use a .env file in the project root directory:

NEO4J_URI=neo4j+s://your-instance.databases.neo4j.io
NEO4J_USER=neo4j
NEO4J_PASSWORD=your-password

Configuration ⚙️

Configuration in Cursor 🖥️

To set up the Neo4j MCP server in Cursor:

1. Open Cursor settings.
2. Click on Features > MCP Server.
3. Click the "+ Add new MCP Server" button.
4. Fill in the following information:
   • Name: Enter a nickname for the server (e.g., "neo4j-mcp").
   • Type: Select "Command" as the type.
   • Command: Enter the command to run the server:

     env=NEO4J_URI=your-neo4j-uri,NEO4J_USER=your-neo4j-user,NEO4J_PASSWORD=your-neo4j-password npx -y @neobarrientos/neo4j_mcpserver
     

   Note: Replace the credentials with your actual Neo4j database credentials.

Available Tools 🛠️

neo4j-query

Execute Cypher queries on your Neo4j database.

Example usage in Cursor:

MATCH (n) RETURN n LIMIT 5

Troubleshooting 🔧

If you encounter issues:

1. Verify Neo4j credentials

   • Check if your Neo4j URI, username, and password are correct.
   • Ensure your Neo4j database is accessible.

2. Path issues

   • Ensure there are no spaces in the installation path.
   • Use forward slashes (/) in the path.

3. Tool detection issues

   • Try restarting Cursor.
   • Verify if the server is running (check Cursor's MCP server list).
   • Confirm that the environment variables are set correctly.

Development 👩💻

After cloning the project from the repository, follow these steps for development:

1. Clone the repository:

   git clone [repository address]
   cd [project directory]
   

2. Install dependencies:

   npm install
   

3. Start the server:

   npm start
   

4. Run tests:

   npm test
   

📄 License

MIT License

Copyright (c) [year] [author's name]

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.