# ClickHouse

```json
{
  "name": "ClickHouse",
  "slug": "clickhouse",
  "url": "https://composio.dev/toolkits/clickhouse",
  "markdown_url": "https://composio.dev/toolkits/clickhouse.md",
  "logo_url": "https://logos.composio.dev/api/clickhouse",
  "categories": [
    "analytics & data"
  ],
  "is_composio_managed": false,
  "updated_at": "2026-10-04T14:16:26.669Z"
}
```

![ClickHouse logo](https://logos.composio.dev/api/clickhouse)

## Description

Securely connect your AI agents and chatbots (Claude, ChatGPT, Cursor, etc) with ClickHouse MCP or direct API to run SQL queries, fetch analytics, insert new records, and summarize big data through natural language.

## Summary

ClickHouse is an open-source, column-oriented database for real-time analytics and big data processing using SQL. Its lightning-fast query performance makes it ideal for handling large datasets and delivering instant insights.

## Categories

- analytics & data

## Toolkit Details

- Tools: 6

## Images

- Logo: https://logos.composio.dev/api/clickhouse

## Authentication

- **Basic**
  - Type: `basic_auth`
  - Description: Basic authentication for ClickHouse.
  - Setup:
    - Configure Basic credentials for ClickHouse.
    - Use the credentials when creating an auth config in Composio.

## Suggested Prompts

- Show total user signups for last week
- Summarize top 5 products by revenue
- Insert a new sales record into database

## Supported Tools

| Tool slug | Name | Description |
|---|---|---|
| `CLICKHOUSE_EXECUTE_QUERY` | Execute ClickHouse Query | Execute a SQL query in ClickHouse and return the results. This is the primary action for querying data from ClickHouse databases. |
| `CLICKHOUSE_GET_DATABASE_SCHEMA` | Get Database Schema | Get comprehensive schema overview of an entire database including all tables and optionally their column definitions. Essential for AI agents to understand the complete database structure in a single call. |
| `CLICKHOUSE_GET_PLAY_INTERFACE` | Get ClickHouse Play Interface | Get the ClickHouse Play web user interface for interactive query execution. Returns HTML page with Monaco Editor for writing queries and visualizing results. |
| `CLICKHOUSE_GET_TABLE_SCHEMA` | Get Table Schema | Get detailed schema information for a specific table including column definitions, types, keys, and optionally sample data. This is essential for AI agents to understand table structure before constructing queries. |
| `CLICKHOUSE_LIST_DATABASES` | List ClickHouse Databases | List all databases in the ClickHouse instance. Useful for discovering available databases before querying tables. |
| `CLICKHOUSE_LIST_TABLES` | List ClickHouse Tables | List tables in ClickHouse databases. Returns information about tables including their engine, size, and row count. |

## Supported Triggers

None listed.

## Installation and MCP Setup

### Path 1: SDK Installation

#### Path 1, Step 1: Install Composio

Install the Composio SDK, the OpenAI provider, and the OpenAI SDK
```python
pip install composio composio_openai openai
```

```typescript
npm install @composio/core @composio/openai openai
```

#### Path 1, Step 2: Create a Composio session

Initialize Composio with the OpenAI Responses provider and create a session scoped to ClickHouse
```python
import json
from openai import OpenAI
from composio import Composio
from composio_openai import OpenAIResponsesProvider

composio = Composio(provider=OpenAIResponsesProvider())
client = OpenAI()

session = composio.create(user_id="your-user-id", toolkits=["clickhouse"])
tools = session.tools()
```

```typescript
import OpenAI from "openai";
import { Composio } from "@composio/core";
import { OpenAIResponsesProvider } from "@composio/openai";

const composio = new Composio({ provider: new OpenAIResponsesProvider() });
const client = new OpenAI();

const session = await composio.create("your-user-id", { toolkits: ["clickhouse"] });
const tools = await session.tools();
```

#### Path 1, Step 3: Run ClickHouse tools with your agent

Send a request, execute the ClickHouse tool calls through the session, and print the final answer
```python
response = client.responses.create(
    model="gpt-5.6-sol",
    tools=tools,
    input=[{"role": "user", "content": "Get the top 10 products by sales from ClickHouse."}],
)

while True:
    tool_calls = [o for o in response.output if o.type == "function_call"]
    if not tool_calls:
        break
    results = composio.provider.handle_tool_calls(response=response, session=session)
    response = client.responses.create(
        model="gpt-5.6-sol",
        tools=tools,
        previous_response_id=response.id,
        input=[
            {"type": "function_call_output", "call_id": call.call_id, "output": json.dumps(results[i])}
            for i, call in enumerate(tool_calls)
        ],
    )

print(response.output_text)
```

```typescript
let response = await client.responses.create({
  model: "gpt-5.6-sol",
  tools,
  input: [{ role: "user", content: "Get the top 10 products by sales from ClickHouse." }],
});

while (response.output.some((o) => o.type === "function_call")) {
  const outputs = await composio.provider.handleToolCalls(session, response.output);
  response = await client.responses.create({
    model: "gpt-5.6-sol",
    tools,
    previous_response_id: response.id,
    input: outputs,
  });
}

console.log(response.output_text);
```

### Path 2: MCP Server Setup

#### Path 2, Step 1: Install Composio

Install the Composio SDK and your agent framework
```python
pip install composio claude-agent-sdk
```

```typescript
npm install @composio/core ai @ai-sdk/mcp @ai-sdk/openai
```

#### Path 2, Step 2: Create a session with MCP enabled

Create a session scoped to ClickHouse and read its MCP URL and headers
```python
from composio import Composio

composio = Composio()
session = composio.create(user_id="your-user-id", toolkits=["clickhouse"], mcp=True)
```

```typescript
import { Composio } from "@composio/core";

const composio = new Composio();
const { mcp } = await composio.create("your-user-id", {
  toolkits: ["clickhouse"],
  mcp: true,
});
```

#### Path 2, Step 3: Connect your agent to the MCP server

Pass the session's MCP URL and headers to your agent and run a ClickHouse request
```python
import asyncio
from claude_agent_sdk import ClaudeSDKClient, ClaudeAgentOptions, AssistantMessage, TextBlock

options = ClaudeAgentOptions(
    mcp_servers={
        "composio": {
            "type": "http",
            "url": session.mcp.url,
            "headers": session.mcp.headers,
        }
    },
    system_prompt="You are a helpful assistant with access to ClickHouse tools.",
    tools=[],
    allowed_tools=["mcp__composio__*"],
)

async def main():
    async with ClaudeSDKClient(options=options) as client:
        await client.query("Get the top 10 products by sales from ClickHouse.")
        async for message in client.receive_response():
            if isinstance(message, AssistantMessage):
                for block in message.content:
                    if isinstance(block, TextBlock):
                        print(block.text)

asyncio.run(main())
```

```typescript
import { createMCPClient } from "@ai-sdk/mcp";
import { openai } from "@ai-sdk/openai";
import { generateText, stepCountIs } from "ai";

const client = await createMCPClient({
  transport: { type: "http", url: mcp.url, headers: mcp.headers },
});

const { text } = await generateText({
  model: openai("gpt-5.6-sol"),
  tools: await client.tools(),
  prompt: "Get the top 10 products by sales from ClickHouse.",
  stopWhen: stepCountIs(10),
});

console.log(text);
await client.close();
```

## Why Use Composio?

### 1. AI Native ClickHouse Integration

- Supports both ClickHouse MCP and direct API based integrations
- Structured, LLM-friendly schemas for reliable tool execution
- Rich coverage for reading, writing, and querying your ClickHouse data

### 2. Managed Auth

- Built-in OAuth handling with automatic token refresh and rotation
- Central place to manage, scope, and revoke ClickHouse access
- Per user and per environment credentials instead of hard-coded keys

### 3. Agent Optimized Design

- Tools are tuned using real error and success rates to improve reliability over time
- Comprehensive execution logs so you always know what ran, when, and on whose behalf

### 4. Enterprise Grade Security

- Fine-grained RBAC so you control which agents and users can access ClickHouse
- Scoped, least privilege access to ClickHouse resources
- Full audit trail of agent actions to support review and compliance

## Use ClickHouse with any AI Agent Framework

Choose a framework you want to connect ClickHouse with:

- [Claude Code](https://composio.dev/toolkits/clickhouse/framework/claude-code)
- [Cursor](https://composio.dev/toolkits/clickhouse/framework/cursor)
- [ChatGPT](https://composio.dev/toolkits/clickhouse/framework/chatgpt)
- [Claude Cowork](https://composio.dev/toolkits/clickhouse/framework/claude-cowork)
- [Antigravity](https://composio.dev/toolkits/clickhouse/framework/antigravity)
- [OpenAI Agents SDK](https://composio.dev/toolkits/clickhouse/framework/open-ai-agents-sdk)
- [Claude Agent SDK](https://composio.dev/toolkits/clickhouse/framework/claude-agents-sdk)
- [Codex](https://composio.dev/toolkits/clickhouse/framework/codex)
- [Grok Build](https://composio.dev/toolkits/clickhouse/framework/grok-build)
- [VS Code](https://composio.dev/toolkits/clickhouse/framework/vscode)
- [OpenCode](https://composio.dev/toolkits/clickhouse/framework/opencode)
- [OpenClaw](https://composio.dev/toolkits/clickhouse/framework/openclaw)
- [Hermes](https://composio.dev/toolkits/clickhouse/framework/hermes-agent)
- [Atomic Agent](https://composio.dev/toolkits/clickhouse/framework/atomic-agent)
- [Google ADK](https://composio.dev/toolkits/clickhouse/framework/google-adk)
- [LangChain](https://composio.dev/toolkits/clickhouse/framework/langchain)
- [Vercel AI SDK](https://composio.dev/toolkits/clickhouse/framework/ai-sdk)
- [Mastra AI](https://composio.dev/toolkits/clickhouse/framework/mastra-ai)
- [LlamaIndex](https://composio.dev/toolkits/clickhouse/framework/llama-index)
- [CrewAI](https://composio.dev/toolkits/clickhouse/framework/crew-ai)
- [Pydantic AI](https://composio.dev/toolkits/clickhouse/framework/pydantic-ai)
- [AutoGen](https://composio.dev/toolkits/clickhouse/framework/autogen)

## Related Toolkits

- [Firecrawl](https://composio.dev/toolkits/firecrawl) - Firecrawl automates large-scale web crawling and data extraction. It helps organizations efficiently gather, index, and analyze content from online sources.
- [Tavily](https://composio.dev/toolkits/tavily) - Tavily offers powerful search and data retrieval from documents, databases, and the web. It helps teams locate and filter information instantly, saving hours on research.
- [Exa](https://composio.dev/toolkits/exa) - Exa is a data extraction and search platform for gathering and analyzing information from websites, APIs, or databases. It helps teams quickly surface insights and automate data-driven workflows.
- [Serpapi](https://composio.dev/toolkits/serpapi) - SerpApi is a real-time API for structured search engine results. It lets you automate SERP data collection, parsing, and analysis for SEO and research.
- [Peopledatalabs](https://composio.dev/toolkits/peopledatalabs) - Peopledatalabs delivers B2B data enrichment and identity resolution APIs. Supercharge your apps with accurate, up-to-date business and contact data.
- [Snowflake](https://composio.dev/toolkits/snowflake) - Snowflake is a cloud data warehouse built for elastic scaling, secure data sharing, and fast SQL analytics across major clouds.
- [Posthog](https://composio.dev/toolkits/posthog) - PostHog is an open-source analytics platform for tracking user interactions and product metrics. It helps teams refine features, analyze funnels, and reduce churn with actionable insights.
- [Ahrefs MCP](https://composio.dev/toolkits/ahrefs_mcp) - Ahrefs MCP is Ahrefs' hosted MCP server for SEO data and insights. Use it to access backlinks, organic metrics, keyword research, and competitor analysis.
- [Akta](https://composio.dev/toolkits/akta) - Akta is a company intelligence platform providing enrichment, news, and alternative business signals. It helps teams build targeted company lists and enrich data-driven workflows.
- [Amplitude](https://composio.dev/toolkits/amplitude) - Amplitude is a digital analytics platform for product and behavioral data insights. It helps teams analyze user journeys and make data-driven decisions quickly.
- [Amplitude MCP](https://composio.dev/toolkits/amplitude_mcp) - Amplitude MCP is Amplitude's product analytics service for tracking user behavior and product metrics. Use it to centralize product data and manage charts, dashboards, cohorts, experiments, and taxonomy.
- [Audioscrape MCP](https://composio.dev/toolkits/audioscrape_mcp) - Audioscrape MCP lets agents search and retrieve speaker-attributed audio, transcripts, entities, and citations from public and workspace content. Use it to surface searchable, speaker-labeled audio and rich metadata for research, meetings, and content discovery.
- [Baremetrics](https://composio.dev/toolkits/baremetrics) - Baremetrics is a subscription analytics platform for recurring-revenue businesses. It helps teams track MRR, churn, customers, and revenue trends in one place.
- [Bing Webmaster Tools](https://composio.dev/toolkits/bing_webmaster_tools) - Bing Webmaster Tools is Microsoft's search console for site performance, crawling, indexing, URL submission, and verified site management. It helps site owners understand Bing Search visibility and fix issues that affect organic traffic.
- [Bread & Butter](https://composio.dev/toolkits/bread_butter) - Bread & Butter is a lead-intelligence and identity platform for website visitor tracking, user profiles, attribution, authentication, and conversion workflows. It helps teams understand who is visiting, where leads come from, and how users convert.
- [Bright Data MCP](https://composio.dev/toolkits/brightdata_mcp) - Bright Data MCP is an AI-powered web scraping and data collection platform. Instantly access public web data in real time with advanced scraping tools.
- [Browseai](https://composio.dev/toolkits/browseai) - Browseai is a web automation and data extraction platform that turns any website into an API. It's perfect for monitoring websites and retrieving structured data without manual scraping.
- [BSC Designer](https://composio.dev/toolkits/bsc_designer) - BSC Designer is a strategy execution platform for balanced scorecards, KPIs, dashboards, and strategy maps. It helps teams turn goals into measurable performance plans they can track over time.
- [Chameleon](https://composio.dev/toolkits/chameleon) - Chameleon is a product adoption platform for building in-app experiences, managing customer data, and analyzing user engagement. It helps teams improve onboarding, feature discovery, and product adoption with targeted user experiences.
- [Chartly](https://composio.dev/toolkits/chartly) - Chartly renders Chart.js configurations as PNG or SVG images and creates permanent chart URLs for sharing and embedding. Share and embed charts easily with stable image URLs and downloadable vector graphics.

## Frequently Asked Questions

### Do I need my own developer credentials to use ClickHouse with Composio?

Yes, ClickHouse requires you to configure your own Basic Auth credentials. Once set up, Composio handles secure credential storage and authentication for you.

### Can I use multiple toolkits together?

Yes! Composio's Tool Router enables agents to use multiple toolkits. [Learn more](https://docs.composio.dev/tool-router/overview).

### Is Composio secure?

Composio is SOC 2 and ISO 27001 compliant with all data encrypted in transit and at rest. [Learn more](https://trust.composio.dev).

### What if the API changes?

Composio maintains and updates all toolkit integrations automatically, so your agents always work with the latest API versions.

---
[See all toolkits](https://composio.dev/toolkits) · [Composio docs](https://docs.composio.dev/llms.txt)