Skip to content

example prompt and skill for clickstack onboarding#6367

Merged
gingerwizard merged 1 commit into
mainfrom
prompt-widget
Jun 10, 2026
Merged

example prompt and skill for clickstack onboarding#6367
gingerwizard merged 1 commit into
mainfrom
prompt-widget

Conversation

@gingerwizard

@gingerwizard gingerwizard commented Jun 10, 2026

Copy link
Copy Markdown
Collaborator

Summary

This is an example skill that we're going to use during our onboarding for ClickStack. The skill is exposed through a widget in the UI where the user can just simply copy the prompt to pull the skill.

Example at:

/use-cases/observability/clickstack/setting-up-your-opentelemetry-collector

Checklist


Note

Low Risk
Documentation and front-end UI only; no runtime auth or ingestion code changes in the site itself.

Overview
Adds agent-assisted ClickStack OTel onboarding: a new AgentPrompt MDX callout (copyable prompt, short description, expandable step outline) and wires it into the OpenTelemetry collector setup guide so readers can paste a prompt that fetches the hosted skill.

Also publishes static/skills/clickstack-otel-collector/SKILL.md, a step-by-step agent playbook (via clickhousectl, Docker collector, otelgen, and ingestion checks) aligned with the manual guide, and registers AgentPrompt in MDXComponents.js for reuse on other pages.

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

@gingerwizard gingerwizard requested a review from a team as a code owner June 10, 2026 10:50
@vercel

vercel Bot commented Jun 10, 2026

Copy link
Copy Markdown

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

Project Deployment Actions Updated (UTC)
clickhouse-docs Ready Ready Preview, Comment Jun 10, 2026 11:04am
4 Skipped Deployments
Project Deployment Actions Updated (UTC)
clickhouse-docs-jp Ignored Ignored Jun 10, 2026 11:04am
clickhouse-docs-ko Ignored Ignored Jun 10, 2026 11:04am
clickhouse-docs-ru Ignored Ignored Jun 10, 2026 11:04am
clickhouse-docs-zh Ignored Ignored Jun 10, 2026 11:04am

Request Review

@gingerwizard gingerwizard requested a review from Blargian June 10, 2026 10:52

@cursor cursor Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Cursor Bugbot has reviewed your changes using default effort and found 3 potential issues.

Fix All in Cursor

❌ Bugbot Autofix is OFF. To automatically fix reported issues with cloud agents, have a team admin enable autofix in the Cursor dashboard.

Reviewed by Cursor Bugbot for commit 889943e. Configure here.

Note: `port` in the JSON is a number that may serialize as a float (`8443.0`). Coerce it to an integer when building the URL — for example with `jq`:

```bash
HTTPS_ENDPOINT=$(jq -r '.endpoints[] | select(.protocol=="https") | "https://\(.host):\(.port | tonumber | floor)"' /tmp/svc.json)

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

jq reads missing svc.json file

High Severity

Step 3 builds CLICKHOUSE_ENDPOINT with jq against /tmp/svc.json, but the preceding clickhousectl cloud service get example only prints JSON and never writes that path. Agents that follow the snippet literally fail endpoint extraction and cannot configure the collector.

Additional Locations (1)
Fix in Cursor Fix in Web

Reviewed by Cursor Bugbot for commit 889943e. Configure here.

-p 4317:4317 \
-p 4318:4318 \
clickhouse/clickstack-otel-collector:latest
```

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

docker run ignores existing container

Medium Severity

Step 5 always runs docker run with the fixed name clickstack-otel-collector. If that container already exists from an earlier attempt, Docker rejects the command and the skill stops even though later steps already describe docker stop/docker start for the same name.

Fix in Cursor Fix in Web

Reviewed by Cursor Bugbot for commit 889943e. Configure here.

window.setTimeout(() => setCopied(false), 2000);
} catch {
/* swallow — fallback already attempted */
}

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Clipboard failure skips textarea fallback

Low Severity

handleCopy only uses the textarea/execCommand path when the Clipboard API is absent. If navigator.clipboard.writeText exists but throws (permissions, policy, or transient errors), the catch block exits with no fallback and the UI never shows success—so the copy widget can fail silently on the primary action.

Fix in Cursor Fix in Web

Reviewed by Cursor Bugbot for commit 889943e. Configure here.

@gingerwizard gingerwizard merged commit b10beba into main Jun 10, 2026
19 checks passed
@mintlify

mintlify Bot commented Jun 10, 2026

Copy link
Copy Markdown

Docs PR opened: ClickHouse/mintlify-docs-dev#168

Added a new ClickStack OpenTelemetry collector skill playbook for AI agents to the Mintlify skills directory.

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.

2 participants