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 tool:

  • query: Execute any SQL query on the DuckDB database
    • Input: query (string) - Any valid DuckDB SQL statement
    • Output: Query results as text (or success message for operations like CREATE/INSERT)

[!NOTE] The server provides a single unified query function rather than separate specialized functions, as modern LLMs can generate appropriate SQL for any database operation (SELECT, CREATE TABLE, JOIN, etc.) without requiring separate endpoints.

[!NOTE] When the server is running in readonly mode, DuckDB's native readonly protection is enforced. This ensures that the Language Model (LLM) cannot perform any write operations (CREATE, INSERT, UPDATE, DELETE), 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
    • If --readonly is specified and the database file doesn't exist, the server will fail to start with an error

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.1.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.1-py3-none-any.whl (7.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: mcp_server_duckdb-1.0.1.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.1.tar.gz
Algorithm Hash digest
SHA256 636438985405c06cc3588d8f6b25f7015bd2a055e7b46513a6734164d11a94a0
MD5 fbd298d93b6d033b0abf286a6ab5af29
BLAKE2b-256 aac632e0137f7f7a62497b7f838e303971638c5b58017fba4057fb19e82fe781

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for mcp_server_duckdb-1.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 f9e803470dc5dc9a4ba11b2ca88c73bdbbba4e9b67e52f616422ba99287cbed1
MD5 f94d7a20ed1609a3855729ca8b147325
BLAKE2b-256 9747f53f5feb90248c593c10c69b459c2bcf36c6bcc6580aa3aeb7e5bb951ad7

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