From 3153d94c11cfffb28d07835ac6ce187e5f1ea05f Mon Sep 17 00:00:00 2001 From: stefan judis Date: Thu, 19 Feb 2026 11:14:22 +0100 Subject: [PATCH 1/2] docs: improve AI context reference descriptions for monitors Add explicit construct class names to monitor descriptions and add instructional text guiding AI to read reference documentation when working with Checkly constructs. --- packages/cli/src/ai-context/context.ts | 2 +- packages/cli/src/ai-context/skill-header.md | 2 ++ skills/monitoring/SKILL.md | 4 +++- 3 files changed, 6 insertions(+), 2 deletions(-) diff --git a/packages/cli/src/ai-context/context.ts b/packages/cli/src/ai-context/context.ts index 68f59856d..8341d79b4 100644 --- a/packages/cli/src/ai-context/context.ts +++ b/packages/cli/src/ai-context/context.ts @@ -22,7 +22,7 @@ export const REFERENCES = [ { id: 'monitors', linkText: 'Monitors', - description: 'TCP, URL, DNS, ICMP, and Heartbeat monitors', + description: 'TCP (`TcpMonitor`), URL and Uptime (`UrlMonitor`), DNS (`DnsMonitor`), ICMP (`IcmpMonitor`), and Heartbeat monitors (`HeartbeatMonitor`)', }, { id: 'check-groups', diff --git a/packages/cli/src/ai-context/skill-header.md b/packages/cli/src/ai-context/skill-header.md index 0fddc2c95..ddd42de52 100644 --- a/packages/cli/src/ai-context/skill-header.md +++ b/packages/cli/src/ai-context/skill-header.md @@ -46,4 +46,6 @@ The `checkly.config.ts` at the root of your project defines a range of defaults ## Check and Monitor Constructs +Parse and read further reference documentation when tasked with creating or managing any of the following Checkly constructs: + diff --git a/skills/monitoring/SKILL.md b/skills/monitoring/SKILL.md index 1a175fe12..cf3480b60 100644 --- a/skills/monitoring/SKILL.md +++ b/skills/monitoring/SKILL.md @@ -81,11 +81,13 @@ export default defineConfig({ ## Check and Monitor Constructs +Parse and read further reference documentation when tasked with creating or managing any of the following Checkly constructs: + - [API Checks](references/api-checks.md) - ApiCheck construct, assertions, and authentication setup scripts - [Browser Checks](references/browser-checks.md) - BrowserCheck construct with Playwright test files - [Playwright Checks](references/playwright-checks.md) - PlaywrightCheck construct for multi-browser test suites - [MultiStep Checks](references/multistep-checks.md) - MultiStepCheck construct for complex user flows -- [Monitors](references/monitors.md) - TCP, URL, DNS, ICMP, and Heartbeat monitors +- [Monitors](references/monitors.md) - TCP (`TcpMonitor`), URL and Uptime (`UrlMonitor`), DNS (`DnsMonitor`), ICMP (`IcmpMonitor`), and Heartbeat monitors (`HeartbeatMonitor`) - [Check Groups](references/check-groups.md) - CheckGroupV2 construct for organizing checks - [Alert Channels](references/alert-channels.md) - Email, Phone, and Slack alert channels - [Supporting Constructs](references/supporting-constructs.md) - Status pages, dashboards, maintenance windows, and private locations From 77d83c54ebc923eaf08fc47c7837062d82d57600 Mon Sep 17 00:00:00 2001 From: stefan judis Date: Thu, 19 Feb 2026 11:48:18 +0100 Subject: [PATCH 2/2] refactor: rename monitors reference to uptime-monitors Rename the monitors reference file to uptime-monitors for clarity, since these are specifically uptime monitoring constructs rather than general monitors. --- packages/cli/src/ai-context/context.ts | 6 +++--- .../references/{monitors.md => uptime-monitors.md} | 0 skills/monitoring/SKILL.md | 2 +- .../references/{monitors.md => uptime-monitors.md} | 0 4 files changed, 4 insertions(+), 4 deletions(-) rename packages/cli/src/ai-context/references/{monitors.md => uptime-monitors.md} (100%) rename skills/monitoring/references/{monitors.md => uptime-monitors.md} (100%) diff --git a/packages/cli/src/ai-context/context.ts b/packages/cli/src/ai-context/context.ts index 8341d79b4..225ea931a 100644 --- a/packages/cli/src/ai-context/context.ts +++ b/packages/cli/src/ai-context/context.ts @@ -20,9 +20,9 @@ export const REFERENCES = [ description: 'MultiStepCheck construct for complex user flows', }, { - id: 'monitors', - linkText: 'Monitors', - description: 'TCP (`TcpMonitor`), URL and Uptime (`UrlMonitor`), DNS (`DnsMonitor`), ICMP (`IcmpMonitor`), and Heartbeat monitors (`HeartbeatMonitor`)', + id: 'uptime-monitors', + linkText: 'Uptime Monitors', + description: 'TCP (`TcpMonitor`), URL (`UrlMonitor`), DNS (`DnsMonitor`), ICMP (`IcmpMonitor`), and Heartbeat monitors (`HeartbeatMonitor`)', }, { id: 'check-groups', diff --git a/packages/cli/src/ai-context/references/monitors.md b/packages/cli/src/ai-context/references/uptime-monitors.md similarity index 100% rename from packages/cli/src/ai-context/references/monitors.md rename to packages/cli/src/ai-context/references/uptime-monitors.md diff --git a/skills/monitoring/SKILL.md b/skills/monitoring/SKILL.md index cf3480b60..98eb1b79a 100644 --- a/skills/monitoring/SKILL.md +++ b/skills/monitoring/SKILL.md @@ -87,7 +87,7 @@ Parse and read further reference documentation when tasked with creating or mana - [Browser Checks](references/browser-checks.md) - BrowserCheck construct with Playwright test files - [Playwright Checks](references/playwright-checks.md) - PlaywrightCheck construct for multi-browser test suites - [MultiStep Checks](references/multistep-checks.md) - MultiStepCheck construct for complex user flows -- [Monitors](references/monitors.md) - TCP (`TcpMonitor`), URL and Uptime (`UrlMonitor`), DNS (`DnsMonitor`), ICMP (`IcmpMonitor`), and Heartbeat monitors (`HeartbeatMonitor`) +- [Uptime Monitors](references/uptime-monitors.md) - TCP (`TcpMonitor`), URL (`UrlMonitor`), DNS (`DnsMonitor`), ICMP (`IcmpMonitor`), and Heartbeat monitors (`HeartbeatMonitor`) - [Check Groups](references/check-groups.md) - CheckGroupV2 construct for organizing checks - [Alert Channels](references/alert-channels.md) - Email, Phone, and Slack alert channels - [Supporting Constructs](references/supporting-constructs.md) - Status pages, dashboards, maintenance windows, and private locations diff --git a/skills/monitoring/references/monitors.md b/skills/monitoring/references/uptime-monitors.md similarity index 100% rename from skills/monitoring/references/monitors.md rename to skills/monitoring/references/uptime-monitors.md