RensaU/neo4j-mcp-server

Neo4j MCP Server: Multi-Tenant Graph Database on Azure AKS 🚀

Table of Contents

• Overview
• Features
• Architecture
• Installation
• Usage
• Deployment on Azure AKS
• Configuration
• Contributing
• License

Overview

The Neo4j MCP Server is a production-ready server designed for multi-tenancy. It integrates seamlessly with Claude Code and provides enterprise-grade features. This server leverages the power of Neo4j, a leading graph database, to manage complex relationships and data structures efficiently.

You can find the latest releases here. This link will take you to the section where you can download and execute the necessary files.

Features

• Multi-Tenancy Support: Handle multiple tenants efficiently with isolated data environments.
• Integration with Claude Code: Designed to work smoothly with Claude Code for enhanced functionality.
• Azure AKS Deployment: Easy deployment on Azure Kubernetes Service for scalability and reliability.
• Graph Database Capabilities: Utilize Neo4j’s graph database features for complex data relationships.
• Enterprise-Grade Security: Built-in security features to protect your data and ensure compliance.
• TypeScript Implementation: The server is built using TypeScript, ensuring type safety and better maintainability.

Architecture

The architecture of the Neo4j MCP Server consists of several key components:

1. Client Layer: This layer handles requests from users and forwards them to the appropriate services.
2. Service Layer: Contains the business logic for processing requests and interacting with the database.
3. Database Layer: The Neo4j database that stores all the data and relationships.
4. Deployment Layer: Manages the deployment of the server on Azure AKS.

Installation

To install the Neo4j MCP Server, follow these steps:

1. Clone the repository:

   git clone https://github.com/RensaU/neo4j-mcp-server.git
   

2. Navigate to the project directory:

   cd neo4j-mcp-server
   

3. Install dependencies:

   npm install
   

4. Build the project:

   npm run build
   

5. Start the server:

   npm start
   

You can find the latest releases here. Download and execute the necessary files for a smooth setup.

Usage

Once the server is running, you can access it via the following endpoint:

http://localhost:3000/api

API Endpoints

• GET /tenants: Retrieve a list of all tenants.
• POST /tenants: Create a new tenant.
• GET /tenants/{id}: Retrieve details of a specific tenant.
• PUT /tenants/{id}: Update a specific tenant.
• DELETE /tenants/{id}: Delete a specific tenant.

Example Request

To create a new tenant, send a POST request to /tenants with the following JSON body:

{
  "name": "Tenant Name",
  "description": "Description of the tenant."
}

Example Response

A successful response will return the created tenant details:

{
  "id": "1",
  "name": "Tenant Name",
  "description": "Description of the tenant."
}

Deployment on Azure AKS

Deploying the Neo4j MCP Server on Azure AKS involves several steps:

1. Create an Azure AKS Cluster: Use the Azure CLI to create a new AKS cluster.

   az aks create --resource-group myResourceGroup --name myAKSCluster --node-count 1 --enable-addons monitoring --generate-ssh-keys
   

2. Connect to the AKS Cluster: Set up your local environment to connect to the AKS cluster.

   az aks get-credentials --resource-group myResourceGroup --name myAKSCluster
   

3. Deploy the Application: Use a Kubernetes deployment file to deploy the Neo4j MCP Server.

   apiVersion: apps/v1
   kind: Deployment
   metadata:
     name: neo4j-mcp-server
   spec:
     replicas: 1
     selector:
       matchLabels:
         app: neo4j-mcp-server
     template:
       metadata:
         labels:
           app: neo4j-mcp-server
       spec:
         containers:
         - name: neo4j-mcp-server
           image: rensau/neo4j-mcp-server:latest
           ports:
           - containerPort: 3000
   

4. Expose the Service: Create a service to expose the application.

   apiVersion: v1
   kind: Service
   metadata:
     name: neo4j-mcp-server
   spec:
     type: LoadBalancer
     ports:
       - port: 80
         targetPort: 3000
     selector:
       app: neo4j-mcp-server
   

5. Access the Application: After deployment, use the external IP to access the application.

Configuration

Configuration settings can be managed via environment variables. Here are some key settings:

• NEO4J_URI: The URI for the Neo4j database.
• NEO4J_USERNAME: The username for connecting to the Neo4j database.
• NEO4J_PASSWORD: The password for connecting to the Neo4j database.
• TENANT_PREFIX: A prefix for tenant identifiers.

You can set these variables in a .env file in the root directory:

NEO4J_URI=bolt://localhost:7687
NEO4J_USERNAME=neo4j
NEO4J_PASSWORD=password
TENANT_PREFIX=tenant-

Contributing

We welcome contributions to the Neo4j MCP Server. To contribute:

1. Fork the repository.
2. Create a new branch:

   git checkout -b feature/YourFeature
   

3. Make your changes and commit them:

   git commit -m "Add your feature"
   

4. Push to your branch:

   git push origin feature/YourFeature
   

5. Create a pull request.

Please ensure that your code adheres to the existing style and includes tests where applicable.

License

This project is licensed under the MIT License. See the file for details.

You can find the latest releases here. Download and execute the necessary files for the most up-to-date features and fixes.