Kuzu MCP Server

🚀 kuzu-mcp-server

kuzu-mcp-server 是一個模型上下文協議（Model Context Protocol）服務器，它提供了對 Kuzu 數據庫的訪問能力。藉助該服務器，大型語言模型可以檢查數據庫架構，並對指定的 Kuzu 數據庫執行查詢操作。

🚀 快速開始

在Claude Desktop中的使用

使用 Docker（推薦）

1. 編輯配置文件 config.json：
   • 在 macOS 上：~/Library/Application Support/Claude/claude_desktop_config.json
   • 在 Windows 上：%APPDATA%\Claude\claude_desktop_config.json
2. 將以下配置添加到 mcpServers 對象中：

{
    "mcpServers": {
        "kuzu": {
            "command": "docker",
            "args": [
                "run",
                "-v",
                "{Absolute Path to the Kuzu database}:/database",
                "--rm",
                "-i",
                "kuzudb/mcp-server"
            ]
        }
    }
}

請將 {Absolute Path to the Kuzu database} 替換為實際路徑。 3. 重啟 Claude Desktop。

使用 Node.js 和 npm（用於開發）

1. 安裝依賴：npm install
2. 編輯配置文件 config.json：
   • 在 macOS 上：~/Library/Application Support/Claude/claude_desktop_config.json
   • 在 Windows 上：%APPDATA%\Claude\claude_desktop_config.json
3. 將以下配置添加到 mcpServers 對象中：

{
    "mcpServers": {
        "kuzu": {
            "command": "node",
            "args": [
                "{Absolute Path to this repository}/index.js",
                "{Absolute Path to the Kuzu database}"
            ]
        }
    }
}

請將 {Absolute Path to this repository} 和 {Absolute Path to the Kuzu database} 替換為實際路徑。 4. 重啟 Claude Desktop。

只讀模式

通過設置 KUZU_READ_ONLY 環境變量為 true，服務器可以以只讀模式運行。在此模式下，運行任何嘗試修改數據庫的查詢將導致錯誤。此標誌可以在配置文件中如下設置：

{
    "mcpServers": {
        "kuzu": {
            "command": "docker",
            "args": [
                "run",
                "-v",
                "{Absolute Path to the Kuzu database}:/database",
                "-e",
                "KUZU_READ_ONLY=true",
                "--rm",
                "-i",
                "kuzudb/mcp-server"
            ]
        }
    }
}

✨ 主要特性

工具

• getSchema
  • 功能：獲取 Kuzu 數據庫的完整架構，包括所有節點和關係表及其屬性。
  • 輸入：無
• query
  • 功能：在 Kuzu 數據庫上運行 Cypher 查詢。
  • 輸入：cypher（字符串），即要運行的 Cypher 查詢。

提示

• generateKuzuCypher
  • 功能：根據自然語言問題生成 Kuzu 的 Cypher 查詢。
  • 參數：question（字符串），即要生成 Cypher 查詢的自然語言問題。