Skip to content

docs(cloud): add ClickHouse Agents#6281

Open
graphaelli wants to merge 15 commits into
ClickHouse:mainfrom
graphaelli:add-clickhouse-agents
Open

docs(cloud): add ClickHouse Agents#6281
graphaelli wants to merge 15 commits into
ClickHouse:mainfrom
graphaelli:add-clickhouse-agents

Conversation

@graphaelli
Copy link
Copy Markdown
Member

@graphaelli graphaelli commented May 26, 2026

Add first pass of ClickHouse Agents docs under Cloud > Features > AI/ML,
positioned above the ClickHouse Assistant entry. Rename "ClickHouse
Assistant agent" to "ClickHouse Assistant" in the assistant page and
related guide title.


Note

Low Risk
Documentation-only changes with no runtime or security impact; verify Docusaurus category id paths match the 10_AI_ML folder layout if the site build fails.

Overview
Adds a new ClickHouse Agents (Beta) documentation section under Cloud AI/ML, listed above ClickHouse Assistant on the AI/ML overview. The section includes overview, quickstart, chat, prompts, memory, marketplace, sharing/access, and an Agent Builder subtree (model parameters, code interpreter, web search, image generation, vision, MCP servers, skills, subagents).

Renames ClickHouse Assistant agent to ClickHouse Assistant on the assistant feature page (sidebar/title/position) and aligns the semantic-layer guide title. Updates styles/ClickHouse/Headings.yml with ClickHouse Agents and Agent Builder capitalization exceptions.

Reviewed by Cursor Bugbot for commit d840b20. Bugbot is set up for automated code reviews on this repo. Configure here.

graphaelli and others added 15 commits May 26, 2026 10:51
Add a beta stub page for ClickHouse Agents under Cloud > Features > AI/ML,
positioned above the ClickHouse Assistant entry. Rename "ClickHouse
Assistant agent" to "ClickHouse Assistant" in the assistant page and
related guide title.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Convert the single-file Agents stub into a sub-directory under Cloud >
Features > AI/ML with overview, quickstart, chat, and Agent Builder
(file search, code interpreter, web search, image generation, vision,
voice, actions, MCP servers, skills, subagents), plus presets, prompts,
memory, marketplace, semantic layer, and sharing/access pages. Each page
carries a BetaBadge and a placeholder describing its intended content.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Presets in LibreChat are saved templates of model parameter
configurations. "Model parameters" is the clearer page name for a docs
reader; the save-as-preset feature is described as a sub-capability
within the page.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Per the deployed Cloud UI: actions, file search, and voice aren't
surfaced in the Agent Builder. Remove their pages and the builder index
references. The underlying capabilities exist in the LibreChat code but
are gated off by the CHC deployment config.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Model parameters are an agent-level configuration, so the page belongs
inside the builder sub-section rather than at the top of the Agents
section. Slug updated to /cloud/features/ai-ml/agents/builder/model-parameters
and both index pages refreshed.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Add multi-conversation (parallel conversations for side-by-side
response comparison) to the chat page's intent placeholder and
keywords. The feature is enabled for Agents endpoints.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Replace stub placeholders with substantive content for the top-level
agents pages: feature overview with what-you-can-do summary,
quickstart walkthrough covering create + attach tools + run, and chat
page covering conversations, bookmarks, forking, multi-conversation,
and sharing.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Replace stub placeholders with substantive content for builder overview,
model parameters (including presets), code interpreter, web search,
image generation, and vision.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Replace stubs with substantive content: MCP server attachment and auth
patterns, skill anatomy and invocation modes, subagent delegation and
limits.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
…ing pages

Replace stubs with substantive content: memory store and per-conversation
toggle, marketplace browsing and publication, prompt library and variables,
AGENTS.md semantic layer with best practices and examples, and the roles +
resource ACL permission model.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
The AGENTS.md loader lives in control-plane's GPT agent
(apps/console-api/src/lib/gpt/agent/utils/agentsMd.ts) and is wired
into the SQL Console AI Chat — not into the LibreChat-based ClickHouse
Agents product in librechat-private. The semantic-layer page and all
references in agents/, builder/, quickstart, memory, and skills pages
are removed until/unless that integration is added.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Restructure to mirror the Model Parameters panel's actual sections and
controls. Add the previously missing knobs (Max Context Tokens, File
Token Limit, Top K, Resend Files, Use Prompt Caching, Thinking,
Thinking Budget, Effort, Thought Visibility, Web Search, Reset).
Disambiguate the provider-native Web Search toggle from the agent
Web search tool. Drop the Presets section — that affordance isn't in
this panel.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Replace the upstream-LibreChat polyglot list with the empirical set
actually available in the CHC sandbox: Python 3, Node.js, Bash, sh,
AWK, sed, bc. The deployed code execution backend is more
Python-plus-Unix-shell than full multi-language.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
- Add explicit {#kebab-id} anchors to every H2+ heading
  (markdownlint custom-anchor-headings rule)
- Sentence-case the H2s in model-parameters.md
  (Vale ClickHouse.Headings rule)
- Rename quickstart page title to "Quickstart" to satisfy
  frontmatter sentence-casing
- Add "ClickHouse Agents" and "Agent Builder" to Headings.yml
  exceptions, mirroring the existing "ClickHouse Assistant" entry
- Reword one sentence in model-parameters.md to avoid an
  OxfordComma false positive

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@graphaelli graphaelli requested a review from a team as a code owner May 26, 2026 15:41
@vercel
Copy link
Copy Markdown

vercel Bot commented May 26, 2026

@graphaelli is attempting to deploy a commit to the ClickHouse Team on Vercel.

A member of the Team first needs to authorize it.

@vercel
Copy link
Copy Markdown

vercel Bot commented May 26, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
clickhouse-docs Ready Ready Preview May 26, 2026 5:44pm

Request Review

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant