loading…
Search for a command to run...
loading…
ClickHouse database integration with schema inspection and query capabilities
ClickHouse database integration with schema inspection and query capabilities
An MCP server for ClickHouse.
run_query
query (string): The SQL query to execute.CLICKHOUSE_ALLOW_WRITE_ACCESS=false), but writes can be enabled explicitly if needed.list_databases
list_tables
database (string).like / not_like (string): Apply LIKE or NOT LIKE filters to table names.page_token (string): Token returned by a previous call for fetching the next page.page_size (int, default 50): Number of tables returned per page.include_detailed_columns (bool, default true): When false, omits column metadata for lighter responses while keeping the full create_table_query.tables: Array of table objects for the current page.next_page_token: Pass this value back to fetch the next page, or null when there are no more tables.total_tables: Total count of tables that match the supplied filters.run_chdb_select_queryquery (string): The SQL query to execute.chdb extra: pip install 'mcp-clickhouse[chdb]'When running with HTTP or SSE transport, a health check endpoint is available at /health. This endpoint:
200 OK (body: OK) if the server is healthy and can connect to ClickHouse503 Service Unavailable with a generic error message if the server cannot connect to ClickHouseThe endpoint is intentionally unauthenticated so orchestrator probes (e.g. Kubernetes liveness/readiness, load balancers) can reach it without credentials. The response body is deliberately minimal to avoid leaking backend version strings or error details; debug failures via the server logs.
Example:
curl http://localhost:8000/health
# Response: OK
When using HTTP or SSE transport, authentication is required by default. The stdio transport (default) does not require authentication as it only communicates via standard input/output.
Three authentication modes are supported. Pick one:
| Mode | When to use | Env var |
|---|---|---|
| Static bearer token | Simple deployments, internal services | CLICKHOUSE_MCP_AUTH_TOKEN |
| OAuth / OIDC (via FastMCP) | Azure Entra, Google, GitHub, WorkOS, etc. | FASTMCP_SERVER_AUTH=<provider-class-path> (+ provider-specific FASTMCP_SERVER_AUTH_* vars) |
| Disabled | Local development only | CLICKHOUSE_MCP_AUTH_DISABLED=true |
Startup fails if none of these are configured for HTTP/SSE transports.
Generate a secure token (can be any random string):
# Using uuidgen (macOS/Linux)
uuidgen
# Using openssl
openssl rand -hex 32
Configure the server with the token:
export CLICKHOUSE_MCP_AUTH_TOKEN="your-generated-token"
Configure your MCP client to include the token in requests:
For Claude Desktop with HTTP/SSE transport:
{
"mcpServers": {
"mcp-clickhouse": {
"url": "http://127.0.0.1:8000",
"headers": {
"Authorization": "Bearer your-generated-token"
}
}
}
}
Note: the /health endpoint is intentionally unauthenticated (see Health Check Endpoint above). To verify that bearer-token auth is actually rejecting unauthenticated requests, hit the MCP endpoint itself e.g. with the MCP Inspector, or by POSTing a JSON-RPC request to /mcp with and without the Authorization header and confirming the unauthenticated call returns 401.
For production deployments with identity providers (Azure Entra, Google, GitHub, WorkOS, etc.), delegate authentication to FastMCP's built-in auth providers instead of using a static token. Set FASTMCP_SERVER_AUTH to the full class path of a FastMCP auth provider, along with the provider-specific FASTMCP_SERVER_AUTH_* variables, and leave CLICKHOUSE_MCP_AUTH_TOKEN unset.
Example (Azure Entra):
export FASTMCP_SERVER_AUTH=fastmcp.server.auth.providers.azure.AzureProvider
export FASTMCP_SERVER_AUTH_AZURE_TENANT_ID="<tenant-id>"
export FASTMCP_SERVER_AUTH_AZURE_CLIENT_ID="<client-id>"
export FASTMCP_SERVER_AUTH_AZURE_CLIENT_SECRET="<client-secret>"
See the FastMCP docs for the full list of providers and their required environment variables.
For local development and testing only, you can disable authentication by setting:
export CLICKHOUSE_MCP_AUTH_DISABLED=true
WARNING: Only use this for local development. Do not disable authentication when the server is exposed to any network.
This MCP server supports both ClickHouse and chDB. You can enable either or both depending on your needs.
Open the Claude Desktop configuration file located at:
~/Library/Application Support/Claude/claude_desktop_config.json%APPDATA%/Claude/claude_desktop_config.jsonAdd the following:
{
"mcpServers": {
"mcp-clickhouse": {
"command": "uv",
"args": [
"run",
"--with",
"mcp-clickhouse",
"--python",
"3.10",
"mcp-clickhouse"
],
"env": {
"CLICKHOUSE_HOST": "<clickhouse-host>",
"CLICKHOUSE_PORT": "<clickhouse-port>",
"CLICKHOUSE_USER": "<clickhouse-user>",
"CLICKHOUSE_PASSWORD": "<clickhouse-password>",
"CLICKHOUSE_ROLE": "<clickhouse-role>",
"CLICKHOUSE_SECURE": "true",
"CLICKHOUSE_VERIFY": "true",
"CLICKHOUSE_CONNECT_TIMEOUT": "30",
"CLICKHOUSE_SEND_RECEIVE_TIMEOUT": "30"
}
}
}
}
Update the environment variables to point to your own ClickHouse service.
Or, if you'd like to try it out with the ClickHouse SQL Playground, you can use the following config:
{
"mcpServers": {
"mcp-clickhouse": {
"command": "uv",
"args": [
"run",
"--with",
"mcp-clickhouse",
"--python",
"3.10",
"mcp-clickhouse"
],
"env": {
"CLICKHOUSE_HOST": "sql-clickhouse.clickhouse.com",
"CLICKHOUSE_PORT": "8443",
"CLICKHOUSE_USER": "demo",
"CLICKHOUSE_PASSWORD": "",
"CLICKHOUSE_SECURE": "true",
"CLICKHOUSE_VERIFY": "true",
"CLICKHOUSE_CONNECT_TIMEOUT": "30",
"CLICKHOUSE_SEND_RECEIVE_TIMEOUT": "30"
}
}
}
}
For chDB (embedded ClickHouse engine), add the following configuration:
{
"mcpServers": {
"mcp-clickhouse": {
"command": "uv",
"args": [
"run",
"--with",
"mcp-clickhouse[chdb]",
"--python",
"3.10",
"mcp-clickhouse"
],
"env": {
"CHDB_ENABLED": "true",
"CLICKHOUSE_ENABLED": "false",
"CHDB_DATA_PATH": "/path/to/chdb/data"
}
}
}
}
You can also enable both ClickHouse and chDB simultaneously:
{
"mcpServers": {
"mcp-clickhouse": {
"command": "uv",
"args": [
"run",
"--with",
"mcp-clickhouse[chdb]",
"--python",
"3.10",
"mcp-clickhouse"
],
"env": {
"CLICKHOUSE_HOST": "<clickhouse-host>",
"CLICKHOUSE_PORT": "<clickhouse-port>",
"CLICKHOUSE_USER": "<clickhouse-user>",
"CLICKHOUSE_PASSWORD": "<clickhouse-password>",
"CLICKHOUSE_SECURE": "true",
"CLICKHOUSE_VERIFY": "true",
"CLICKHOUSE_CONNECT_TIMEOUT": "30",
"CLICKHOUSE_SEND_RECEIVE_TIMEOUT": "30",
"CHDB_ENABLED": "true",
"CHDB_DATA_PATH": "/path/to/chdb/data"
}
}
}
}
Locate the command entry for uv and replace it with the absolute path to the uv executable. This ensures that the correct version of uv is used when starting the server. On a mac, you can find this path using which uv.
Restart Claude Desktop to apply the changes.
By default, this MCP enforces read-only queries so that accidental mutations cannot happen during exploration. To allow DDL or INSERT/UPDATE statements, set the CLICKHOUSE_ALLOW_WRITE_ACCESS environment variable to true. The server keeps enforcing read-only mode if the ClickHouse instance itself disallows writes.
Even when write access is enabled (CLICKHOUSE_ALLOW_WRITE_ACCESS=true), destructive operations (DROP TABLE, DROP DATABASE, DROP VIEW, DROP DICTIONARY, TRUNCATE TABLE) require an additional opt-in flag for safety. This prevents accidental data deletion during AI exploration.
To enable destructive operations, set both flags:
"env": {
"CLICKHOUSE_ALLOW_WRITE_ACCESS": "true",
"CLICKHOUSE_ALLOW_DROP": "true"
}
This two-tier approach ensures that accidental drops are very difficult:
CLICKHOUSE_ALLOW_WRITE_ACCESS=trueCLICKHOUSE_ALLOW_DROP=trueIf you prefer to use the system Python installation instead of uv, you can install the package from PyPI and run it directly:
Install the package using pip:
python3 -m pip install mcp-clickhouse
To install chDB support as well:
python3 -m pip install 'mcp-clickhouse[chdb]'
To upgrade to the latest version:
python3 -m pip install --upgrade mcp-clickhouse
Update your Claude Desktop configuration to use Python directly:
{
"mcpServers": {
"mcp-clickhouse": {
"command": "python3",
"args": [
"-m",
"mcp_clickhouse.main"
],
"env": {
"CLICKHOUSE_HOST": "<clickhouse-host>",
"CLICKHOUSE_PORT": "<clickhouse-port>",
"CLICKHOUSE_USER": "<clickhouse-user>",
"CLICKHOUSE_PASSWORD": "<clickhouse-password>",
"CLICKHOUSE_SECURE": "true",
"CLICKHOUSE_VERIFY": "true",
"CLICKHOUSE_CONNECT_TIMEOUT": "30",
"CLICKHOUSE_SEND_RECEIVE_TIMEOUT": "30"
}
}
}
}
Alternatively, you can use the installed script directly:
{
"mcpServers": {
"mcp-clickhouse": {
"command": "mcp-clickhouse",
"env": {
"CLICKHOUSE_HOST": "<clickhouse-host>",
"CLICKHOUSE_PORT": "<clickhouse-port>",
"CLICKHOUSE_USER": "<clickhouse-user>",
"CLICKHOUSE_PASSWORD": "<clickhouse-password>",
"CLICKHOUSE_SECURE": "true",
"CLICKHOUSE_VERIFY": "true",
"CLICKHOUSE_CONNECT_TIMEOUT": "30",
"CLICKHOUSE_SEND_RECEIVE_TIMEOUT": "30"
}
}
}
}
Note: Make sure to use the full path to the Python executable or the mcp-clickhouse script if they are not in your system PATH. You can find the paths using:
which python3 for the Python executablewhich mcp-clickhouse for the installed scriptYou can add custom middleware to the MCP server without modifying the source code. FastMCP provides a middleware system that allows you to intercept and process MCP protocol messages (tool calls, resource reads, prompts, etc.).
Middleware and a setup_middleware(mcp) function:# my_middleware.py
import logging
from fastmcp.server.middleware import Middleware, MiddlewareContext, CallNext
logger = logging.getLogger("my-middleware")
class LoggingMiddleware(Middleware):
"""Log all tool calls."""
async def on_call_tool(self, context: MiddlewareContext, call_next: CallNext):
tool_name = context.message.name if hasattr(context.message, 'name') else 'unknown'
logger.info(f"Calling tool: {tool_name}")
result = await call_next(context)
logger.info(f"Tool {tool_name} completed")
return result
def setup_middleware(mcp):
"""Register middleware with the MCP server."""
mcp.add_middleware(LoggingMiddleware())
MCP_MIDDLEWARE_MODULE environment variable to the module name (without .py extension):{
"mcpServers": {
"mcp-clickhouse": {
"command": "uv",
"args": ["run", "--with", "mcp-clickhouse", "--python", "3.10", "mcp-clickhouse"],
"env": {
"CLICKHOUSE_HOST": "<clickhouse-host>",
"CLICKHOUSE_USER": "<clickhouse-user>",
"CLICKHOUSE_PASSWORD": "<clickhouse-password>",
"MCP_MIDDLEWARE_MODULE": "my_middleware"
}
}
}
}
An example middleware module is provided in example_middleware.py showing common patterns:
To use the example:
"env": {
"MCP_MIDDLEWARE_MODULE": "example_middleware"
}
The Middleware base class provides hooks for different MCP operations:
on_message(context, call_next) - Called for all messageson_request(context, call_next) - Called for all requestson_notification(context, call_next) - Called for all notificationson_call_tool(context, call_next) - Called when a tool is executedon_read_resource(context, call_next) - Called when a resource is readon_get_prompt(context, call_next) - Called when a prompt is retrievedon_list_tools(context, call_next) - Called when listing toolson_list_resources(context, call_next) - Called when listing resourceson_list_resource_templates(context, call_next) - Called when listing resource templateson_list_prompts(context, call_next) - Called when listing promptsEach hook receives a MiddlewareContext object containing the message and metadata, and a call_next function to continue the pipeline.
Middleware can override ClickHouse client configuration on a per-request basis using the CLIENT_CONFIG_OVERRIDES_KEY context state key. The server merges these overrides with the base configuration from environment variables.
from fastmcp.server.dependencies import get_context
from mcp_clickhouse.mcp_server import CLIENT_CONFIG_OVERRIDES_KEY
ctx = get_context()
ctx.set_state(CLIENT_CONFIG_OVERRIDES_KEY, {
"connect_timeout": 60,
"send_receive_timeout": 120
})
This enables advanced use cases like dynamic timeout adjustments, tenant-specific routing, or per-user connection settings.
In test-services directory run docker compose up -d to start the ClickHouse cluster.
Add the following variables to a .env file in the root of the repository.
Note: The use of the default user in this context is intended solely for local development purposes.
CLICKHOUSE_HOST=localhost
CLICKHOUSE_PORT=8123
CLICKHOUSE_USER=default
CLICKHOUSE_PASSWORD=clickhouse
Run uv sync to install the dependencies. To install uv follow the instructions here. Then do source .venv/bin/activate.
For easy testing with the MCP Inspector, run fastmcp dev mcp_clickhouse/mcp_server.py to start the MCP server.
To test with HTTP transport and the health check endpoint:
# For development, disable authentication
CLICKHOUSE_MCP_SERVER_TRANSPORT=http CLICKHOUSE_MCP_AUTH_DISABLED=true python -m mcp_clickhouse.main
# Or with authentication (generate a token first)
CLICKHOUSE_MCP_SERVER_TRANSPORT=http CLICKHOUSE_MCP_AUTH_TOKEN="your-token" python -m mcp_clickhouse.main
# Then in another terminal:
curl http://localhost:8000/health
The following environment variables are used to configure the ClickHouse and chDB connections:
CLICKHOUSE_HOST: The hostname of your ClickHouse serverCLICKHOUSE_USER: The username for authenticationCLICKHOUSE_PASSWORD: The password for authentication[!CAUTION] It is important to treat your MCP database user as you would any external client connecting to your database, granting only the minimum necessary privileges required for its operation. The use of default or administrative users should be strictly avoided at all times.
CLICKHOUSE_PORT: The port number of your ClickHouse server8443 if HTTPS is enabled, 8123 if disabledCLICKHOUSE_ROLE: The role to use for authenticationCLICKHOUSE_SECURE: Enable/disable HTTPS connection"true""false" for non-secure connectionsCLICKHOUSE_VERIFY: Enable/disable SSL certificate verification"true""false" to disable certificate verification (not recommended for production)truststore. We call truststore.inject_into_ssl() at startup to ensure proper certificate handling. Python’s default SSL behavior is used as a fallback only if an unexpected error occurs.CLICKHOUSE_SERVER_HOST_NAME: Server hostname for SNI override and certificate validationCLICKHOUSE_CONNECT_TIMEOUT: Connection timeout in seconds"30"CLICKHOUSE_SEND_RECEIVE_TIMEOUT: Send/receive timeout in seconds"300"CLICKHOUSE_DATABASE: Default database to useCLICKHOUSE_MCP_SERVER_TRANSPORT: Sets the transport method for the MCP server."stdio""stdio", "http", "sse". This is useful for local development with tools like MCP Inspector.CLICKHOUSE_MCP_BIND_HOST: Host to bind the MCP server to when using HTTP or SSE transport"127.0.0.1""0.0.0.0" to bind to all network interfaces (useful for Docker or remote access)"http" or "sse"CLICKHOUSE_MCP_BIND_PORT: Port to bind the MCP server to when using HTTP or SSE transport"8000""http" or "sse"CLICKHOUSE_MCP_QUERY_TIMEOUT: Timeout in seconds for SELECT tools"30"Query timed out after ... errors for heavy queriesCLICKHOUSE_MCP_AUTH_TOKEN: Static bearer token for HTTP/SSE transportsCLICKHOUSE_MCP_AUTH_TOKEN, FASTMCP_SERVER_AUTH, or CLICKHOUSE_MCP_AUTH_DISABLED=true is required for HTTP/SSE transportsuuidgen or openssl rand -hex 32Authorization: Bearer <token> headerFASTMCP_SERVER_AUTH: Delegate authentication to a FastMCP auth providerfastmcp.server.auth.providers.azure.AzureProvider or fastmcp.server.auth.providers.google.GoogleProviderFASTMCP_SERVER_AUTH_* environment variables; leave CLICKHOUSE_MCP_AUTH_TOKEN unset in this modeCLICKHOUSE_MCP_AUTH_DISABLED: Disable authentication for HTTP/SSE transports"false" (authentication is enabled)"true" to disable authentication for local development/testing onlyCLICKHOUSE_ENABLED: Enable/disable ClickHouse functionality"true""false" to disable ClickHouse tools when using chDB onlyCLICKHOUSE_ALLOW_WRITE_ACCESS: Allow write operations (DDL and DML)"false""true" to allow DDL (CREATE, ALTER, DROP) and DML (INSERT, UPDATE, DELETE) operationsreadonly=1 setting to prevent data modificationsCLICKHOUSE_ALLOW_DROP: Allow destructive operations (DROP TABLE, DROP DATABASE, DROP VIEW, DROP DICTIONARY, TRUNCATE TABLE)"false"CLICKHOUSE_ALLOW_WRITE_ACCESS=true is also set"true" to explicitly allow destructive DROP and TRUNCATE operationsMCP_MIDDLEWARE_MODULE: Python module name containing custom middleware to inject into the MCP server.py extension) of your middleware modulesetup_middleware(mcp) functionCHDB_ENABLED: Enable/disable chDB functionality"false""true" to enable chDB toolsmcp-clickhouse[chdb]CHDB_DATA_PATH: The path to the chDB data directory":memory:" (in-memory database):memory: for in-memory database/path/to/chdb/data)For local development with Docker:
# Required variables
CLICKHOUSE_HOST=localhost
CLICKHOUSE_USER=default
CLICKHOUSE_PASSWORD=clickhouse
# Optional: Override defaults for local development
CLICKHOUSE_SECURE=false # Uses port 8123 automatically
CLICKHOUSE_VERIFY=false
For ClickHouse Cloud:
# Required variables
CLICKHOUSE_HOST=your-instance.clickhouse.cloud
CLICKHOUSE_USER=default
CLICKHOUSE_PASSWORD=your-password
# Optional: These use secure defaults
# CLICKHOUSE_SECURE=true # Uses port 8443 automatically
# CLICKHOUSE_DATABASE=your_database
For ClickHouse SQL Playground:
CLICKHOUSE_HOST=sql-clickhouse.clickhouse.com
CLICKHOUSE_USER=demo
CLICKHOUSE_PASSWORD=
# Uses secure defaults (HTTPS on port 8443)
For chDB only (in-memory):
# chDB configuration
CHDB_ENABLED=true
CLICKHOUSE_ENABLED=false
# CHDB_DATA_PATH defaults to :memory:
For chDB with persistent storage:
# chDB configuration
CHDB_ENABLED=true
CLICKHOUSE_ENABLED=false
CHDB_DATA_PATH=/path/to/chdb/data
For MCP Inspector or remote access with HTTP transport:
CLICKHOUSE_HOST=localhost
CLICKHOUSE_USER=default
CLICKHOUSE_PASSWORD=clickhouse
CLICKHOUSE_MCP_SERVER_TRANSPORT=http
CLICKHOUSE_MCP_BIND_HOST=0.0.0.0 # Bind to all interfaces
CLICKHOUSE_MCP_BIND_PORT=4200 # Custom port (default: 8000)
CLICKHOUSE_MCP_AUTH_TOKEN=your-generated-token # One auth mode required for HTTP/SSE (or FASTMCP_SERVER_AUTH, or CLICKHOUSE_MCP_AUTH_DISABLED=true)
For local development with HTTP transport (authentication disabled):
CLICKHOUSE_HOST=localhost
CLICKHOUSE_USER=default
CLICKHOUSE_PASSWORD=clickhouse
CLICKHOUSE_MCP_SERVER_TRANSPORT=http
CLICKHOUSE_MCP_AUTH_DISABLED=true # Only for local development!
When using HTTP transport, the server will run on the configured port (default 8000). For example, with the above configuration:
http://localhost:4200/mcphttp://localhost:4200/healthYou can set these variables in your environment, in a .env file, or in the Claude Desktop configuration:
{
"mcpServers": {
"mcp-clickhouse": {
"command": "uv",
"args": [
"run",
"--with",
"mcp-clickhouse",
"--python",
"3.10",
"mcp-clickhouse"
],
"env": {
"CLICKHOUSE_HOST": "<clickhouse-host>",
"CLICKHOUSE_USER": "<clickhouse-user>",
"CLICKHOUSE_PASSWORD": "<clickhouse-password>",
"CLICKHOUSE_DATABASE": "<optional-database>",
"CLICKHOUSE_MCP_SERVER_TRANSPORT": "stdio",
"CLICKHOUSE_MCP_BIND_HOST": "127.0.0.1",
"CLICKHOUSE_MCP_BIND_PORT": "8000"
}
}
}
}
Note: The bind host and port settings are only used when transport is set to "http" or "sse".
uv sync --all-extras --dev # install dev dependencies
uv run ruff check . # run linting
docker compose up -d test_services # start ClickHouse
uv run pytest -v tests
uv run pytest -v tests/test_tool.py # ClickHouse only
CHDB_ENABLED=true uv run --extra chdb pytest -v tests/test_chdb_tool.py # chDB only
Добавь это в claude_desktop_config.json и перезапусти Claude Desktop.
{
"mcpServers": {
"clickhouse-mcp-clickhouse": {
"command": "npx",
"args": []
}
}
}