Kuzu MCP Server

🚀 kuzu-mcp-server

A Model Context Protocol (MCP) server that provides access to the Kuzu database. This server enables large language models to inspect the database schema and execute queries on the provided Kuzu database.

🚀 Quick Start

The following sections will introduce how to use the kuzu-mcp-server in Claude Desktop.

✨ Features

This server offers the following components and features:

Tools

• getSchema

  • Retrieve the complete schema of the Kuzu database, including all node and relationship tables and their attributes.
  • Input: None

• query

  • Execute Cypher queries on the Kuzu database.
  • Input: cypher (string): The Cypher query to be executed.

Prompts

• generateKuzuCypher
  • Generate Cypher queries for Kuzu based on natural language questions.
  • Parameter: question (string): The natural language question for which to generate a Cypher query.

📦 Installation

Using Docker (Recommended)

1. Edit the configuration file config.json:

• On macOS: ~/Library/Application Support/Claude/claude_desktop_config.json
• On Windows: %APPDATA%\Claude\claude_desktop_config.json

2. Add the following configuration to the mcpServers object:

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

Replace {Absolute Path to the Kuzu database} with the actual path. 3. Restart Claude Desktop.

Using Node.js and npm (For Development)

1. Install dependencies: npm install
2. Edit the configuration file config.json:

• On macOS: ~/Library/Application Support/Claude/claude_desktop_config.json
• On Windows: %APPDATA%\Claude\claude_desktop_config.json

3. 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}"
            ]
        }
    }
}

Replace {Absolute Path to this repository} and {Absolute Path to the Kuzu database} with the actual paths. 4. Restart Claude Desktop.

Read-Only Mode

By setting the KUZU_READ_ONLY environment variable to true, the server can run in read-only mode. In this mode, 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",
                "{Absolute Path to the Kuzu database}:/database",
                "-e",
                "KUZU_READ_ONLY=true",
                "--rm",
                "-i",
                "kuzudb/mcp-server"
            ]
        }
    }
}