Skip to main content

Clickhouse MCP server

smithery badge

A Clickhouse database MCP server project.

Installation

You can install the package using uv:

uv pip install clickhouse-mcp-server

Or using pip:

pip install clickhouse-mcp-server

Components

Tools

The server provides two tools:

  • connect_database: Connects to a specific Clickhouse database

    • database parameter: Name of the database to connect to (string)
    • Returns a confirmation message when connection is successful
  • execute_query: Executes Clickhouse queries

    • query parameter: SQL query/queries to execute (string)
    • Returns query results in JSON format
    • Multiple queries can be sent separated by semicolons

Configuration

The server uses the following environment variables:

  • CLICKHOUSE_HOST: Clickhouse server address (default: "localhost")
  • CLICKHOUSE_USER: Clickhouse username (default: "root")
  • CLICKHOUSE_PASSWORD: Clickhouse password (default: "")
  • CLICKHOUSE_DATABASE: Initial database (optional)
  • CLICKHOUSE_READONLY: Read-only mode (set to 1/true to enable, default: false)

Quickstart

Installation

Claude Desktop

MacOS: ~/Library/Application\ Support/Claude/claude_desktop_config.json

Windows: %APPDATA%/Claude/claude_desktop_config.json

Development/Unpublished Server Configuration
{
  "mcpServers": {
    "clickhouse-mcp-server": {
      "command": "uv",
      "args": [
        "--directory",
        "/Users/burakdirin/Projects/clickhouse-mcp-server",
        "run",
        "clickhouse-mcp-server"
      ],
      "env": {
        "CLICKHOUSE_HOST": "localhost",
        "CLICKHOUSE_USER": "root",
        "CLICKHOUSE_PASSWORD": "password",
        "CLICKHOUSE_DATABASE": "[optional]",
        "CLICKHOUSE_READONLY": "true"
      }
    }
  }
}
Published Server Configuration
{
  "mcpServers": {
    "clickhouse-mcp-server": {
      "command": "uvx",
      "args": [
        "clickhouse-mcp-server"
      ],
      "env": {
        "CLICKHOUSE_HOST": "localhost",
        "CLICKHOUSE_USER": "root",
        "CLICKHOUSE_PASSWORD": "password",
        "CLICKHOUSE_DATABASE": "[optional]",
        "CLICKHOUSE_READONLY": "true"
      }
    }
  }
}

Installing via Smithery

To install Clickhouse Database Integration Server for Claude Desktop automatically via Smithery:

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

Development

Building and Publishing

To prepare the package for distribution:

  1. Sync dependencies and update lockfile:
uv sync
  1. Build package distributions:
uv build

This will create source and wheel distributions in the dist/ directory.

  1. Publish to PyPI:
uv publish

Note: You'll need to set PyPI credentials via environment variables or command flags:

  • Token: --token or UV_PUBLISH_TOKEN
  • Or username/password: --username/UV_PUBLISH_USERNAME and --password/UV_PUBLISH_PASSWORD

Debugging

Since MCP servers run over stdio, debugging can be challenging. For the best debugging experience, we strongly recommend using the MCP Inspector.

You can launch the MCP Inspector via npm with this command:

npx @modelcontextprotocol/inspector uv --directory /Users/burakdirin/Projects/clickhouse-mcp-server run clickhouse-mcp-server

Upon launching, the Inspector will display a URL that you can access in your browser to begin debugging.

Metadata

Release files for clickhouse-mcp-server 0.1.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for clickhouse-mcp-server 0.1.0
File Size Uploaded Provenance
clickhouse_mcp_server-0.1.0.tar.gz 19.0 kB Without provenance Details

Built distribution (wheel)

Table of built distributions (wheels) for clickhouse-mcp-server 0.1.0
File Interpreter ABI Platform
clickhouse_mcp_server-0.1.0-py3-none-any.whl Python 3 none any Details

Total release size: 25.3 kB

Release files / clickhouse_mcp_server-0.1.0.tar.gz

Download URL clickhouse_mcp_server-0.1.0.tar.gz
Size 19.0 kB
Tags Source
SHA-256 checksum
How to use checksums
a9fc91a3ae1e9402c892f3aeb38d7f91a317a9930e2343bd54ba7d8be33468be
BLAKE2b-256 checksum
How to use checksums
bb4ea7d4f66604fc313ea6d652b24d0a71b16bf3d5361a533fc3dd04182a04eb
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via uv/0.6.6

Release files / clickhouse_mcp_server-0.1.0-py3-none-any.whl

Download URL clickhouse_mcp_server-0.1.0-py3-none-any.whl
Size 6.3 kB
Tags Python 3
SHA-256 checksum
How to use checksums
7fe98d996b783f81481095d14305e5df38d29258504b1982d592d481f240269d
BLAKE2b-256 checksum
How to use checksums
77a8dd763255f9092e6e690e3ccb1300bd8e074dcece1b3c8177b6d5966ccf8c
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via uv/0.6.6

Security for clickhouse-mcp-server 0.1.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

0.1.0 This release

2 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page