项目简介

MCP Neo4j Server 是一个基于 Model Context Protocol (MCP) 构建的服务器,旨在为大型语言模型 (LLM) 客户端(如 Claude Desktop)提供与 Neo4j 图数据库集成的能力。它允许用户通过自然语言指令,借助 LLM 客户端调用预设的工具来操作 Neo4j 数据库,实现数据查询和管理。

主要功能点

  • 执行 Cypher 查询 (execute_query): 支持执行各种 Cypher 查询语句,从 Neo4j 数据库中检索数据,并以结构化的 JSON 格式返回查询结果。
  • 创建节点 (create_node): 允许在 Neo4j 数据库中创建新的节点,可以指定节点的标签和属性。
  • 创建关系 (create_relationship): 允许在 Neo4j 数据库中创建节点之间的关系,可以定义关系类型和属性,并需要指定关联的源节点和目标节点 ID。

安装步骤

  1. 安装 Node.js 和 npm: 确保你的开发环境中已安装 Node.js 和 npm (Node 包管理器)。
  2. 安装 MCP Neo4j Server: 你可以选择全局安装或直接使用 'npx' 运行,推荐使用 'npx' 快速体验:
    npx @alanse/mcp-neo4j-server
    或者,如果需要进行本地开发或构建,可以克隆仓库后安装依赖并构建:
    git clone https://github.com/da-okazaki/mcp-neo4j-server.git
    cd mcp-neo4j-server
    npm install
    npm run build

服务器配置

要将 MCP Neo4j Server 集成到 MCP 客户端(例如 Claude Desktop),你需要在客户端的 MCP 服务器配置中添加服务器信息。以下是 Claude Desktop 的配置示例,其他 MCP 客户端的配置方式可能类似。

{
  "mcpServers": {
    "neo4j": {  //  服务器名称,可以自定义,用于在客户端中标识
      "command": "npx",  //  启动服务器的命令,这里使用 npx 直接运行 npm 包
      "args": ["@alanse/mcp-neo4j-server"], //  启动命令的参数,指定要运行的 npm 包名
      "env": {
        "NEO4J_URI": "bolt://localhost:7687",  //  Neo4j 数据库的连接 URI,默认为 bolt://localhost:7687
        "NEO4J_USERNAME": "neo4j",  //  Neo4j 数据库的用户名,默认为 neo4j
        "NEO4J_PASSWORD": "your-neo4j-password" //  Neo4j 数据库的密码,**请务必替换为你的实际密码**
      }
    }
  }
}

请注意:

  • 请将 '"your-neo4j-password"' 替换为你实际的 Neo4j 数据库密码。
  • 'NEO4J_URI' 和 'NEO4J_USERNAME' 可以根据你的 Neo4j 数据库配置进行修改。
  • 如果选择克隆仓库并构建后运行,'command' 和 'args' 需要根据实际情况调整,例如 'command' 可以是 'node','args' 可以是 '["dist/index.js"]'。

基本使用方法

  1. 确保 Neo4j 数据库运行: 首先确保你的 Neo4j 数据库服务器已经启动并正在运行,并且配置信息(URI、用户名、密码)正确。

  2. 配置 MCP 客户端: 将上述服务器配置信息添加到你的 MCP 客户端的配置文件中。

  3. 在 LLM 客户端中使用自然语言指令: 在支持 MCP 协议的 LLM 客户端中,你可以使用自然语言来表达对 Neo4j 数据库的操作意图。例如,你可以提问:

    • "Show me all employees in the Sales department" (展示销售部门的所有员工)
    • "Add a new person named John Doe who is 30 years old" (添加一个名为 John Doe,年龄 30 岁的新人)
    • "Make John Doe friends with Jane Smith" (让 John Doe 和 Jane Smith 成为朋友)

    LLM 客户端会解析你的自然语言指令,并调用 MCP Neo4j Server 提供的工具来执行相应的数据库操作,并将结果返回给你。

信息

分类

数据库与文件