|
1 | 1 | --- |
2 | 2 | title: 'AI Agents & Coding Assistants' |
3 | | -description: 'Use AI agents and coding assistants with Checkly Skills, rules, and the Checkly MCP Server.' |
4 | | -sidebarTitle: 'Agents & Checkly' |
5 | | -keywords: ['mcp', 'ai', 'rules', 'generate checks', 'agents', 'context'] |
| 3 | +description: 'Use AI agents and coding assistants with Checkly Skills and the Checkly MCP Server.' |
| 4 | +sidebarTitle: 'Overview' |
| 5 | +keywords: ['mcp', 'ai', 'generate checks', 'agents', 'context'] |
6 | 6 | --- |
7 | 7 |
|
8 | 8 | import AgentExamples from "/snippets/agent-example.mdx" |
@@ -44,128 +44,43 @@ Provide the necessary Checkly context and let your AI agent of choice do the res |
44 | 44 |
|
45 | 45 | ## Add Checkly context to your AI agent conversation |
46 | 46 |
|
47 | | -Install [Checkly Skills](/ai/skills), add [Checkly Rules](/ai/rules), or connect the [Checkly MCP Server](/ai/mcp-server) to give your AI agent enough context to perform Checkly-related tasks. |
| 47 | +Install [Checkly Skills](/ai/skills) or connect the [Checkly MCP Server](/ai/mcp-server) to give your AI agent enough context to perform Checkly-related tasks. |
48 | 48 |
|
49 | | -<Columns cols={3}> |
| 49 | +<Columns cols={2}> |
50 | 50 | <Card title="Checkly Skills" href="/ai/skills" cta="Get started"> |
51 | | -Let your agents pull in all required Checkly context on demand. |
| 51 | +For coding agents with repo and code access. Author Monitoring as Code with the Checkly CLI. |
52 | 52 | </Card> |
53 | 53 |
|
54 | 54 | <Card title="Checkly MCP Server" href="/ai/mcp-server" cta="Connect"> |
55 | | -Give your agents live access to Checkly account data and remote actions. |
56 | | -</Card> |
57 | | - |
58 | | -<Card title="Checkly Rules" href="/ai/rules" cta="Get started"> |
59 | | -Include the entire Checkly context in commands or documentation. |
| 55 | +For desktop or sandboxed agents. Live access to Checkly account data and remote actions. |
60 | 56 | </Card> |
61 | 57 | </Columns> |
62 | 58 |
|
63 | | -### Skills, MCP, and Rules |
64 | | - |
65 | | -**Use Skills** when your AI agent supports the [Agent Skills](https://agentskills.io) standard. Skills load context on demand, keeping your agent's context window lean until Checkly-related tasks arise. This is the recommended approach for compatible agents. |
66 | | - |
67 | | -**Use the MCP Server** when your agent needs live Checkly data or remote account actions, such as reading check status, inspecting test sessions, triggering existing checks, reading RCA, or managing status page incidents. |
68 | | - |
69 | | -**Use Rules** when your agent doesn't support skills or when you want the Checkly context always available. Rules files are loaded at session start and provide consistent context throughout your conversation. |
70 | | - |
71 | | - |
72 | | -## When to use the Checkly MCP Server |
73 | | - |
74 | | -The MCP concept is often used to enable LLMs to interact with external systems. It acts as a bridge between the AI model and the target system, translating natural language commands into actionable API calls or code snippets. |
75 | | - |
76 | | -The [Checkly MCP Server](/ai/mcp-server) connects MCP-compatible clients to Checkly over Streamable HTTP. It exposes tools for account context, check status and results, test sessions, result assets, root cause analyses, environment variables, status pages, incidents, and triggering existing checks. |
77 | | - |
78 | | -**Use the MCP Server for live Checkly account operations. Use Skills and the Checkly CLI for Monitoring as Code authoring.** |
79 | | - |
80 | | -<Tip> |
81 | | -The MCP server runs remotely and cannot access your local filesystem. When you need to create, edit, test, or deploy check code, use [Checkly Skills](/ai/skills) with the [Checkly CLI](/cli/overview). |
82 | | -</Tip> |
83 | | - |
84 | | -## Markdown access |
85 | | - |
86 | | -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. |
87 | | - |
88 | | -<Tip> |
89 | | -Use [Checkly Skills](/ai/skills) to automatically provide your agent with up-to-date, agent-optimized documentation. |
90 | | -</Tip> |
91 | | - |
92 | | -### .md endpoints |
93 | | - |
94 | | -Append `.md` to any documentation URL to get the markdown version of that page. |
95 | | - |
96 | | -**Example:** |
97 | | - |
98 | | -- **HTML:** `https://www.checklyhq.com/docs/what-is-checkly/` |
99 | | -- **Markdown:** `https://www.checklyhq.com/docs/what-is-checkly.md` |
100 | | - |
101 | | -The markdown version includes the full page content in plain markdown, code blocks, links preserved as markdown links, and tables formatted as markdown tables. |
102 | | - |
103 | | -```bash |
104 | | -# Fetch documentation content with curl |
105 | | -curl https://www.checklyhq.com/docs/what-is-checkly.md |
106 | | - |
107 | | -# Pipe directly to your clipboard |
108 | | -curl https://www.checklyhq.com/docs/what-is-checkly.md | pbcopy |
109 | | -``` |
110 | | - |
111 | | -### Content negotiation |
112 | | - |
113 | | -You can also request markdown by setting the `Accept` header to `text/markdown`: |
114 | | - |
115 | | -```bash |
116 | | -curl -H "Accept: text/markdown" https://www.checklyhq.com/docs/what-is-checkly/ |
117 | | -``` |
118 | | - |
119 | | -This is useful when integrating with tools or scripts that set request headers programmatically. |
| 59 | +### Skills, MCP, and the CLI |
120 | 60 |
|
121 | | -<Tip> |
122 | | -Modern coding agents set [these headers automatically when querying documentation](https://www.checklyhq.com/blog/state-of-ai-agent-content-negotation/). |
123 | | -</Tip> |
| 61 | +**Use Skills for a CLI-first workflow.** Skills are built for coding agents that have access to your repository and can run commands. The agent edits your Checkly constructs and tests, then uses the [Checkly CLI](/cli/overview) to test and deploy them. Skills load context on demand, keeping your agent's context window lean until Checkly-related tasks arise. This is the recommended approach for agents that support the [Agent Skills](https://agentskills.io) standard. |
124 | 62 |
|
125 | | -### Copy as Markdown button |
126 | | - |
127 | | -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. |
128 | | - |
129 | | -This is the fastest way to grab documentation for a specific topic and paste it into your AI assistant's context. |
130 | | - |
131 | | -```text |
132 | | -Here is the Checkly Browser Checks documentation: |
133 | | -
|
134 | | -[paste markdown content] |
135 | | -
|
136 | | -Based on this, how do I set up a browser check with a custom user agent? |
137 | | -``` |
| 63 | +**Use the MCP Server in desktop or sandboxed environments.** Some agents, like Claude Desktop, ChatGPT, or a sandboxed assistant, can't access your repository or filesystem. The [Checkly MCP Server](/ai/mcp-server) connects these clients to Checkly over Streamable HTTP and gives them live data and remote account actions, such as reading check status, inspecting test sessions, triggering existing checks, reading RCA, or managing status page incidents. |
138 | 64 |
|
| 65 | +| Use case | Recommended path | |
| 66 | +| --- | --- | |
| 67 | +| Ask quick, ad hoc questions from a supported client | [MCP Server](/ai/mcp-server) | |
| 68 | +| Inspect live Checkly data without local CLI setup | [MCP Server](/ai/mcp-server) | |
| 69 | +| Trigger existing deployed checks from chat | [MCP Server](/ai/mcp-server) or [Checkly CLI](/cli/overview) | |
| 70 | +| Create or edit check code | [Checkly Skills](/ai/skills) with the [Checkly CLI](/cli/overview) | |
| 71 | +| Test, deploy, or automate local Monitoring as Code projects | [Checkly CLI](/cli/overview) | |
| 72 | +| Add reusable Checkly best practices to an agent | [Checkly Skills](/ai/skills) | |
139 | 73 |
|
140 | | -## LLMs.txt |
| 74 | +## Feed documentation to your agent |
141 | 75 |
|
| 76 | +Every Checkly documentation page is available as markdown, and an `llms.txt` index lists them all. Both make it easy to pull the exact docs your agent needs into its context. |
142 | 77 |
|
143 | | -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. |
144 | | - |
145 | | -```txt llms.txt (first 15 lines) |
146 | | -# Checkly Docs |
147 | | -
|
148 | | -## Docs |
149 | | -
|
150 | | -- [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 |
151 | | -- [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 |
152 | | -- [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 |
153 | | -- [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. |
154 | | -- [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 |
155 | | -- [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. |
156 | | -- [Role Based Access Control in Checkly](https://checklyhq.com/docs/admin/team-management/rbac.md): Checkly roles and permissions for team members |
157 | | -- [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 |
158 | | -- [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 |
159 | | -- [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 |
160 | | -- [Team management in Checkly](https://checklyhq.com/docs/admin/team-management.md): Manage your team and collaborate effectively in Checkly |
161 | | -``` |
162 | | - |
163 | | -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. |
164 | | - |
165 | | -```bash |
166 | | -# Fetch the llms.txt index |
167 | | -curl https://www.checklyhq.com/llms.txt |
| 78 | +<Columns cols={2}> |
| 79 | +<Card title="Markdown Access" href="/ai/markdown-access" cta="Learn more"> |
| 80 | +Append `.md` to any docs URL, request markdown with content negotiation, or copy a page as markdown. |
| 81 | +</Card> |
168 | 82 |
|
169 | | -# Fetch a specific page from the index |
170 | | -curl https://checklyhq.com/docs/detect/synthetic-monitoring/browser-checks/overview.md |
171 | | -``` |
| 83 | +<Card title="llms.txt" href="/ai/llms-txt" cta="Learn more"> |
| 84 | +A machine-readable index of every documentation page for crawling and indexing. |
| 85 | +</Card> |
| 86 | +</Columns> |
0 commit comments