mcp-clickhouse  by ClickHouse

MCP server for ClickHouse

created 7 months ago
467 stars

Top 66.0% on sourcepulse

GitHubView on GitHub
1 Expert Loves This Project
Project Summary

This project provides an MCP (Message Communication Protocol) server for ClickHouse, enabling programmatic interaction with ClickHouse databases. It's designed for developers and data engineers who need to integrate ClickHouse functionality into applications or workflows, offering tools to execute SQL queries, list databases, and list tables.

How It Works

The server leverages the uv Python runtime and is configured via environment variables or a JSON configuration file. It establishes a connection to a ClickHouse instance using provided host, port, user, and password credentials. The core functionality includes executing arbitrary SQL queries (with a readonly=1 safety setting) and metadata retrieval operations like listing databases and tables.

Quick Start & Requirements

  • Install/Run: Configure via Claude Desktop JSON or set environment variables. Development setup involves uv sync and running mcp dev mcp_clickhouse/mcp_server.py.
  • Prerequisites: Python 3.13, uv runtime. Docker is recommended for local development.
  • Resources: Requires access to a ClickHouse instance.
  • Docs: Claude Desktop Configuration

Highlighted Details

  • Supports secure connections (HTTPS) with optional certificate verification.
  • Configurable timeouts for connections and send/receive operations.
  • Includes tools for executing SQL queries and listing database metadata.
  • Provides example configurations for local development, ClickHouse Cloud, and the SQL Playground.

Maintenance & Community

The project is part of the ClickHouse ecosystem. Further community and roadmap details are not explicitly provided in the README.

Licensing & Compatibility

The README does not specify a license. Compatibility for commercial or closed-source linking is not detailed.

Limitations & Caveats

The README emphasizes that default or administrative users should be avoided for security. The project appears to be primarily for integration with Claude Desktop, and its standalone usage or broader compatibility is not fully detailed.

Health Check
Last commit

1 day ago

Responsiveness

Inactive

Pull Requests (30d)
2
Issues (30d)
6
Star History
243 stars in the last 90 days

Explore Similar Projects

Starred by Simon Willison Simon Willison(Author of Django), Jared Palmer Jared Palmer(Ex-VP of AI at Vercel; Founder of Turborepo; Author of Formik, TSDX), and
1 more.

cli by planetscale

0.5%
625
CLI tool for PlanetScale database management
created 4 years ago
updated 1 day ago
Feedback? Help us improve.