MCP Neo4j Memory Server

🚀 MCP Neo4j Knowledge Graph Memory Server

The MCP Neo4j Knowledge Graph Memory Server is a powerful tool designed to manage and query knowledge graphs stored in a Neo4j database. It offers flexible installation options, easy configuration, and a range of usage scenarios, from basic to advanced.

🚀 Quick Start

Get started with the MCP Neo4j Knowledge Graph Memory Server by following the installation and configuration steps below.

📦 Installation

Install via NPM

npm install mcp-neo4j

Manual Installation

1. Download the source code:

   git clone https://github.com/your-repository.git
   cd mcp-neo4j
   

2. Install dependencies:

   npm install
   

🛠️ Configuration

Environment Variable Configuration

Set the following environment variables to configure the server behavior:

Example Configuration

export MCP_PORT=3001
export MCP_DB_URI=http://localhost:7687

💻 Usage Examples

Basic Usage

Use in JavaScript:

const { MemoryKnowledgeGraph } = require('mcp-neo4j');
const graph = new MemoryKnowledgeGraph({
  port: 3000,
  dbUri: 'http://localhost:7474',
  dbUser: 'neo4j',
  dbPassword: 'password'
});

// Query the knowledge graph
async function queryKnowledgeGraph() {
  const results = await graph.search('查找用户信息');
  console.log(results);
}

queryKnowledgeGraph();

Advanced Usage

Fuzzy Search

const results = await graph.fuzzySearch('部分匹配内容');

🗄️ Project-Specific Knowledge Graph Database Switching

Database Management Commands

📄 Documentation

Database Management API

Get the Current Database

graphGetCurrentDatabase(): Promise<string>;

Switch Databases

graphSwitchDatabase(newDbName: string, createIfNotExists: boolean): Promise<void>;

List All Databases

graphListDatabases(): Promise<string[]>;

🔧 Technical Details

Graph Database Structure

The knowledge graph is stored in Neo4j. Here is the architecture diagram:

graph TD
    E[Entity] -->|HAS_OBSERVATION| O[Observation]
    E1[Entity] -->|RELATES_TO| E2[Entity]
    P[Project] -->|CONTAINS| F[File]
    F -->|HAS_FUNCTION| Fn[Function]
    F -->|HAS_CLASS| C[Class]
    P -->|HAS_ERROR| Er[Error]
    P -->|HAS_REQUIREMENT| R[Requirement]

    classDef entity fill:#f9f,stroke:#333,stroke-width:2px;
    classDef observation fill:#bbf,stroke:#333,stroke-width:1px;
    classDef project fill:#fdf,stroke:#333,stroke-width:3px;
    classDef file fill:#fff,stroke:#333,stroke-width:1px;
    classDef function fill:#ffw,stroke:#333,stroke-width:1px;
    classDef error fill:#fww,stroke:#333,stroke-width:1px;
    classDef requirement fill:#www,stroke:#333,stroke-width:1px;

    E, E1, E2 -> entity
    O -> observation
    P -> project
    F -> file
    Fn -> function
    Er -> error
    R -> requirement

Advantages of the Implementation

• Efficient Querying: Use the Cypher query language for fast data retrieval.
• Scalability: Support custom plugins to extend functionality.
• Security: Integrate authentication and access control mechanisms.

🛠️ Development

Install Dependencies

pnpm install

Run Tests

npm test

Build the Project

npm run build

📄 License

MIT License