使用说明

项目简介

kuzu-mcp-server 是一个实现了 Model Context Protocol (MCP) 的服务器，它允许大型语言模型 (LLM) 通过标准化的 MCP 协议与 Kuzu 图数据库进行交互。该服务器提供工具来查询数据库 schema 和执行 Cypher 查询，并支持 Prompt 模板生成 Cypher 查询，使得 LLM 可以利用 Kuzu 数据库中的知识进行更强大的上下文感知和功能扩展。

主要功能点

Schema 检索: 提供 'getSchema' 工具，允许 LLM 获取 Kuzu 数据库的完整 Schema 信息，包括节点表、关系表及其属性，帮助 LLM 理解数据库结构。
Cypher 查询执行: 提供 'query' 工具，允许 LLM 执行 Cypher 查询语句，并以 JSON 格式返回查询结果，使 LLM 能够从 Kuzu 数据库中检索和利用数据。
Cypher 查询生成: 提供 'generateKuzuCypher' Prompt 模板，接收自然语言问题，并生成相应的 Kuzu Cypher 查询语句，辅助 LLM 与数据库进行交互。

安装步骤

Docker (推荐):

确保你的系统已安装 Docker。
无需额外安装步骤，可以直接使用 Docker 镜像运行 kuzu-mcp-server。

Node.js 和 npm (开发):

确保你的系统已安装 Node.js 和 npm。
克隆或下载 kuzu-mcp-server 仓库到本地。
在仓库根目录下打开终端，运行 'npm install' 命令安装项目依赖。

服务器配置

MCP 客户端 (例如 Claude Desktop) 需要配置以下 JSON 信息来连接 kuzu-mcp-server。配置信息添加到 Claude Desktop 的 'config.json' 文件中的 'mcpServers' 对象中。

Docker 配置示例:

{
  "mcpServers": {
      "kuzu": {
          "command": "docker",  // 指定使用 Docker 命令运行服务器
          "args": [
              "run",
              "-v",
              "{Absolute Path to the Kuzu database}:/database", // 将本地 Kuzu 数据库目录挂载到 Docker 容器的 /database 目录
              "--rm",             // 容器退出后自动删除
              "-i",             // 保持 STDIN 打开
              "kuzudb/mcp-server" // 使用 kuzudb/mcp-server Docker 镜像
          ]
      }
  }
}

Node.js 配置示例:

{
  "mcpServers": {
      "kuzu": {
          "command": "node",   // 指定使用 Node.js 命令运行服务器
          "args": [
              "{Absolute Path to this repository}/index.js", // index.js 文件的绝对路径，指向 kuzu-mcp-server 的入口文件
              "{Absolute Path to the Kuzu database}"        // Kuzu 数据库文件的绝对路径
          ]
      }
  }
}

配置参数说明:

'command': 指定启动 MCP 服务器的命令。Docker 方式为 'docker'，Node.js 方式为 'node'。
'args': 启动命令的参数列表。
- Docker 方式:
  - '-v {Absolute Path to the Kuzu database}:/database': 将宿主机上的 Kuzu 数据库目录挂载到容器内的 '/database' 目录。请将 '{Absolute Path to the Kuzu database}' 替换为你的 Kuzu 数据库的实际绝对路径。
  - '--rm -i kuzudb/mcp-server': Docker 运行命令，使用 'kuzudb/mcp-server' 镜像。
- Node.js 方式:
  - '{Absolute Path to this repository}/index.js': 指向 'index.js' 文件，请将 '{Absolute Path to this repository}' 替换为 kuzu-mcp-server 仓库的实际绝对路径。
  - '{Absolute Path to the Kuzu database}': Kuzu 数据库文件的路径。请将 '{Absolute Path to the Kuzu database}' 替换为你的 Kuzu 数据库的实际绝对路径。

注意: 请根据你的实际使用环境选择 Docker 或 Node.js 配置，并确保替换配置中的占位符路径为正确的绝对路径。

基本使用方法

根据你的选择 (Docker 或 Node.js) 和配置，启动 kuzu-mcp-server 服务器。
配置并重启你的 MCP 客户端 (例如 Claude Desktop)，使其加载并连接到名为 "kuzu" 的 MCP 服务器。
在 MCP 客户端中，你可以通过调用 'query' 工具执行 Cypher 查询，调用 'getSchema' 工具获取数据库 Schema，或使用 'generateKuzuCypher' Prompt 模板生成 Cypher 查询，从而与 Kuzu 数据库进行交互。

关键词