kuzudb_kuzu_mcp_server

kuzudb_kuzu_mcp_server

by kuzudb
A Model Context Protocol server enabling LLMs to access and query Kuzu databases.

Kuzu Database MCP Server: Seamless Integration with Claude Desktop

Overview

The Kuzu Database MCP Server is a Model Context Protocol server designed to provide access to Kuzu databases. It enables Large Language Models (LLMs) to inspect database schemas and execute queries on Kuzu databases, making it a powerful tool for integrating structured data with AI workflows.

Key Features

  • Schema Inspection: Fetch the full schema of the Kuzu database, including all nodes, relationships, and their properties.
  • Query Execution: Run Cypher queries directly on the Kuzu database.
  • Natural Language Query Generation: Generate Cypher queries from natural language questions.

Tools

getSchema

  • Functionality: Fetches the full schema of the Kuzu database.
  • Input: None
  • Output: Schema details including nodes, relationships, and properties.

query

  • Functionality: Executes a Cypher query on the Kuzu database.
  • Input: cypher (string): The Cypher query to run.
  • Output: Query results.

generateKuzuCypher

  • Functionality: Generates a Cypher query from a natural language question.
  • Input: question (string): The question in natural language.
  • Output: Generated Cypher query.

Configuration

With Docker (Recommended)

  1. Edit the configuration file config.json:
  2. macOS: ~/Library/Application Support/Claude/claude_desktop_config.json
  3. Windows: %APPDATA%\Claude\claude_desktop_config.json
  4. Add the following configuration to the mcpServers object:
    json { "mcpServers": { "kuzu": { "command": "docker", "args": [ "run", "-v", "{Absolute Path to the Kuzu database}:/database", "--rm", "-i", "kuzudb/mcp-server" ] } } }
  5. Replace {Absolute Path to the Kuzu database} with the actual path.
  6. Restart Claude Desktop.

With Node.js and npm (for Development)

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

Read-Only Mode

To run the server in read-only mode, set the KUZU_READ_ONLY environment variable to true. This prevents any queries that attempt to modify the database. Add the following configuration to the mcpServers object:

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

Usage with Claude Desktop

The Kuzu Database MCP Server integrates seamlessly with Claude Desktop, enabling users to leverage the power of Kuzu databases within their AI workflows. Whether you're developing or deploying, the server provides a robust interface for schema inspection and query execution.

About

The Kuzu Database MCP Server is an open-source project licensed under the MIT license. It is designed to facilitate the integration of Kuzu databases with AI models, providing a bridge between structured data and natural language processing.

Resources

Features & Capabilities

Categories
mcp_server model_context_protocol javascript docker database kuzu cypher api_integration

Implementation Details

Stats

0 Views
0 Favorites
5 GitHub Stars

Repository Info

kuzudb Organization

Similar Servers

continuedev_continue by continuedev
0
0
0