使用说明

项目简介

该项目是一个基于Python MCP SDK实现的MCP服务器,旨在为大型语言模型(LLM)应用提供与Neo4j图数据库交互的能力。通过资源、工具和Prompt模板,LLM可以安全、标准化地访问Neo4j数据库的schema信息、执行Cypher查询以及进行数据分析。

主要功能点

  • 资源 (Resources): 提供Neo4j数据库的schema信息,包括节点标签和关系类型,使LLM能够理解数据库结构。
  • 工具 (Tools): 允许LLM执行Cypher查询,并返回查询结果和执行元数据,支持LLM进行数据检索和操作。
  • Prompt 模板 (Prompts): 预定义了一系列用于Neo4j数据分析的Prompt模板,例如关系分析、路径发现等,方便用户快速进行常见的数据分析任务。

安装步骤

  1. 确保已安装Python环境。
  2. 使用 'pip install mcp uvicorn fastapi neo4j python-dotenv' 命令安装项目依赖的Python库。
  3. 配置Neo4j数据库连接信息:
    • 方法一:创建 '.env' 文件,并添加Neo4j数据库的连接信息,例如:
      NEO4J_URI=neo4j+s://your_neo4j_uri
      NEO4J_USER=your_neo4j_user
      NEO4J_PASSWORD=your_neo4j_password
    • 方法二:直接修改 'ne04j_mcp_server.py' 文件中的 'NEO4J_URI', 'NEO4J_USER', 'NEO4J_PASSWORD' 变量,替换为您的Neo4j数据库连接信息。

服务器配置

以下JSON配置信息可用于MCP客户端连接到该MCP服务器。请注意,MCP客户端需要根据实际情况配置 'command' 和 'args' 以启动服务器。

{
  "server name": "Neo4j MCP Server",
  "command": "uvicorn",
  "args": ["ne04j_mcp_server:app", "--host", "0.0.0.0", "--port", "8000"]
}

基本使用方法

  1. 启动服务器:在项目根目录下,运行命令 'uvicorn ne04j_mcp_server:app --host 0.0.0.0 --port 8000' 启动MCP服务器。
  2. 配置MCP客户端:在支持MCP协议的LLM应用或客户端中,配置服务器连接信息,指定上述JSON配置中的 'command' 和 'args' 以连接到该Neo4j MCP服务器。
  3. 与Neo4j交互:通过MCP客户端,LLM可以利用服务器提供的资源(schema)、工具(查询执行)和Prompt模板(数据分析),与Neo4j数据库进行交互,例如查询知识图谱数据、执行数据分析任务等。

信息

分类

数据库与文件