Skip to main content

A DuckDB MCP server

Project description

mcp-server-duckdb

PyPI - Version PyPI - License smithery badge

A Model Context Protocol (MCP) server implementation for DuckDB, providing database interaction capabilities through MCP tools. It would be interesting to have LLM analyze it. DuckDB is suitable for local analysis.

mcp-server-duckdb MCP server

Overview

This server enables interaction with a DuckDB database through the Model Context Protocol, allowing for database operations like querying, table creation, and schema inspection.

Components

Resources

Currently, no custom resources are implemented.

Prompts

Currently, no custom prompts are implemented.

Tools

The server implements the following database interaction tools:

  • read-query: Execute SELECT queries to read data from the database

    • Input: query (string) - Must be a SELECT statement
    • Output: Query results as text
  • write-query: Execute INSERT, UPDATE, or DELETE queries to modify data

    • Input: query (string) - Must be a non-SELECT statement
    • Output: Query results as text
  • create-table: Create new tables in the database

    • Input: query (string) - Must be a CREATE TABLE statement
    • Output: Success confirmation message
  • list-tables: List all tables in the database

    • Input: None required
    • Output: List of tables from information_schema
  • describe-table: Get schema information for a specific table

    • Input: table_name (string) - Name of the table to describe
    • Output: Table schema information

Note: When the server is running in readonly mode, the following tools are disabled to prevent any write operations:

  • write-query
  • create-table

This ensures that the Language Model (LLM) cannot perform any modifications to the database, maintaining data integrity and preventing unintended changes.

Configuration

Required Parameters

  • db-path (string): Path to the DuckDB database file
    • The server will automatically create the database file and parent directories if they don't exist

Optional Parameters

  • --readonly: Run server in read-only mode
    • Description: When this flag is set, the server operates in read-only mode. This means:
      • The DuckDB database will be opened with read_only=True, preventing any write operations.
      • If the specified database file does not exist, it will not be created.
      • Security Benefit: Prevents the Language Model (LLM) from performing any write operations, ensuring that the database remains unaltered.
    • Reference: For more details on read-only connections in DuckDB, see the DuckDB Python API documentation.

Installation

Installing via Smithery

To install DuckDB Server for Claude Desktop automatically via Smithery:

npx -y @smithery/cli install mcp-server-duckdb --client claude

Claude Desktop Integration

Configure the MCP server in Claude Desktop's configuration file:

MacOS

Location: ~/Library/Application Support/Claude/claude_desktop_config.json

Windows

Location: %APPDATA%/Claude/claude_desktop_config.json

{
  "mcpServers": {
    "duckdb": {
      "command": "uvx",
      "args": [
        "mcp-server-duckdb",
        "--db-path",
        "~/mcp-server-duckdb/data/data.db"
      ]
    }
  }
}
  • Note: ~/mcp-server-duckdb/data/data.db should be replaced with the actual path to the DuckDB database file.

Development

Prerequisites

  • Python with uv package manager
  • DuckDB Python package
  • MCP server dependencies

Debugging

Debugging MCP servers can be challenging due to their stdio-based communication. We recommend using the MCP Inspector for the best debugging experience.

Using MCP Inspector

  1. Install the inspector using npm:
npx @modelcontextprotocol/inspector uv --directory ~/codes/mcp-server-duckdb run mcp-server-duckdb --db-path ~/mcp-server-duckdb/data/data.db
  1. Open the provided URL in your browser to access the debugging interface

The inspector provides visibility into:

  • Request/response communication
  • Tool execution
  • Server state
  • Error messages

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

mcp_server_duckdb-1.0.0.tar.gz (25.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

mcp_server_duckdb-1.0.0-py3-none-any.whl (7.3 kB view details)

Uploaded Python 3

File details

Details for the file mcp_server_duckdb-1.0.0.tar.gz.

File metadata

  • Download URL: mcp_server_duckdb-1.0.0.tar.gz
  • Upload date:
  • Size: 25.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.6.7

File hashes

Hashes for mcp_server_duckdb-1.0.0.tar.gz
Algorithm Hash digest
SHA256 9fb2c530161fdb067b1b4e6a567962996db8a32652af5b4b065340e496f8b526
MD5 3b98df9cb7bf35939e5010461b4fa9ac
BLAKE2b-256 950900309bd504d20a025a1f5bed14316b741e9d7a9659a45c23962d166b4eae

See more details on using hashes here.

File details

Details for the file mcp_server_duckdb-1.0.0-py3-none-any.whl.

File metadata

File hashes

Hashes for mcp_server_duckdb-1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 e0d4b7366d879575328be8ba47dcab9d21478e75603b37114af5d453f043027c
MD5 3cb31515f0500162b8d7bed1185367cf
BLAKE2b-256 12cc392eec201b3dff22b6eb8607bd67cd29e8d0d19486a3b0230e1b77f0129e

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page