checkly 7.1.0 → 7.2.0

package/dist/ai-context/checkly.rules.md

@@ -7,10 +7,11 @@
 - Import and / or require any constructs you need in your code, such as `ApiCheck`, `BrowserCheck`, or `PlaywrightCheck` from the `checkly/constructs` package.
 - Always ground generated code and CLI commands against the official documentation and examples in this file.
 
-## Installing the Checkly CLI
+## Using the Checkly CLI
 
-- ALWAYS use `npm create checkly@latest`.
+- Use `npx checkly` instead of installing the Checkly CLI globally.
 - NEVER make up commands that do not exist.
+- Use `npm create checkly@latest` to set up a new Checkly project via the CLI.
 
 ## Project Structure
 
@@ -72,14 +73,16 @@ export default defineConfig({
 
 ## Check and Monitor Constructs
 
-### API Check
+Parse and read further reference documentation when tasked with creating or managing any of the following Checkly constructs:
+
+### API Checks
 
 - Import the `ApiCheck` construct from `checkly/constructs`.
 - When adding `assertions`, always use `AssertionBuilder` class for API Checks.
 - When referencing environment variables always use the handlebar syntax `{{MY_ENV_VAR}}`.
 - When referencing secrets always use the handlebar syntax `{{MY_SECRET}}`.
 - If endpoints require authentication ask the user which authentication method to use and then generate a setupScript to authenticate the given requests.
-- Referenced `setupScript.ts` and `teardownScript.ts` for API checks must be plain ts files and not export anything.
+- Referenced `setup-script.ts` and `teardown-script.ts` for API checks must be plain ts files and not export anything.
 - Check in the code if API endpoints require authentication.
 
 **Reference:** https://www.checklyhq.com/docs/constructs/api-check/
@@ -89,11 +92,6 @@ import { AlertEscalationBuilder, ApiCheck, Frequency, RetryStrategyBuilder } fro
 
 new ApiCheck('example-api-check', {
   name: 'Example API Check',
-  request: {
-    url: 'https://api.example.com/v1/products',
-    method: 'GET',
-    ipFamily: 'IPv4',
-  },
   setupScript: {
     entrypoint: './setup-script.ts',
   },
@@ -103,8 +101,6 @@ new ApiCheck('example-api-check', {
   degradedResponseTime: 5000,
   maxResponseTime: 20000,
   activated: true,
-  muted: false,
-  shouldFail: false,
   locations: [
     'eu-central-1',
     'eu-west-2',
@@ -124,6 +120,10 @@ new ApiCheck('example-api-check', {
     sameRegion: true,
   }),
   runParallel: true,
+  request: {
+    url: 'https://api.example.com/v1/products',
+    method: 'GET',
+  },
 })
 ```
 
@@ -134,7 +134,7 @@ new ApiCheck('example-api-check', {
 - Read the input credentials from env variables using `process.env`.
 - Pass auth tokens to the request object using `request.headers['key'] = AUTH_TOKEN_VALUE`.
 
-### Browser Check
+### Browser Checks
 
 - Import the `BrowserCheck` construct from `checkly/constructs`.
 - Generate a separate `.spec.ts` file for the Playwright code referenced in the `BrowserCheck` construct.
@@ -151,8 +151,6 @@ new BrowserCheck('example-browser-check', {
     entrypoint: './example-browser-check.spec.ts',
   },
   activated: false,
-  muted: false,
-  shouldFail: false,
   locations: [
     'eu-central-1',
     'eu-west-2',
@@ -175,10 +173,11 @@ new BrowserCheck('example-browser-check', {
 })
 ```
 
-### Playwright Check Suite
+### Playwright Check Suites
 
 - Import the `PlaywrightCheck` construct from `checkly/constructs`.
-- use `pwProjects` if your tasked to reuse a Playwright project.
+- use `pwProjects` if you're tasked to reuse a Playwright project.
+- use `pwTags` if you're tasked to reuse a Playwright tag.
 
 **Reference:** https://www.checklyhq.com/docs/constructs/playwright-check/
 
@@ -194,7 +193,7 @@ const playwrightChecks = new PlaywrightCheck("multi-browser-check", {
 });
 ```
 
-### MultiStep Check
+### MultiStep Checks
 
 - Import the `MultiStepCheck` construct from `checkly/constructs`.
 - Generate a separate `.spec.ts` file for the Playwright code referenced in the `MultiStepCheck` construct.
@@ -211,8 +210,6 @@ new MultiStepCheck('example-multi-step-check', {
     entrypoint: './example-multistep-check.spec.ts',
   },
   activated: true,
-  muted: false,
-  shouldFail: false,
   locations: [
     'eu-central-1',
     'eu-west-2',
@@ -230,7 +227,9 @@ new MultiStepCheck('example-multi-step-check', {
 })
 ```
 
-### TCP Monitor
+### Monitors
+
+#### TCP Monitor
 
 - Import the `TcpMonitor` construct from `checkly/constructs`.
 - When adding `assertions`, always use `TcpAssertionBuilder` class for TCP monitors.
@@ -242,20 +241,9 @@ import { AlertEscalationBuilder, Frequency, RetryStrategyBuilder, TcpAssertionBu
 
 new TcpMonitor('example-tcp-monitor', {
   name: 'Example TCP Monitor',
-  request: {
-    hostname: 'tcp.example.com',
-    port: 4242,
-    ipFamily: 'IPv4',
-    assertions: [
-      TcpAssertionBuilder.responseTime().lessThan(200),
-      TcpAssertionBuilder.responseData().isEmpty(),
-    ],
-  },
   degradedResponseTime: 5000,
   maxResponseTime: 5000,
   activated: true,
-  muted: false,
-  shouldFail: false,
   locations: [
     'eu-central-1',
     'eu-west-2',
@@ -275,10 +263,19 @@ new TcpMonitor('example-tcp-monitor', {
     sameRegion: true,
   }),
   runParallel: true,
+  request: {
+    hostname: 'tcp.example.com',
+    port: 4242,
+    ipFamily: 'IPv4',
+    assertions: [
+      TcpAssertionBuilder.responseTime().lessThan(200),
+      TcpAssertionBuilder.responseData().isEmpty(),
+    ],
+  },
 })
 ```
 
-### URL Monitor
+#### URL Monitor
 
 - Import the `UrlMonitor` construct from `checkly/constructs`.
 - When adding `assertions`, always use `UrlAssertionBuilder`.
@@ -290,18 +287,7 @@ import { AlertEscalationBuilder, Frequency, RetryStrategyBuilder, UrlAssertionBu
 
 new UrlMonitor('example-url-monitor', {
   name: 'Example URL Monitor',
-  request: {
-    url: 'https://example.com',
-    ipFamily: 'IPv4',
-    assertions: [
-      UrlAssertionBuilder.statusCode().equals(200),
-    ],
-  },
-  degradedResponseTime: 5000,
-  maxResponseTime: 20000,
   activated: true,
-  muted: false,
-  shouldFail: false,
   locations: [
     'eu-central-1',
     'eu-west-2',
@@ -321,10 +307,19 @@ new UrlMonitor('example-url-monitor', {
     sameRegion: true,
   }),
   runParallel: true,
+  degradedResponseTime: 5000,
+  maxResponseTime: 20000,
+  request: {
+    url: 'https://example.com',
+    ipFamily: 'IPv4',
+    assertions: [
+      UrlAssertionBuilder.statusCode().equals(200),
+    ],
+  },
 })
 ```
 
-### DNS Monitor
+#### DNS Monitor
 
 - Import the `DnsMonitor` construct from `checkly/constructs`.
 - Reference [the docs for DNS monitors](https://www.checklyhq.com/docs/constructs/dns-monitor/) before generating any code.
@@ -337,18 +332,9 @@ import { AlertEscalationBuilder, DnsAssertionBuilder, DnsMonitor, Frequency, Ret
 
 new DnsMonitor('example-dns-monitor', {
   name: 'Example DNS Monitor',
-  request: {
-    recordType: 'AAAA',
-    query: 'welcome.checklyhq.com',
-    assertions: [
-      DnsAssertionBuilder.responseCode().equals('NOERROR'),
-    ],
-  },
   degradedResponseTime: 500,
   maxResponseTime: 1000,
   activated: true,
-  muted: false,
-  shouldFail: false,
   locations: [
     'eu-central-1',
     'eu-north-1',
@@ -362,11 +348,17 @@ new DnsMonitor('example-dns-monitor', {
     percentage: 10,
   }),
   retryStrategy: RetryStrategyBuilder.noRetries(),
-  runParallel: false,
+  request: {
+    recordType: 'AAAA',
+    query: 'welcome.checklyhq.com',
+    assertions: [
+      DnsAssertionBuilder.responseCode().equals('NOERROR'),
+    ],
+  },
 })
 ```
 
-### ICMP Monitor
+##### ICMP Monitor
 
 - Import the `IcmpMonitor` construct from `checkly/constructs`.
 - Reference [the docs for ICMP monitors](https://www.checklyhq.com/docs/constructs/icmp-monitor/) before generating any code.
@@ -392,7 +384,6 @@ new IcmpMonitor('example-icmp-monitor', {
   degradedPacketLossThreshold: 10,
   maxPacketLossThreshold: 20,
   activated: true,
-  muted: false,
   locations: [
     'eu-central-1',
     'eu-north-1',
@@ -406,11 +397,10 @@ new IcmpMonitor('example-icmp-monitor', {
     percentage: 10,
   }),
   retryStrategy: RetryStrategyBuilder.noRetries(),
-  runParallel: false,
 })
 ```
 
-### Heartbeat Monitor
+#### Heartbeat Monitor
 
 - Import the `HeartbeatMonitor` construct from `checkly/constructs`.
 
@@ -426,8 +416,6 @@ new HeartbeatMonitor('example-heartbeat-monitor', {
   grace: 30,
   graceUnit: 'minutes',
   activated: true,
-  muted: false,
-  shouldFail: false,
   frequency: Frequency.EVERY_10S,
   alertEscalationPolicy: AlertEscalationBuilder.runBasedEscalation(1, {
     amount: 0,
@@ -446,7 +434,7 @@ new HeartbeatMonitor('example-heartbeat-monitor', {
 })
 ```
 
-### Check Group
+### Check Groups
 
 - Import the `CheckGroupV2` construct from `checkly/constructs`.
 - Check Groups are used to group checks together for easier management and organization.
@@ -462,14 +450,18 @@ export const exampleGroup = new CheckGroupV2('example-group', {
 })
 ```
 
-## Alert Channel Constructs
+### Alert Channels
 
 - Alert channels are used to send notifications when checks and monitors fail or recover.
 - Alert channels are added to checks, monitors, and check groups constructs by adding them to the `alertChannels` array property.
 
-Here are some examples of how to create different types of alert channels. All alert are described in the [Checkly docs](https://www.checklyhq.com/docs/constructs/overview/).
+Here are some examples of how to create different types of alert channels.
+
+All available alerts are described in the [Checkly docs](https://www.checklyhq.com/docs/constructs/overview/).
 
-### Email Alert Channel
+*Important*: Don't make up email addresses, phone numbers, Slack URLs or similar static values. Scan the project to discover a valid configuration or ask what the values should be.
+
+#### Email Alert Channel
 
 **Reference:** https://www.checklyhq.com/docs/constructs/email-alert-channel/
 
@@ -482,8 +474,7 @@ export const testEmailAlert = new EmailAlertChannel('example-email-alert-channel
 })
 ```
 
-
-### Phone Call Alert Channel
+#### Phone Call Alert Channel
 
 **Reference:** https://www.checklyhq.com/docs/constructs/phone-call-alert-channel/
 
@@ -492,12 +483,11 @@ import { PhoneCallAlertChannel } from 'checkly/constructs'
 
 export const testUserPhoneCallAlert = new PhoneCallAlertChannel('example-call-alert-channel', {
   name: 'Test User',
-  phoneNumber: '+311234567890',
+  phoneNumber: 'INSERT_PHONE_NUMBER',
 })
 ```
 
-
-### Slack Alert Channel
+#### Slack Alert Channel
 
 **Reference:** https://www.checklyhq.com/docs/constructs/slack-alert-channel/
 
@@ -505,15 +495,14 @@ export const testUserPhoneCallAlert = new PhoneCallAlertChannel('example-call-al
 import { SlackAlertChannel } from 'checkly/constructs'
 
 export const generalSlackAlert = new SlackAlertChannel('example-slack-alert-channel', {
-  url: 'https://hooks.slack.com/services/TK123456789123/12345/123456789',
+  url: 'INSERT_SLACK_URL',
   channel: '#general',
 })
 ```
 
+### Supporting Constructs
 
-## Supporting Constructs
-
-### Status Page
+#### Status Page
 
 - Import the `StatusPage` construct from `checkly/constructs`.
 - Status pages are used to display the status of your services to your users.
@@ -541,7 +530,7 @@ new StatusPage('example-status-page', {
 })
 ```
 
-### Status Page Service
+#### Status Page Service
 
 - Import the `StatusPageService` construct from `checkly/constructs`.
 - Status Page Services are used to represent individual services on a Status Page.
@@ -556,7 +545,7 @@ export const exampleService = new StatusPageService('example-status-page-service
 })
 ```
 
-### Dashboard
+#### Dashboard
 
 - Import the `Dashboard` construct from `checkly/constructs`.
 - Dashboards are used to display the results of your checks on screens external to Checkly.
@@ -590,7 +579,7 @@ new Dashboard('example-dashboard', {
 })
 ```
 
-### Maintenance Window
+#### Maintenance Window
 
 - Import the `MaintenanceWindow` construct from `checkly/constructs`.
 - Maintenance windows are used to pause checks during maintenance periods so no alerts are sent.
@@ -614,7 +603,7 @@ new MaintenanceWindow('example-maintenance-window', {
 })
 ```
 
-### Private Location
+#### Private Location
 
 - Import the `PrivateLocation` construct from `checkly/constructs`.
 - Private locations are used to run checks from your own infrastructure with the Checkly Agent, an OCI compatible container.
@@ -633,4 +622,4 @@ export const examplePrivateLocation = new PrivateLocation('example-private-locat
 
 ## Testing and Debugging
 
-- Test checks using `npx checkly test` command pass env variables using `-e` param, use `--record` to persist results and `--verbose` to be able to see all errors
+- Test checks using the `npx checkly test` command. Pass environment variables with the `-e` flag, use `--record` to persist results, and use `--verbose` to see all errors.

package/dist/ai-context/context.d.ts

@@ -1,6 +1,41 @@
-export declare const EXAMPLE_CONFIGS: Record<string, {
+export declare const REFERENCES: readonly [{
+    readonly id: "api-checks";
+    readonly linkText: "API Checks";
+    readonly description: "ApiCheck construct, assertions, and authentication setup scripts";
+}, {
+    readonly id: "browser-checks";
+    readonly linkText: "Browser Checks";
+    readonly description: "BrowserCheck construct with Playwright test files";
+}, {
+    readonly id: "playwright-checks";
+    readonly linkText: "Playwright Checks";
+    readonly description: "PlaywrightCheck construct for multi-browser test suites";
+}, {
+    readonly id: "multistep-checks";
+    readonly linkText: "MultiStep Checks";
+    readonly description: "MultiStepCheck construct for complex user flows";
+}, {
+    readonly id: "uptime-monitors";
+    readonly linkText: "Uptime Monitors";
+    readonly description: "TCP (`TcpMonitor`), URL (`UrlMonitor`), DNS (`DnsMonitor`), ICMP (`IcmpMonitor`), and Heartbeat monitors (`HeartbeatMonitor`)";
+}, {
+    readonly id: "check-groups";
+    readonly linkText: "Check Groups";
+    readonly description: "CheckGroupV2 construct for organizing checks";
+}, {
+    readonly id: "alert-channels";
+    readonly linkText: "Alert Channels";
+    readonly description: "Email, Phone, and Slack alert channels";
+}, {
+    readonly id: "supporting-constructs";
+    readonly linkText: "Supporting Constructs";
+    readonly description: "Status pages, dashboards, maintenance windows, and private locations";
+}];
+interface ExampleConfig {
     templateString: string;
     reference: string;
     exampleConfig?: string;
     exampleConfigPath?: string;
-}>;
+}
+export declare const EXAMPLE_CONFIGS: Record<string, ExampleConfig>;
+export {};

package/dist/ai-context/context.js

@@ -1,9 +1,51 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.EXAMPLE_CONFIGS = void 0;
+exports.EXAMPLE_CONFIGS = exports.REFERENCES = void 0;
+exports.REFERENCES = [
+    {
+        id: 'api-checks',
+        linkText: 'API Checks',
+        description: 'ApiCheck construct, assertions, and authentication setup scripts',
+    },
+    {
+        id: 'browser-checks',
+        linkText: 'Browser Checks',
+        description: 'BrowserCheck construct with Playwright test files',
+    },
+    {
+        id: 'playwright-checks',
+        linkText: 'Playwright Checks',
+        description: 'PlaywrightCheck construct for multi-browser test suites',
+    },
+    {
+        id: 'multistep-checks',
+        linkText: 'MultiStep Checks',
+        description: 'MultiStepCheck construct for complex user flows',
+    },
+    {
+        id: 'uptime-monitors',
+        linkText: 'Uptime Monitors',
+        description: 'TCP (`TcpMonitor`), URL (`UrlMonitor`), DNS (`DnsMonitor`), ICMP (`IcmpMonitor`), and Heartbeat monitors (`HeartbeatMonitor`)',
+    },
+    {
+        id: 'check-groups',
+        linkText: 'Check Groups',
+        description: 'CheckGroupV2 construct for organizing checks',
+    },
+    {
+        id: 'alert-channels',
+        linkText: 'Alert Channels',
+        description: 'Email, Phone, and Slack alert channels',
+    },
+    {
+        id: 'supporting-constructs',
+        linkText: 'Supporting Constructs',
+        description: 'Status pages, dashboards, maintenance windows, and private locations',
+    },
+];
 exports.EXAMPLE_CONFIGS = {
     CHECKLY_CONFIG: {
-        templateString: '// INSERT CHECKLY CONFIG EXAMPLE HERE //',
+        templateString: '<!-- EXAMPLE: CHECKLY_CONFIG -->',
         exampleConfig: `import { defineConfig } from 'checkly'
 import { Frequency } from 'checkly/constructs'
 
@@ -40,12 +82,12 @@ export default defineConfig({
         reference: 'https://www.checklyhq.com/docs/constructs/project/',
     },
     BROWSER_CHECK: {
-        templateString: '// INSERT BROWSER CHECK EXAMPLE HERE //',
+        templateString: '<!-- EXAMPLE: BROWSER_CHECK -->',
         exampleConfigPath: 'resources/browser-checks/example-browser-check/example-browser-check.check.ts',
         reference: 'https://www.checklyhq.com/docs/constructs/browser-check/',
     },
     PLAYWRIGHT_CHECK: {
-        templateString: '// INSERT PLAYWRIGHT CHECK EXAMPLE HERE //',
+        templateString: '<!-- EXAMPLE: PLAYWRIGHT_CHECK -->',
         exampleConfig: `import { PlaywrightCheck } from "checkly/constructs"
 
 const playwrightChecks = new PlaywrightCheck("multi-browser-check", {
@@ -59,82 +101,82 @@ const playwrightChecks = new PlaywrightCheck("multi-browser-check", {
         reference: 'https://www.checklyhq.com/docs/constructs/playwright-check/',
     },
     API_CHECK: {
-        templateString: '// INSERT API CHECK EXAMPLE HERE //',
+        templateString: '<!-- EXAMPLE: API_CHECK -->',
         exampleConfigPath: 'resources/api-checks/example-api-check/example-api-check.check.ts',
         reference: 'https://www.checklyhq.com/docs/constructs/api-check/',
     },
     MULTISTEP_CHECK: {
-        templateString: '// INSERT MULTISTEP CHECK EXAMPLE HERE //',
+        templateString: '<!-- EXAMPLE: MULTISTEP_CHECK -->',
         exampleConfigPath: 'resources/multi-step-checks/example-multistep-check/example-multistep-check.check.ts',
         reference: 'https://www.checklyhq.com/docs/constructs/multistep-check/',
     },
     TCP_MONITOR: {
-        templateString: '// INSERT TCP MONITOR EXAMPLE HERE //',
+        templateString: '<!-- EXAMPLE: TCP_MONITOR -->',
         exampleConfigPath: 'resources/tcp-monitors/example-tcp-monitor.check.ts',
         reference: 'https://www.checklyhq.com/docs/constructs/tcp-monitor/',
     },
     HEARTBEAT_MONITOR: {
-        templateString: '// INSERT HEARTBEAT MONITOR EXAMPLE HERE //',
+        templateString: '<!-- EXAMPLE: HEARTBEAT_MONITOR -->',
         exampleConfigPath: 'resources/heartbeat-monitors/example-heartbeat-monitor.check.ts',
         reference: 'https://www.checklyhq.com/docs/constructs/heartbeat-monitor/',
     },
     URL_MONITOR: {
-        templateString: '// INSERT URL MONITOR EXAMPLE HERE //',
+        templateString: '<!-- EXAMPLE: URL_MONITOR -->',
         exampleConfigPath: 'resources/url-monitors/example-url-monitor.check.ts',
         reference: 'https://www.checklyhq.com/docs/constructs/url-monitor/',
     },
     DNS_MONITOR: {
-        templateString: '// INSERT DNS MONITOR EXAMPLE HERE //',
+        templateString: '<!-- EXAMPLE: DNS_MONITOR -->',
         exampleConfigPath: 'resources/dns-monitors/example-dns-monitor.check.ts',
         reference: 'https://www.checklyhq.com/docs/constructs/dns-monitor/',
     },
     ICMP_MONITOR: {
-        templateString: '// INSERT ICMP MONITOR EXAMPLE HERE //',
+        templateString: '<!-- EXAMPLE: ICMP_MONITOR -->',
         exampleConfigPath: 'resources/icmp-monitors/example-icmp-monitor.check.ts',
         reference: 'https://www.checklyhq.com/docs/constructs/icmp-monitor/',
     },
     CHECK_GROUP: {
-        templateString: '// INSERT CHECK GROUP EXAMPLE HERE //',
+        templateString: '<!-- EXAMPLE: CHECK_GROUP -->',
         exampleConfigPath: 'resources/check-group/example-group/example-group.check.ts',
         reference: 'https://www.checklyhq.com/docs/constructs/check-group/',
     },
     STATUS_PAGE: {
-        templateString: '// INSERT STATUS PAGE EXAMPLE HERE //',
+        templateString: '<!-- EXAMPLE: STATUS_PAGE -->',
         exampleConfigPath: 'resources/status-pages/example-status-page.check.ts',
         reference: 'https://www.checklyhq.com/docs/constructs/status-page/',
     },
     STATUS_PAGE_SERVICE: {
-        templateString: '// INSERT STATUS PAGE SERVICE EXAMPLE HERE //',
+        templateString: '<!-- EXAMPLE: STATUS_PAGE_SERVICE -->',
         exampleConfigPath: 'resources/status-pages/services/example-service.check.ts',
         reference: 'https://www.checklyhq.com/docs/constructs/status-page-service/',
     },
     DASHBOARD: {
-        templateString: '// INSERT DASHBOARD EXAMPLE HERE //',
+        templateString: '<!-- EXAMPLE: DASHBOARD -->',
         exampleConfigPath: 'resources/dashboards/example-dashboard/example-dashboard.check.ts',
         reference: 'https://www.checklyhq.com/docs/constructs/dashboard/',
     },
     MAINTENANCE_WINDOW: {
-        templateString: '// INSERT MAINTENANCE WINDOW EXAMPLE HERE //',
+        templateString: '<!-- EXAMPLE: MAINTENANCE_WINDOW -->',
         exampleConfigPath: 'resources/maintenance-windows/example-maintenance-window.check.ts',
         reference: 'https://www.checklyhq.com/docs/constructs/maintenance-window/',
     },
     PRIVATE_LOCATION: {
-        templateString: '// INSERT PRIVATE LOCATION EXAMPLE HERE //',
+        templateString: '<!-- EXAMPLE: PRIVATE_LOCATION -->',
         exampleConfigPath: 'resources/private-locations/example-private-location.check.ts',
         reference: 'https://www.checklyhq.com/docs/constructs/private-location/',
     },
     EMAIL_ALERT_CHANNEL: {
-        templateString: '// INSERT EMAIL ALERT CHANNEL EXAMPLE HERE //',
+        templateString: '<!-- EXAMPLE: EMAIL_ALERT_CHANNEL -->',
         exampleConfigPath: 'resources/alert-channels/email/test.check.ts',
         reference: 'https://www.checklyhq.com/docs/constructs/email-alert-channel/',
     },
     PHONE_CALL_ALERT_CHANNEL: {
-        templateString: '// INSERT PHONE CALL ALERT CHANNEL EXAMPLE HERE //',
+        templateString: '<!-- EXAMPLE: PHONE_CALL_ALERT_CHANNEL -->',
         exampleConfigPath: 'resources/alert-channels/phone-call/test-user.check.ts',
         reference: 'https://www.checklyhq.com/docs/constructs/phone-call-alert-channel/',
     },
     SLACK_ALERT_CHANNEL: {
-        templateString: '// INSERT SLACK ALERT CHANNEL EXAMPLE HERE //',
+        templateString: '<!-- EXAMPLE: SLACK_ALERT_CHANNEL -->',
         exampleConfigPath: 'resources/alert-channels/slack/general.check.ts',
         reference: 'https://www.checklyhq.com/docs/constructs/slack-alert-channel/',
     },

package/dist/ai-context/context.js.map

@@ -1 +1 @@
-{"version":3,"file":"context.js","sourceRoot":"","sources":["../../src/ai-context/context.ts"],"names":[],"mappings":";;;AAAa,QAAA,eAAe,GAQxB;IACF,cAAc,EAAE;QACd,cAAc,EAAE,0CAA0C;QAC1D,aAAa,EAAE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAgClB;QACG,SAAS,EAAE,oDAAoD;KAChE;IACD,aAAa,EAAE;QACb,cAAc,EAAE,yCAAyC;QACzD,iBAAiB,EACf,+EAA+E;QACjF,SAAS,EAAE,0DAA0D;KACtE;IACD,gBAAgB,EAAE;QAChB,cAAc,EAAE,4CAA4C;QAC5D,aAAa,EAAE;;;;;;;;;CASlB;QACG,SAAS,EAAE,6DAA6D;KACzE;IACD,SAAS,EAAE;QACT,cAAc,EAAE,qCAAqC;QACrD,iBAAiB,EACf,mEAAmE;QACrE,SAAS,EAAE,sDAAsD;KAClE;IACD,eAAe,EAAE;QACf,cAAc,EAAE,2CAA2C;QAC3D,iBAAiB,EACf,sFAAsF;QACxF,SAAS,EAAE,4DAA4D;KACxE;IACD,WAAW,EAAE;QACX,cAAc,EAAE,uCAAuC;QACvD,iBAAiB,EAAE,qDAAqD;QACxE,SAAS,EAAE,wDAAwD;KACpE;IACD,iBAAiB,EAAE;QACjB,cAAc,EAAE,6CAA6C;QAC7D,iBAAiB,EACf,iEAAiE;QACnE,SAAS,EAAE,8DAA8D;KAC1E;IACD,WAAW,EAAE;QACX,cAAc,EAAE,uCAAuC;QACvD,iBAAiB,EAAE,qDAAqD;QACxE,SAAS,EAAE,wDAAwD;KACpE;IACD,WAAW,EAAE;QACX,cAAc,EAAE,uCAAuC;QACvD,iBAAiB,EAAE,qDAAqD;QACxE,SAAS,EAAE,wDAAwD;KACpE;IACD,YAAY,EAAE;QACZ,cAAc,EAAE,wCAAwC;QACxD,iBAAiB,EAAE,uDAAuD;QAC1E,SAAS,EAAE,yDAAyD;KACrE;IACD,WAAW,EAAE;QACX,cAAc,EAAE,uCAAuC;QACvD,iBAAiB,EACf,4DAA4D;QAC9D,SAAS,EAAE,wDAAwD;KACpE;IACD,WAAW,EAAE;QACX,cAAc,EAAE,uCAAuC;QACvD,iBAAiB,EAAE,qDAAqD;QACxE,SAAS,EAAE,wDAAwD;KACpE;IACD,mBAAmB,EAAE;QACnB,cAAc,EAAE,+CAA+C;QAC/D,iBAAiB,EACf,0DAA0D;QAC5D,SAAS,EAAE,gEAAgE;KAC5E;IACD,SAAS,EAAE;QACT,cAAc,EAAE,qCAAqC;QACrD,iBAAiB,EACf,mEAAmE;QACrE,SAAS,EAAE,sDAAsD;KAClE;IACD,kBAAkB,EAAE;QAClB,cAAc,EAAE,8CAA8C;QAC9D,iBAAiB,EACf,mEAAmE;QACrE,SAAS,EAAE,+DAA+D;KAC3E;IACD,gBAAgB,EAAE;QAChB,cAAc,EAAE,4CAA4C;QAC5D,iBAAiB,EACf,+DAA+D;QACjE,SAAS,EAAE,6DAA6D;KACzE;IACD,mBAAmB,EAAE;QACnB,cAAc,EAAE,+CAA+C;QAC/D,iBAAiB,EAAE,8CAA8C;QACjE,SAAS,EAAE,gEAAgE;KAC5E;IACD,wBAAwB,EAAE;QACxB,cAAc,EAAE,oDAAoD;QACpE,iBAAiB,EAAE,wDAAwD;QAC3E,SAAS,EAAE,qEAAqE;KACjF;IACD,mBAAmB,EAAE;QACnB,cAAc,EAAE,+CAA+C;QAC/D,iBAAiB,EAAE,iDAAiD;QACpE,SAAS,EAAE,gEAAgE;KAC5E;CACF,CAAA"}
+{"version":3,"file":"context.js","sourceRoot":"","sources":["../../src/ai-context/context.ts"],"names":[],"mappings":";;;AAAa,QAAA,UAAU,GAAG;IACxB;QACE,EAAE,EAAE,YAAY;QAChB,QAAQ,EAAE,YAAY;QACtB,WAAW,EAAE,kEAAkE;KAChF;IACD;QACE,EAAE,EAAE,gBAAgB;QACpB,QAAQ,EAAE,gBAAgB;QAC1B,WAAW,EAAE,mDAAmD;KACjE;IACD;QACE,EAAE,EAAE,mBAAmB;QACvB,QAAQ,EAAE,mBAAmB;QAC7B,WAAW,EAAE,yDAAyD;KACvE;IACD;QACE,EAAE,EAAE,kBAAkB;QACtB,QAAQ,EAAE,kBAAkB;QAC5B,WAAW,EAAE,iDAAiD;KAC/D;IACD;QACE,EAAE,EAAE,iBAAiB;QACrB,QAAQ,EAAE,iBAAiB;QAC3B,WAAW,EAAE,+HAA+H;KAC7I;IACD;QACE,EAAE,EAAE,cAAc;QAClB,QAAQ,EAAE,cAAc;QACxB,WAAW,EAAE,8CAA8C;KAC5D;IACD;QACE,EAAE,EAAE,gBAAgB;QACpB,QAAQ,EAAE,gBAAgB;QAC1B,WAAW,EAAE,wCAAwC;KACtD;IACD;QACE,EAAE,EAAE,uBAAuB;QAC3B,QAAQ,EAAE,uBAAuB;QACjC,WAAW,EAAE,sEAAsE;KACpF;CACO,CAAA;AASG,QAAA,eAAe,GAAkC;IAC5D,cAAc,EAAE;QACd,cAAc,EAAE,kCAAkC;QAClD,aAAa,EAAE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAgClB;QACG,SAAS,EAAE,oDAAoD;KAChE;IACD,aAAa,EAAE;QACb,cAAc,EAAE,iCAAiC;QACjD,iBAAiB,EACf,+EAA+E;QACjF,SAAS,EAAE,0DAA0D;KACtE;IACD,gBAAgB,EAAE;QAChB,cAAc,EAAE,oCAAoC;QACpD,aAAa,EAAE;;;;;;;;;CASlB;QACG,SAAS,EAAE,6DAA6D;KACzE;IACD,SAAS,EAAE;QACT,cAAc,EAAE,6BAA6B;QAC7C,iBAAiB,EACf,mEAAmE;QACrE,SAAS,EAAE,sDAAsD;KAClE;IACD,eAAe,EAAE;QACf,cAAc,EAAE,mCAAmC;QACnD,iBAAiB,EACf,sFAAsF;QACxF,SAAS,EAAE,4DAA4D;KACxE;IACD,WAAW,EAAE;QACX,cAAc,EAAE,+BAA+B;QAC/C,iBAAiB,EAAE,qDAAqD;QACxE,SAAS,EAAE,wDAAwD;KACpE;IACD,iBAAiB,EAAE;QACjB,cAAc,EAAE,qCAAqC;QACrD,iBAAiB,EACf,iEAAiE;QACnE,SAAS,EAAE,8DAA8D;KAC1E;IACD,WAAW,EAAE;QACX,cAAc,EAAE,+BAA+B;QAC/C,iBAAiB,EAAE,qDAAqD;QACxE,SAAS,EAAE,wDAAwD;KACpE;IACD,WAAW,EAAE;QACX,cAAc,EAAE,+BAA+B;QAC/C,iBAAiB,EAAE,qDAAqD;QACxE,SAAS,EAAE,wDAAwD;KACpE;IACD,YAAY,EAAE;QACZ,cAAc,EAAE,gCAAgC;QAChD,iBAAiB,EAAE,uDAAuD;QAC1E,SAAS,EAAE,yDAAyD;KACrE;IACD,WAAW,EAAE;QACX,cAAc,EAAE,+BAA+B;QAC/C,iBAAiB,EACf,4DAA4D;QAC9D,SAAS,EAAE,wDAAwD;KACpE;IACD,WAAW,EAAE;QACX,cAAc,EAAE,+BAA+B;QAC/C,iBAAiB,EAAE,qDAAqD;QACxE,SAAS,EAAE,wDAAwD;KACpE;IACD,mBAAmB,EAAE;QACnB,cAAc,EAAE,uCAAuC;QACvD,iBAAiB,EACf,0DAA0D;QAC5D,SAAS,EAAE,gEAAgE;KAC5E;IACD,SAAS,EAAE;QACT,cAAc,EAAE,6BAA6B;QAC7C,iBAAiB,EACf,mEAAmE;QACrE,SAAS,EAAE,sDAAsD;KAClE;IACD,kBAAkB,EAAE;QAClB,cAAc,EAAE,sCAAsC;QACtD,iBAAiB,EACf,mEAAmE;QACrE,SAAS,EAAE,+DAA+D;KAC3E;IACD,gBAAgB,EAAE;QAChB,cAAc,EAAE,oCAAoC;QACpD,iBAAiB,EACf,+DAA+D;QACjE,SAAS,EAAE,6DAA6D;KACzE;IACD,mBAAmB,EAAE;QACnB,cAAc,EAAE,uCAAuC;QACvD,iBAAiB,EAAE,8CAA8C;QACjE,SAAS,EAAE,gEAAgE;KAC5E;IACD,wBAAwB,EAAE;QACxB,cAAc,EAAE,4CAA4C;QAC5D,iBAAiB,EAAE,wDAAwD;QAC3E,SAAS,EAAE,qEAAqE;KACjF;IACD,mBAAmB,EAAE;QACnB,cAAc,EAAE,uCAAuC;QACvD,iBAAiB,EAAE,iDAAiD;QACpE,SAAS,EAAE,gEAAgE;KAC5E;CACF,CAAA"}

package/dist/ai-context/skills/monitoring/README.md

@@ -8,7 +8,16 @@ This directory contains the agent skill for creating and managing end-to-end tes
 skills/
 └── monitoring/
     ├── README.md             # Documentation about the skill
-    └── SKILL.md              # Main skill instructions
+    ├── SKILL.md              # Main skill instructions
+    └── references/           # Detailed construct documentation
+        ├── api-checks.md
+        ├── browser-checks.md
+        ├── playwright-checks.md
+        ├── multistep-checks.md
+        ├── monitors.md
+        ├── check-groups.md
+        ├── alert-channels.md
+        └── supporting-constructs.md
 ```
 
 ## What is an Agent Skill?
@@ -27,13 +36,15 @@ Agent Skills are a standardized format for giving AI agents specialized knowledg
 AI agents can load this skill to gain expertise in Checkly monitoring. The skill follows the [Agent Skills specification](https://agentskills.io) with:
 
 - **SKILL.md**: Core instructions loaded when the skill is activated
+- **references/**: Detailed documentation loaded on demand
 
 ## Progressive Disclosure
 
 The skill is structured for efficient context usage:
 
 1. **Metadata** (~80 tokens): Name and description in frontmatter
-2. **Core Instructions** (~4.5K tokens): Main SKILL.md content with construct examples
+2. **Core Instructions** (~1K tokens): Main SKILL.md content with links to references
+3. **References** (loaded on demand): Detailed construct documentation with examples
 
 Agents load what they need for each task.