ClickHouse MCP server

The ClickHouse MCP Server implements the Model Context Protocol for ClickHouse databases, enabling you to integrate your ClickHouse data with Large Language Models and AI applications. This server facilitates accessing database resources, retrieving schemas, and executing SELECT queries through the MCP protocol.

Requirements

• Python 3.10 or higher
• ClickHouse server

Installation

Setting Up the Server

1. Clone the repository:

   git clone https://github.com/ThomAub/clickhouse_mcp_server.git
   cd clickhouse_mcp_server
   

2. Install the required packages:

   uv sync --all-extras
   

3. Configure your ClickHouse connection by either:

   • Setting environment variables for your ClickHouse credentials
   • Updating the get_clickhouse_client function in server.py with your connection details

Usage

Starting the Server

To run the MCP server:

python clickhouse_mcp_server/server.py

The server will start and begin listening for MCP protocol requests from LLMs or other AI applications.

Server Capabilities

The server provides the following functionalities:

• Database and Table Listing: Discover available ClickHouse databases and tables as resources
• Schema Retrieval: Get detailed information about table structures
• Query Execution: Run SELECT queries against your ClickHouse databases
• Secure Communication: Communicate efficiently using the MCP protocol

Connecting to the Server

Once the server is running, AI applications that support the Model Context Protocol can connect to it to access your ClickHouse data. The specific connection configuration will depend on the client application you're using with the MCP server.

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":"python","args":["clickhouse_mcp_server/server.py"]}'

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": "python",
            "args": [
                "clickhouse_mcp_server/server.py"
            ]
        }
    }
}

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": "python",
            "args": [
                "clickhouse_mcp_server/server.py"
            ]
        }
    }
}

3. Restart Claude Desktop for the changes to take effect