docs: add ClickHouse chat agent example project page

[matt-aitken]

What

Adds a new Example projects page: ClickHouse chat agent — a chat.agent() that answers questions about your data by writing and running SQL against ClickHouse Cloud via the official Node.js ClickHouse client.

The page follows the existing example-project format (overview, features, GitHub repo card, how-it-works with code excerpts, relevant code links) and is registered in docs.json in alphabetical order.

Note

The GitHub repo card links to triggerdotdev/examples/tree/main/clickhouse-chat-agent, which lands in a companion examples PR — merge that one first.

🤖 Generated with Claude Code

[changeset-bot]

⚠️ No Changeset found

Latest commit: 20d7a1c

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

[coderabbitai]

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: Repository UI

Review profile: CHILL

Plan: Pro

Run ID: 5a21fb68-4498-4d11-b629-29372e22f4b7

📥 Commits

Reviewing files that changed from the base of the PR and between e0208f3 and 20d7a1c.

📒 Files selected for processing (2)

• docs/docs.json
• docs/guides/example-projects/clickhouse-chat-agent.mdx

📜 Recent review details

⏰ Context from checks skipped due to timeout. (2)

• GitHub Check: code-quality / code-quality
• GitHub Check: Analyze (javascript-typescript)

🧰 Additional context used

📓 Path-based instructions (2)

docs/**/docs.json

📄 CodeRabbit inference engine (docs/CLAUDE.md)

docs/**/docs.json: Main documentation config must be defined in docs.json which includes navigation structure, theme, and metadata
Navigation structure in docs.json should be organized using navigation.dropdowns with groups and pages

Files:

• docs/docs.json

docs/**/*.mdx

📄 CodeRabbit inference engine (docs/CLAUDE.md)

docs/**/*.mdx: MDX documentation pages must include frontmatter with title (required), description (required), and sidebarTitle (optional) in YAML format
Use Mintlify components for structured content: , , , , , , /, /
Always import from @trigger.dev/sdk in code examples (never from @trigger.dev/sdk/v3)
Code examples must be complete and runnable where possible
Use language tags in code fences: typescript, bash, json

Files:

• docs/guides/example-projects/clickhouse-chat-agent.mdx

🧠 Learnings (2)

📚 Learning: 2026-03-10T12:44:14.176Z

Learnt from: nicktrn
Repo: triggerdotdev/trigger.dev PR: 3200
File: docs/config/config-file.mdx:353-368
Timestamp: 2026-03-10T12:44:14.176Z
Learning: In the trigger.dev repo, docs PRs are often companions to implementation PRs. When reviewing docs PRs (MDX files under docs/), check the PR description for any companion/related PR references and verify that the documented features exist in those companion PRs before flagging missing implementations. This ensures docs stay in sync with code changes across related PRs.

Applied to files:

• docs/guides/example-projects/clickhouse-chat-agent.mdx

📚 Learning: 2026-04-30T20:30:29.458Z

Learnt from: ericallam
Repo: triggerdotdev/trigger.dev PR: 3226
File: docs/ai-chat/quick-start.mdx:13-13
Timestamp: 2026-04-30T20:30:29.458Z
Learning: In this repo’s documentation MDX files (`docs/**/*.mdx`), use `ts` and `tsx` (not `typescript`) as the code-fence language tags for TypeScript/TSX snippets. Do not flag `ts`/`tsx` code-fence language tags as incorrect in any docs MDX file, since this is the site-wide Mintlify-compatible convention.

Applied to files:

• docs/guides/example-projects/clickhouse-chat-agent.mdx

🪛 LanguageTool

docs/guides/example-projects/clickhouse-chat-agent.mdx

[uncategorized] ~9-~9: Did you mean the formatting language “Markdown” (= proper noun)?
Context: ...ascript), and streams back answers with markdown tables. Trigger.dev handles the chat se...

(MARKDOWN_NNP)

---

[uncategorized] ~67-~67: Did you mean the formatting language “Markdown” (= proper noun)?
Context: ...er aggregations, and present results as markdown tables. ### The query tool runQuery...

(MARKDOWN_NNP)

---

[uncategorized] ~125-~125: Did you mean the formatting language “Markdown” (= proper noun)?
Context: ...call, a SQL aggregation, and a streamed markdown table of results. ## Relevant code - ...

(MARKDOWN_NNP)

🔇 Additional comments (2)

docs/guides/example-projects/clickhouse-chat-agent.mdx (1)

1-142: LGTM!

docs/docs.json (1)

521-521: LGTM!

---

Walkthrough

This PR adds a new documentation guide page at docs/guides/example-projects/clickhouse-chat-agent.mdx describing a ClickHouse Cloud chat agent example, including schema discovery, SQL generation, read-only query enforcement, error handling, and environment configuration via CLICKHOUSE_URL. It also updates docs/docs.json to add a navigation entry for this new guide in the "Guides & examples" / "Example projects" section.

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
Description check	⚠️ Warning	The description covers the new page, but it omits most required template sections like issue closure, checklist, testing, changelog, and screenshots.	Add the missing template sections: Closes #issue, checklist items, testing steps, changelog, and screenshots (or note if not applicable).

✅ Passed checks (4 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title is concise and accurately describes the new ClickHouse chat agent example page.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Commit unit tests in branch docs/clickhouse-chat-agent-example

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands.}

[devin-ai-integration]

✅ Devin Review: No Issues Found

Devin Review analyzed this PR and found no bugs or issues to report.