Kuzu

by kuzudb

9 stars
Not rated
GitHub

About

Bridge to Kuzu graph databases. Enables LLMs to inspect database schemas and execute queries.

Details

Author
kuzudb
Repository
kuzudb/kuzu-mcp-server
GitHub stars
9
License
MIT License
Categories
Database, Other, Knowledge Base, AI
Tags
#integration, #web

Setting up with Highlight

This MCP is not yet compatible with Highlight’s one-click setup. However, you can still use it with Highlight by following these steps:

  1. Download and install Highlight from highlightai.com/download
  2. Navigate to the plugins tab and select "Add Custom Plugin"
  3. Configure the plugin with the settings below
    Plugin Name Kuzu
    Command (node, npx, python, etc.) node
    Arguments
    • Argument 1 {Absolute Path to this repository}/index.js
    • Argument 2 {Absolute Path to the Kuzu database file}
    Environment
    • KUZU_READ_ONLY true

    Please refer to the README for specific instructions on how to obtain API keys or other required environment variables.

  4. Enable "Start Automatically" if you want the plugin to start when Highlight launches

getSchema

Fetch the full schema of the Kuzu database, including all nodes and relationships tables and their properties. Input: None

query

Run a Cypher query on the Kuzu database. Input: `cypher` (string): The Cypher query to run

generateKuzuCypher

Generate a Cypher query for Kuzu. Argument: `question` (string): The question in natural language to generate the Cypher query for

- getSchema
- Fetch the full schema of the Kuzu database, including all nodes and relationships tables and their properties
- Input: None

- query
- Run a Cypher query on the Kuzu database
- Input: cypher (string): The Cypher query to run

Claude Desktop / Cursor

Paste into your MCP client config file to install this server.

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

Linux

{
    "env": {
        "KUZU_READ_ONLY": "true"
    },
    "args": [
        "run",
        "-v",
        "{Path to the directory containing Kuzu database file}:/database",
        "-e",
        "KUZU_DB_FILE={Kuzu database file name}",
        "--rm",
        "-i",
        "kuzudb/mcp-server"
    ],
    "command": "docker"
}

Macos

{
    "env": {
        "KUZU_READ_ONLY": "true"
    },
    "args": [
        "{Absolute Path to this repository}/index.js",
        "{Absolute Path to the Kuzu database file}"
    ],
    "command": "node"
}

Windows

{
    "env": {
        "KUZU_READ_ONLY": "true"
    },
    "args": [
        "{Absolute Path to this repository}/index.js",
        "{Absolute Path to the Kuzu database file}"
    ],
    "command": "node"
}

kuzu-mcp-server

A Model Context Protocol server that provides access to Kuzu databases. This server enables LLMs to inspect database schemas and execute queries on provided kuzu database.

Components

Tools

- getSchema - Fetch the full schema of the Kuzu database, including all nodes and relationships tables and their properties - Input: None

- query
- Run a Cypher query on the Kuzu database
- Input: cypher (string): The Cypher query to run

Prompt

- generateKuzuCypher - Generate a Cypher query for Kuzu - Argument: question (string): The question in natural language to generate the Cypher query for

Usage with Claude Desktop

With Docker (Recommended)

- Edit the configuration file config.json: - on macOS: ~/Library/Application Support/Claude/claude_desktop_config.json - on Windows: %APPDATA%\Claude\claude_desktop_config.json - Add the following configuration to the mcpServers object:
  {
    "mcpServers": {
        "kuzu": {
            "command": "docker",
            "args": [
                "run",
                "-v",
                "{Path to the directory containing Kuzu database file}:/database",
                "-e",
                "KUZU_DB_FILE={Kuzu database file name}",
                "--rm",
                "-i",
                "kuzudb/mcp-server"
            ]
        }
    }
  }
  
Change the {Path to the directory containing Kuzu database file} to the actual path - Restart Claude Desktop

With Node.js and npm (for Development)

- Install dependencies: npm install - Edit the configuration file config.json: - on macOS: ~/Library/Application Support/Claude/claude_desktop_config.json - on Windows: %APPDATA%\Claude\claude_desktop_config.json - Add the following configuration to the mcpServers object:
  {
    "mcpServers": {
        "kuzu": {
            "command": "node",
            "args": [
                "{Absolute Path to this repository}/index.js",
                "{Absolute Path to the Kuzu database file}",
            ]
        }
    }
  }
  
Change the {Absolute Path to this repository} and {Absolute Path to the Kuzu database file} to the actual paths - Restart Claude Desktop

Read-Only Mode

The server can be run in read-only mode by setting the KUZU_READ_ONLY environment variable to true. In this mode, running any query that attempts to modify the database will result in an error. This flag can be set in the configuration file as follows:
{
    "mcpServers": {
        "kuzu": {
            "command": "docker",
            "args": [
                "run",
                "-v",
                "{Path to the directory containing Kuzu database file}:/database",
                "-e",
                "KUZU_DB_FILE={Kuzu database file name}",
                "-e",
                "KUZU_READ_ONLY=true",
                "--rm",
                "-i",
                "kuzudb/mcp-server"
            ],
        }
    }
}
No reviews yet — be the first

Sign in to leave a review

Use Google, GitHub, or an email account so ratings stay tied to real people.

Email sign in

No reviews posted yet.