docs(observability): document ClickStack MCP tools and authoring example - #6565
Closed
sankalpsthakur wants to merge 2 commits into
Closed
docs(observability): document ClickStack MCP tools and authoring example#6565sankalpsthakur wants to merge 2 commits into
sankalpsthakur wants to merge 2 commits into
Conversation
Expand the ClickStack MCP server page with the clickstack_* tool catalog, a dashboard + row-click authoring example, Codex CLI connection snippet, and a correction that multi-team context uses the x-hdx-team header (no team-listing tool). Fixes #6361
|
@sankalpsthakur is attempting to deploy a commit to the ClickHouse Team on Vercel. A member of the Team first needs to authorize it. |
|
|
3 tasks
Member
|
Hi @sankalpsthakur, we've migrated docs to a new platform and consolidated everything into ClickHouse/ClickHouse. I've ported over this PR to the other repo for you with ClickHouse/ClickHouse#113271. Please feel free to push commits to that branch as needed. Closing this one in favour of ClickHouse/ClickHouse#113271. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Fixes ClickHouse/ClickHouse#113308
The ClickStack MCP connection page already exists (from earlier PRs). This fills the remaining gaps from ClickHouse/ClickHouse#113308: the tools the server exposes, a short authoring example for dashboards with row-click drilldowns, and Codex CLI setup for OSS/BYOC.
Related docs work in the same ClickStack area: #6564 (number-tile color picker on dashboards).
What this adds
clickstack_*names and short descriptions (sources, query, dashboards including patch/search/tile, alerts, saved searches, traces)clickstack_query_tile)onClick(links to the existing row-click drilldowns guide)--bearer-token-env-var) for OSS/BYOCx-hdx-team(no team-listing MCP tool)Verification
Cross-checked against HyperDX/ClickStack source:
packages/api/src/mcp/mcpServer.ts— server nameclickstack, tool modules registeredpackages/api/src/mcp/tools/**— tool names such asclickstack_list_sources,clickstack_save_dashboard,clickstack_patch_dashboard,clickstack_search_dashboards,clickstack_get_dashboard_tile, …packages/api/src/mcp/tools/dashboards/schemas.ts—onClickdashboard target +expressionTemplatefiltersMCP.mdin hyperdxio/hyperdx for the tool catalog and Codex syntaxTest plan