본문으로 바로가기
본문으로 바로가기

Quickstart

Beta feature. Learn more.

Build a custom agent in the Cloud console and run a natural-language query against your service.

Prerequisites​

  • A ClickHouse Cloud service you can query.
  • The Create agent option in the Agent Builder. If it's missing, ask an org admin to grant agent creation via Admin Settings as detailed in sharing and access.

Build the agent​

Launch ClickHouse Agents​

From your Cloud service, click ClickHouse agents in the left sidebar to open the agents launchpad. Click Launch ClickHouse agents to open the Agent Builder.

Cloud service navigation with ClickHouse agents (Beta) selected, showing the launchpad with the Launch ClickHouse agents button

Create the agent​

In the Agent Builder, click Create New Agent at the top of the left panel. Fill in the core fields:

  • Name - a short identifier for your agent.
  • Description - a description of what the agent is for, which will be visible to teammates.
  • Category - a category for your agent. You can leave this as General unless your org has custom categories.
  • Instructions - the system prompt, which describe the agent's role, the questions it should answer, and any business rules it must follow.
  • Model - pick a model from the dropdown.
Agent Builder panel showing the Create New Agent dropdown, the form fields (Name, Description, Category, Instructions, Model), and the Capabilities section

Attach capabilities and tools​

The agent's capabilities and tools live in two places.

Capabilities in the main panel — first-party features like Run Code, Web Search, File Context, Artifacts, MCP Servers, and Skills. Toggle the ones the agent needs.

Capabilities section of the Agent Builder panel showing Run Code, Web Search, File Context, Artifacts, MCP Servers, and Skills toggles

Tools behind the Add Tools button at the bottom of the panel — third-party integrations like image generation, vision, search APIs, and external services.

Bottom of the Agent Builder panel with the Add Tools button highlighted

Click Add Tools to browse the catalog:

Agent Tools modal showing a grid of third-party integrations including Google, OpenAI Image Tools, Wolfram, DALL-E-3, Tavily Search, Calculator, and Stable Diffusion

Subagents are configured under Advanced settings — see the subagents page for details.

You can change attached capabilities and tools any time.

Run a query​

Save the agent, open a new conversation, and select your agent from the agent picker. Type a question — for example, "What are my top 10 tables by row count this week?" — and the agent plans, calls tools as needed, and returns an answer.

Chat exchange showing the question 'What are my top 10 tables by row count this week?' and the agent's response — a Markdown table ranking the top 10 tables across services by row count, with Key Observations below

Next steps​