ClickHouse MCP server for AI agents

This MCP server allows Claude to connect to and query Clickhouse databases. It provides a bridge between Claude and your Clickhouse instance, enabling direct database interactions through natural language.

Installation

You can install the package using uv:

uv pip install clickhouse-mcp-server

Or using pip:

pip install clickhouse-mcp-server

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)

Server Capabilities

Available 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

Setting Up with Claude Desktop

Manual Configuration

To configure the MCP server in Claude Desktop:

Locate your Claude Desktop configuration file:
- MacOS: ~/Library/Application\ Support/Claude/claude_desktop_config.json
- Windows: %APPDATA%/Claude/claude_desktop_config.json
Add the following configuration to the file:

{
  "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"
      }
    }
  }
}

Update the environment variables with your specific Clickhouse connection details.

Installation via Smithery

For an automated setup with Claude Desktop:

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

Usage Examples

Connecting to a Database

To connect to a specific database:

In Claude, use the connect_database tool
Provide the database name as the parameter

Example:

Tool: connect_database
Parameter: my_database

Executing Queries

To run SQL queries against your Clickhouse database:

In Claude, use the execute_query tool
Provide the SQL query as the parameter

Example for a single query:

Tool: execute_query
Parameter: SELECT * FROM users LIMIT 10

Example for multiple queries:

Tool: execute_query
Parameter: USE analytics_db; SELECT count(*) FROM events WHERE date > '2023-01-01'

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-mcp-server" '{"command":"uvx","args":["clickhouse-mcp-server"],"env":{"CLICKHOUSE_HOST":"localhost","CLICKHOUSE_USER":"root","CLICKHOUSE_PASSWORD":"password","CLICKHOUSE_DATABASE":"[optional]","CLICKHOUSE_READONLY":"true"}}'

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-mcp-server": {
            "command": "uvx",
            "args": [
                "clickhouse-mcp-server"
            ],
            "env": {
                "CLICKHOUSE_HOST": "localhost",
                "CLICKHOUSE_USER": "root",
                "CLICKHOUSE_PASSWORD": "password",
                "CLICKHOUSE_DATABASE": "[optional]",
                "CLICKHOUSE_READONLY": "true"
            }
        }
    }
}

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-mcp-server": {
            "command": "uvx",
            "args": [
                "clickhouse-mcp-server"
            ],
            "env": {
                "CLICKHOUSE_HOST": "localhost",
                "CLICKHOUSE_USER": "root",
                "CLICKHOUSE_PASSWORD": "password",
                "CLICKHOUSE_DATABASE": "[optional]",
                "CLICKHOUSE_READONLY": "true"
            }
        }
    }
}

3. Restart Claude Desktop for the changes to take effect