Skip to content

Commit 36812b3

Browse files
Dgiordano33Dgiordano33
authored
Merge pull request #242 from checkly/giordanodaniel-ai-messaging-update
AI Messaging in Concepts and Sidebar
2 parents fd81902 + 6c219fe commit 36812b3

16 files changed

Lines changed: 1533 additions & 4016 deletions

File tree

‎.claude/skills/checkly/SKILL.md‎

Lines changed: 97 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,97 @@
1+
---
2+
name: checkly
3+
description: Set up, create, test and manage monitoring checks using the Checkly CLI. Use when working with API Checks, Browser Checks, URL Monitors, ICMP Monitors, Playwright Check Suites, Heartbeat Monitors, Alert Channels, Dashboards, or Status Pages.
4+
allowed-tools: Bash(npx:checkly:*) Bash(npm:install:*)
5+
metadata:
6+
author: checkly
7+
---
8+
9+
# Checkly
10+
11+
The Checkly CLI provides all the required information via the `npx checkly skills` command.
12+
13+
Use `npx checkly skills install` to install this skill into your project (supports Claude Code, Cursor, Codex and more).
14+
15+
Use `npx checkly skills` to list all available actions, and `npx checkly skills <action>` to access up-to-date information on how to use the Checkly CLI for each action.
16+
17+
## Progressive Disclosure via `npx checkly skills`
18+
19+
The skill is structured for efficient context usage:
20+
21+
1. **Metadata** (~80 tokens): Name and description in frontmatter
22+
2. **Core Instructions** (~1K tokens): Main SKILL.md content with links to reference commands
23+
3. **Reference Commands** (loaded on demand): Detailed construct documentation with examples
24+
25+
Agents load what they need for each task.
26+
27+
## Plan Awareness
28+
29+
Before configuring checks, run `npx checkly account plan --output json` to see what features, locations, and limits are available on the current plan. Disabled features include an `upgradeUrl` pointing to the self-service checkout page or the enterprise contact sales page — share these with the user when they need a feature that's not on their plan.
30+
31+
Run `npx checkly skills manage` for the full reference.
32+
33+
## Confirmation Protocol
34+
35+
Write commands (e.g. `incidents create`, `deploy`, `destroy`) return exit code 2 with a `confirmation_required` JSON envelope instead of executing. **Always present the `changes` to the user and wait for approval before running the `confirmCommand`.** Never auto-append `--force`. This applies to every write command individually — updates and resolutions need confirmation too, not just the initial create.
36+
37+
Run `npx checkly skills communicate` for the full protocol details.
38+
39+
### `npx checkly skills initialize`
40+
Learn how to initialize and set up a new Checkly CLI project from scratch.
41+
42+
### `npx checkly skills configure`
43+
Learn how to create and manage monitoring checks using Checkly constructs and the CLI.
44+
45+
#### `npx checkly skills configure api-checks`
46+
Api Check construct (`ApiCheck`), assertions, and authentication setup scripts
47+
48+
#### `npx checkly skills configure browser-checks`
49+
Browser Check construct (`BrowserCheck`) with Playwright test files
50+
51+
#### `npx checkly skills configure playwright-checks`
52+
Playwright Check Suite construct (`PlaywrightCheck`) for multi-browser test suites
53+
54+
#### `npx checkly skills configure multistep-checks`
55+
Multistep Check construct (`MultiStepCheck`) for complex user flows
56+
57+
#### `npx checkly skills configure tcp-monitors`
58+
TCP Monitor construct (`TcpMonitor`) with assertions
59+
60+
#### `npx checkly skills configure url-monitors`
61+
URL Monitor construct (`UrlMonitor`) with assertions
62+
63+
#### `npx checkly skills configure dns-monitors`
64+
DNS Monitor construct (`DnsMonitor`) with assertions
65+
66+
#### `npx checkly skills configure icmp-monitors`
67+
ICMP Monitor construct (`IcmpMonitor`) with latency and packet loss assertions
68+
69+
#### `npx checkly skills configure heartbeat-monitors`
70+
Heartbeat Monitor construct (`HeartbeatMonitor`)
71+
72+
#### `npx checkly skills configure check-groups`
73+
CheckGroupV2 construct (`CheckGroupV2`) for organizing checks
74+
75+
#### `npx checkly skills configure alert-channels`
76+
Email (`EmailAlertChannel`), Phone (`PhoneCallAlertChannel`), and Slack (`SlackAlertChannel`) alert channels
77+
78+
#### `npx checkly skills configure supporting-constructs`
79+
Status pages (`StatusPage`), dashboards (`Dashboard`), maintenance windows (`MaintenanceWindow`), and private locations (`PrivateLocation`)
80+
81+
### `npx checkly skills investigate`
82+
Access check status, analyze failures, and investigate errors.
83+
84+
#### `npx checkly skills investigate checks`
85+
Inspecting checks (`checks list`, `checks get`) and triggering on-demand runs
86+
87+
### `npx checkly skills communicate`
88+
Open incidents and lead customer communications via status pages.
89+
90+
#### `npx checkly skills communicate incidents`
91+
Incident lifecycle (`incidents create`, `update`, `resolve`, `list`) and status pages
92+
93+
### `npx checkly skills manage`
94+
Understand your account plan, entitlements, and feature limits.
95+
96+
#### `npx checkly skills manage plan`
97+
Check account plan, entitlements, feature limits, and available locations (`account plan`)

‎ai/overview.mdx‎

Lines changed: 90 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: 'AI Agents & Coding Assistants'
33
description: 'Use AI agents and coding assistants to create, update, and deploy your Checkly monitoring setup with skills and rules.'
4-
sidebarTitle: 'Overview'
4+
sidebarTitle: 'Agents & Checkly'
55
keywords: ['mcp', 'ai', 'rules', 'generate checks', 'agents', 'context']
66
---
77

@@ -74,3 +74,92 @@ Whether you need to configure your monitoring setup, access check data or declar
7474
<Tip>
7575
We are researching additional AI-native workflows. [Let us know in the public roadmap](https://feedback.checklyhq.com/p/checkly-mcp) if you are interested in more agent-friendly integrations.
7676
</Tip>
77+
78+
## Markdown access
79+
80+
Every page in the Checkly documentation is available as markdown. This makes it easy to feed specific documentation pages into AI assistants like Claude, ChatGPT, Cursor, or any other AI tool.
81+
82+
<Tip>
83+
Use [Checkly Skills](/ai/skills) to automatically provide your agent with up-to-date, agent-optimized documentation.
84+
</Tip>
85+
86+
### .md endpoints
87+
88+
Append `.md` to any documentation URL to get the markdown version of that page.
89+
90+
**Example:**
91+
92+
- **HTML:** `https://www.checklyhq.com/docs/what-is-checkly/`
93+
- **Markdown:** `https://www.checklyhq.com/docs/what-is-checkly.md`
94+
95+
The markdown version includes the full page content in plain markdown, code blocks, links preserved as markdown links, and tables formatted as markdown tables.
96+
97+
```bash
98+
# Fetch documentation content with curl
99+
curl https://www.checklyhq.com/docs/what-is-checkly.md
100+
101+
# Pipe directly to your clipboard
102+
curl https://www.checklyhq.com/docs/what-is-checkly.md | pbcopy
103+
```
104+
105+
### Content negotiation
106+
107+
You can also request markdown by setting the `Accept` header to `text/markdown`:
108+
109+
```bash
110+
curl -H "Accept: text/markdown" https://www.checklyhq.com/docs/what-is-checkly/
111+
```
112+
113+
This is useful when integrating with tools or scripts that set request headers programmatically.
114+
115+
<Tip>
116+
Modern coding agents set [these headers automatically when querying documentation](https://www.checklyhq.com/blog/state-of-ai-agent-content-negotation/).
117+
</Tip>
118+
119+
### Copy as Markdown button
120+
121+
Every documentation page includes a **Copy as Markdown** button at the top of the page. Click it to copy the full page content as markdown to your clipboard.
122+
123+
This is the fastest way to grab documentation for a specific topic and paste it into your AI assistant's context.
124+
125+
```text
126+
Here is the Checkly Browser Checks documentation:
127+
128+
[paste markdown content]
129+
130+
Based on this, how do I set up a browser check with a custom user agent?
131+
```
132+
133+
134+
## LLMs.txt
135+
136+
137+
The [llms.txt standard](https://llmstxt.org/) provides a machine-readable index of all available documentation pages. Checkly publishes an `llms.txt` file at [`checklyhq.com/llms.txt`](https://www.checklyhq.com/llms.txt) that lists every documentation page with its markdown URL and a short description.
138+
139+
```txt llms.txt (first 15 lines)
140+
# Checkly Docs
141+
142+
## Docs
143+
144+
- [Changing your email or password in Checkly](https://checklyhq.com/docs/admin/changing-your-email-password.md): Learn how to change your email address or password in your Checkly account
145+
- [Creating an API key in Checkly](https://checklyhq.com/docs/admin/creating-api-key.md): Learn how to create and manage user and service API keys for the Checkly API and CLI
146+
- [Adding team members to your Checkly account](https://checklyhq.com/docs/admin/team-management/adding-team-members.md): Learn how to invite team members to join your Checkly account and manage team collaboration
147+
- [Using Microsoft Entra ID for Single Sign-on in Checkly](https://checklyhq.com/docs/admin/team-management/microsoft-azure-ad.md): This page illustrates the standard procedure to follow in order to get started with Microsoft Entra ID SSO (formerly Azure AD) on Checkly.
148+
- [Multi-Factor Authentication in Checkly](https://checklyhq.com/docs/admin/team-management/multi-factor-authentication.md): Learn how to set up and manage multi-factor authentication for enhanced account security
149+
- [Using Okta for Single Sign-on in Checkly](https://checklyhq.com/docs/admin/team-management/okta.md): This page illustrates the standard procedure to follow in order to get started with Okta SSO on Checkly.
150+
- [Role Based Access Control in Checkly](https://checklyhq.com/docs/admin/team-management/rbac.md): Checkly roles and permissions for team members
151+
- [Removing team members from your Checkly account](https://checklyhq.com/docs/admin/team-management/removing-team-members.md): Learn how to remove team members from your Checkly account and understand how it affects your billing
152+
- [Using SAML for Single Sign-On in Checkly](https://checklyhq.com/docs/admin/team-management/saml-sso.md): Learn how to set up SAML-based SSO for your Checkly account with supported identity providers
153+
- [Using SCIM provisioning in Checkly](https://checklyhq.com/docs/admin/team-management/scim-provisioning.md): Learn how to set up SCIM provisioning for Checkly using your identity provider
154+
- [Team management in Checkly](https://checklyhq.com/docs/admin/team-management.md): Manage your team and collaborate effectively in Checkly
155+
```
156+
157+
Use the `llms.txt` file to crawl and index the entire Checkly documentation. Every link in the file points to [the `.md` version of the page](/ai/markdown-access#md-endpoints), so you can fetch each URL directly to get the markdown content.
158+
159+
```bash
160+
# Fetch the llms.txt index
161+
curl https://www.checklyhq.com/llms.txt
162+
163+
# Fetch a specific page from the index
164+
curl https://checklyhq.com/docs/detect/synthetic-monitoring/browser-checks/overview.md
165+
```

platform/rocky-ai.mdx renamed to ai/rocky-ai.mdx

Lines changed: 7 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -7,21 +7,16 @@ sidebarTitle: Rocky AI
77
Rocky AI is Checkly's AI agent. Rocky AI can help you automatically determine user impact and root cause on any failing
88
check using error messages, code, metrics, traces and logs.
99

10-
## Rocky AI capabilities
10+
## Rocky AI Capabilities
11+
### Root Cause & User Impact Analysis
1112

12-
Rocky AI's current core capabilities are **Root Cause & User Impact Analysis** for failing checks and
13-
test results. Read more about [Rocky AI Root Cause Analysis in the resolve section](/resolve/ai-root-cause-analysis/overview).
13+
- **User Impact**: Rocky AI analyzes the failure and provides you with a list of impacted user groups and features.
14+
- **Root Cause**: Rocky AI analyzes the failure and provides you with a root cause analysis.
15+
- **Step Summary**: Rocky AI summarizes the steps in the check script, making it easier to understand what the check is doing and where it failed. This typically works for any Playwright based check.
1416

15-
*We are planning more capabilities for Rocky AI across the Detect, Communicate and Resolve categories.*
17+
**[Learn More](/resolve/ai-root-cause-analysis/overview)**
1618

17-
## Getting Started with Rocky AI
18-
19-
To get started with Rocky AI follow these steps:
20-
21-
1. Make sure [Rocky AI is enabled in its settings page](https://app.checklyhq.com/accounts/rocky-ai).
22-
2. Now look for Rocky AI buttons and options in the Checkly web interface.
23-
24-
## AI invocations
19+
## Consumption & Invocations
2520

2621
Every AI analysis — whether triggered automatically or manually — counts as one invocation against your plan's quota. If the same analysis result is pushed to multiple alert channels, it is still counted as a single invocation.
2722

‎ai/rules.mdx‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
11
---
22
title: 'Checkly Rules'
33
description: 'Add Checkly rules files to your AI agent to provide monitoring context for your coding workflow.'
4-
sidebarTitle: 'Rules'
4+
sidebarTitle: 'Agent Rules'
5+
hidden: true
56
---
67

78
import AgentExamples from "/snippets/agent-example.mdx"

0 commit comments

Comments
 (0)