|
1 | 1 | --- |
2 | 2 | title: 'AI Agents & Coding Assistants' |
3 | 3 | 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' |
5 | 5 | keywords: ['mcp', 'ai', 'rules', 'generate checks', 'agents', 'context'] |
6 | 6 | --- |
7 | 7 |
|
@@ -74,3 +74,92 @@ Whether you need to configure your monitoring setup, access check data or declar |
74 | 74 | <Tip> |
75 | 75 | 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. |
76 | 76 | </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 | +``` |
0 commit comments