Servidor MCP de Clickhouse

Un proyecto de servidor MCP de base de datos de Clickhouse.

Instalación

Puedes instalar el paquete usando uv :

uv pip install clickhouse-mcp-server

O usando pip :

pip install clickhouse-mcp-server

Related MCP server: ClickUp MCP Sedrver

Componentes

Herramientas

El servidor proporciona dos herramientas:

• connect_database : se conecta a una base de datos específica de Clickhouse

  • parámetro database : Nombre de la base de datos a la que conectarse (cadena)

  • Devuelve un mensaje de confirmación cuando la conexión es exitosa

• execute_query : ejecuta consultas de Clickhouse

  • parámetro query : consulta/consultas SQL a ejecutar (cadena)

  • Devuelve los resultados de la consulta en formato JSON

  • Se pueden enviar múltiples consultas separadas por punto y coma

Configuración

El servidor utiliza las siguientes variables de entorno:

• CLICKHOUSE_HOST : Dirección del servidor de Clickhouse (predeterminado: "localhost")

• CLICKHOUSE_USER : Nombre de usuario de Clickhouse (predeterminado: "root")

• CLICKHOUSE_PASSWORD : Contraseña de Clickhouse (predeterminada: "")

• CLICKHOUSE_DATABASE : Base de datos inicial (opcional)

• CLICKHOUSE_READONLY : modo de solo lectura (establecido en 1/verdadero para habilitar, predeterminado: falso)

Inicio rápido

Instalación

Escritorio de Claude

MacOS: ~/Library/Application\ Support/Claude/claude_desktop_config.json

Ventanas: %APPDATA%/Claude/claude_desktop_config.json

{
  "mcpServers": {
    "clickhouse-mcp-server": {
      "command": "uv",
      "args": [
        "--directory",
        "/Users/burakdirin/Projects/clickhouse-mcp-server",
        "run",
        "clickhouse-mcp-server"
      ],
      "env": {
        "CLICKHOUSE_HOST": "localhost",
        "CLICKHOUSE_USER": "root",
        "CLICKHOUSE_PASSWORD": "password",
        "CLICKHOUSE_DATABASE": "[optional]",
        "CLICKHOUSE_READONLY": "true"
      }
    }
  }
}

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

Instalación mediante herrería

Para instalar automáticamente Clickhouse Database Integration Server para Claude Desktop a través de Smithery :

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

Desarrollo

Construcción y publicación

Para preparar el paquete para su distribución:

1. Sincronizar dependencias y actualizar archivo de bloqueo:

uv sync

2. Distribuciones de paquetes de compilación:

uv build

Esto creará distribuciones de origen y de rueda en el directorio dist/ .

3. Publicar en PyPI:

uv publish

Nota: Deberás configurar las credenciales de PyPI a través de variables de entorno o indicadores de comando:

• Token: --token o UV_PUBLISH_TOKEN

• O nombre de usuario/contraseña: --username / UV_PUBLISH_USERNAME y --password / UV_PUBLISH_PASSWORD

Depuración

Dado que los servidores MCP se ejecutan en stdio, la depuración puede ser complicada. Para una experiencia óptima, recomendamos usar el Inspector MCP .

Puede iniciar el Inspector MCP a través de npm con este comando:

npx @modelcontextprotocol/inspector uv --directory /Users/burakdirin/Projects/clickhouse-mcp-server run clickhouse-mcp-server

Al iniciarse, el Inspector mostrará una URL a la que podrá acceder en su navegador para comenzar a depurar.