ClickHouse MCP server for AI agents

The ClickHouse MCP Server provides an interface to interact with your ClickHouse database through a Model Context Protocol server. It allows you to execute select queries, list databases, and explore tables in your ClickHouse cluster.

Installation

To set up the ClickHouse MCP Server, follow these steps:

Install dependencies using uv:
```
uv sync
source .venv/bin/activate
```
To install uv, follow the instructions at docs.astral.sh/uv/

Create a .env.production file with your ClickHouse credentials:

CLICKHOUSE_HOST=<CLICKHOUSE_HOST>
CLICKHOUSE_PORT=<CLICKHOUSE_PORT>
CLICKHOUSE_USER=<CLICKHOUSE_USER>
CLICKHOUSE_PASSWORD=<CLICKHOUSE_PASSWORD>

Install the MCP server:

fastmcp install mcp_clickhouse/mcp_server.py -f .env.production

Restart Claude Desktop to apply changes

Usage

The ClickHouse MCP Server provides several tools to interact with your ClickHouse database:

Running SQL Queries

You can execute read-only SQL queries on your ClickHouse cluster:

run_select_query("SELECT * FROM system.tables LIMIT 10")

Note: For safety, all queries run with readonly = 1 parameter

Listing Databases

To see all available databases in your ClickHouse cluster:

list_databases()

Exploring Tables

To list all tables within a specific database:

list_tables("your_database_name")

Replace your_database_name with the actual database you want to explore.

Troubleshooting

If you encounter connection issues:

Verify your credentials in the .env.production file
Ensure your ClickHouse server is accessible from your machine
Check for any network restrictions that might block the connection

For other issues, try reinstalling the MCP server or restarting Claude Desktop.

How to install this MCP server

For Claude Code

To add this MCP server to Claude Code, run this command in your terminal:

claude mcp add-json "clickhouse" '{"command":"python","args":["-m","mcp_clickhouse.mcp_server"]}'

See the official Claude Code MCP documentation for more details.

For Cursor

There are two ways to add an MCP server to Cursor. The most common way is to add the server globally in the ~/.cursor/mcp.json file so that it is available in all of your projects.

If you only need the server in a single project, you can add it to the project instead by creating or adding it to the .cursor/mcp.json file.

Adding an MCP server to Cursor globally

To add a global MCP server go to Cursor Settings > Tools & Integrations and click "New MCP Server".

When you click that button the ~/.cursor/mcp.json file will be opened and you can add your server like this:

{
    "mcpServers": {
        "clickhouse": {
            "command": "python",
            "args": [
                "-m",
                "mcp_clickhouse.mcp_server"
            ]
        }
    }
}

Adding an MCP server to a project

To add an MCP server to a project you can create a new .cursor/mcp.json file or add it to the existing one. This will look exactly the same as the global MCP server example above.

How to use the MCP server

Once the server is installed, you might need to head back to Settings > MCP and click the refresh button.

The Cursor agent will then be able to see the available tools the added MCP server has available and will call them when it needs to.

You can also explicitly ask the agent to use the tool by mentioning the tool name and describing what the function does.

For Claude Desktop

To add this MCP server to Claude Desktop:

1. Find your configuration file:

macOS: ~/Library/Application Support/Claude/claude_desktop_config.json
Windows: %APPDATA%\Claude\claude_desktop_config.json
Linux: ~/.config/Claude/claude_desktop_config.json

2. Add this to your configuration file:

{
    "mcpServers": {
        "clickhouse": {
            "command": "python",
            "args": [
                "-m",
                "mcp_clickhouse.mcp_server"
            ]
        }
    }
}

3. Restart Claude Desktop for the changes to take effect