diff --git a/ai/llms-txt.mdx b/ai/llms-txt.mdx new file mode 100644 index 00000000..2139440a --- /dev/null +++ b/ai/llms-txt.mdx @@ -0,0 +1,41 @@ +--- +title: 'llms.txt' +description: 'Use the Checkly llms.txt file to discover and crawl all available documentation pages as markdown.' +sidebarTitle: 'llms.txt' +--- + +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. + +```txt llms.txt (first 15 lines) +# Checkly Docs + +## Docs + +- [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 +- [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 +- [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 +- [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. +- [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 +- [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. +- [Role Based Access Control in Checkly](https://checklyhq.com/docs/admin/team-management/rbac.md): Checkly roles and permissions for team members +- [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 +- [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 +- [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 +- [Team management in Checkly](https://checklyhq.com/docs/admin/team-management.md): Manage your team and collaborate effectively in Checkly +``` + +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. + +```bash +# Fetch the llms.txt index +curl https://www.checklyhq.com/llms.txt + +# Fetch a specific page from the index +curl https://checklyhq.com/docs/detect/synthetic-monitoring/browser-checks/overview.md +``` + +## Additional resources + +- [Markdown Access](/ai/markdown-access) +- [Checkly Skills](/ai/skills) +- [Checkly Rules](/ai/rules) diff --git a/ai/markdown-access.mdx b/ai/markdown-access.mdx new file mode 100644 index 00000000..828f5399 --- /dev/null +++ b/ai/markdown-access.mdx @@ -0,0 +1,64 @@ +--- +title: 'Markdown Access' +description: 'Access Checkly documentation as markdown to use with AI assistants and coding agents.' +sidebarTitle: 'Markdown Access' +--- + +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. + + +Use [Checkly Skills](/ai/skills) to automatically provide your agent with up-to-date, agent-optimized documentation. + + +## .md endpoints + +Append `.md` to any documentation URL to get the markdown version of that page. + +**Example:** + +- **HTML:** `https://www.checklyhq.com/docs/what-is-checkly/` +- **Markdown:** `https://www.checklyhq.com/docs/what-is-checkly.md` + +The markdown version includes the full page content in plain markdown, code blocks, links preserved as markdown links, and tables formatted as markdown tables. + +```bash +# Fetch documentation content with curl +curl https://www.checklyhq.com/docs/what-is-checkly.md + +# Pipe directly to your clipboard +curl https://www.checklyhq.com/docs/what-is-checkly.md | pbcopy +``` + +## Content negotiation + +You can also request markdown by setting the `Accept` header to `text/markdown`: + +```bash +curl -H "Accept: text/markdown" https://www.checklyhq.com/docs/what-is-checkly/ +``` + +This is useful when integrating with tools or scripts that set request headers programmatically. + + +Modern coding agents set [these headers automatically when querying documentation](https://www.checklyhq.com/blog/state-of-ai-agent-content-negotation/). + + +## Copy as Markdown button + +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. + +This is the fastest way to grab documentation for a specific topic and paste it into your AI assistant's context. + +```text +Here is the Checkly Browser Checks documentation: + +[paste markdown content] + +Based on this, how do I set up a browser check with a custom user agent? +``` + + +## Additional resources + +- [Checkly Skills](/ai/skills) +- [Checkly Rules](/ai/rules) diff --git a/integrations/ai/overview.mdx b/ai/overview.mdx similarity index 79% rename from integrations/ai/overview.mdx rename to ai/overview.mdx index 7f5dc090..90644a33 100644 --- a/integrations/ai/overview.mdx +++ b/ai/overview.mdx @@ -44,14 +44,14 @@ Provide the necessary Checkly context and let your AI agent of choice do the res ## Add Checkly context to your AI agent conversation -Install [Checkly Skills](/integrations/ai/skills) or add the [Checkly Rules](/integrations/ai/rules) to your AI conversation to give your AI agent enough context to perform Checkly-related tasks. +Install [Checkly Skills](/ai/skills) or add the [Checkly Rules](/ai/rules) to your AI conversation to give your AI agent enough context to perform Checkly-related tasks. - + Let your agents pull in all required Checkly context on demand. - + Include the entire Checkly context in commands or documentation. @@ -67,9 +67,9 @@ Include the entire Checkly context in commands or documentation. 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. -**With Monitoring as Code, Checkly already provides a native way to control your monitoring infrastructure via code and the command line.** +**With Monitoring as Code and agent-friendly CLI commands, Checkly already provides a native way to control your monitoring infrastructure via code and access monitoring results via the command line.** -Whether you need to create new resources or update existing ones, AI can write and update the necessary construct files and execute the Checkly CLI commands autonomously. +Whether you need to configure your monitoring setup, access check data or declare incidents, AI can write and update the necessary construct files and execute the Checkly CLI commands autonomously. 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. diff --git a/integrations/ai/rules.mdx b/ai/rules.mdx similarity index 96% rename from integrations/ai/rules.mdx rename to ai/rules.mdx index 0e185f93..d57192d3 100644 --- a/integrations/ai/rules.mdx +++ b/ai/rules.mdx @@ -1,12 +1,16 @@ --- title: 'Checkly Rules' description: 'Add Checkly rules files to your AI agent to provide monitoring context for your coding workflow.' -sidebarTitle: 'Checkly Rules' +sidebarTitle: 'Rules' --- import AgentExamples from "/snippets/agent-example.mdx" import { YoutubeEmbed } from "/snippets/youtube-embed.jsx" + +Use the Checkly Skills instead if your coding agents supports [Agent Skills](https://agentskills.io). + + The [`checkly.rules.md` file](https://www.checklyhq.com/docs/ai/checkly.rules.md) includes best practices, example code and required CLI commands to give your AI workflow enough context to perform Checkly-related tasks. Once the Checkly rules are included in your AI context window, your agent can effectively assist you in managing your monitoring setup. diff --git a/integrations/ai/skills.mdx b/ai/skills.mdx similarity index 79% rename from integrations/ai/skills.mdx rename to ai/skills.mdx index 10f8f629..ce00cb95 100644 --- a/integrations/ai/skills.mdx +++ b/ai/skills.mdx @@ -1,16 +1,19 @@ --- title: 'Checkly Skills' description: 'Install Checkly skills to give your AI agent on-demand monitoring context and capabilities.' -sidebarTitle: 'Checkly Skills' +sidebarTitle: 'Skills' --- Skills are reusable and modular capabilities for AI agents. They provide procedural knowledge that helps agents accomplish Checkly tasks more effectively. Think of Checkly Skills as plugins or extensions that enhance what your AI agent can do with your monitoring infrastructure. [Agent Skills](https://agentskills.io) are an open standard supported by many AI agents and coding assistants including Claude Code, Cursor, OpenAI Codex, Gemini CLI, GitHub Copilot, and others. If your agent supports skills, you can use the Checkly Skills to manage your monitoring setup. -Use [the `skills` CLI](https://www.npmjs.com/package/skills) to install [Checkly skills](https://github.com/checkly/checkly-cli/tree/main/skills/checkly) globally or in your project: +Use [the Checkly CLI `skills` command](/cli/checkly-skills#checkly-skills-install) to install [Checkly skills](https://github.com/checkly/checkly-cli/tree/main/skills/checkly) globally or in your project: ```bash +npx checkly skills install + +# or if you prefer the `skills` CLI npx skills add checkly/checkly-cli ``` @@ -32,7 +35,7 @@ This will make the Checkly Skills available to your AI agent. When your agent ne ⏺ I'll create a new URLMonitor for example.com! ``` -Using [Monitoring as Code](/concepts/monitoring-as-code), you can now control your monitoring setup with AI agents without needing a specific MCP server or API for your monitoring. Just give your agent the necessary context and let it use the Checkly Skills to manage your monitoring setup effectively. +Using [Monitoring as Code](/concepts/monitoring-as-code), you can now control your monitoring setup with AI agents without needing a specific MCP server or API for your monitoring. Tell your agent what you want to do and it will access the necessary context and use the CLI to manage your monitoring setup effectively. ## Additional resources diff --git a/cli/checkly-skills.mdx b/cli/checkly-skills.mdx index 36a701a9..bbf99c04 100644 --- a/cli/checkly-skills.mdx +++ b/cli/checkly-skills.mdx @@ -8,7 +8,7 @@ sidebarTitle: 'checkly skills' The `checkly skills` command outputs Markdown-formatted context about your Checkly project, describing monitoring capabilities and how to use them programmatically. **This context is designed to be discovered and consumed by AI agents and LLMs**, giving them the information they need to work with your monitoring setup. -You can also install [Checkly Skills as an agent skill](/integrations/ai/skills) to let your AI agent automatically discover and use the `checkly skills` command. +You can also install [Checkly Skills as an agent skill](/ai/skills) to let your AI agent automatically discover and use the `checkly skills` command. Before using `checkly skills`, ensure you have: @@ -31,6 +31,7 @@ npx checkly skills [resource] | Action | Description | |--------|-------------| +| `install` | Install [the Checkly agent skill (SKILL.md)](/ai/skills) into your project. | | `initialize` | Let your agent initialize [a new Checkly project](/constructs/project). | | `configure` | Let your agent configure [Checkly constructs](/constructs/overview). | | `investigate` | Access check status, analyze failures, and investigate errors. | diff --git a/cli/overview.mdx b/cli/overview.mdx index a50ee8ff..c26b8d69 100644 --- a/cli/overview.mdx +++ b/cli/overview.mdx @@ -64,10 +64,10 @@ Checkly is designed to work with Agents, AI IDEs, and Copilots. You can use your Checks, Browser Checks and all other constructs. - + Install Checkly Skills and let AI agents generate Checkly monitoring code for you. - + Include the Checkly Rules in your conversations to generate Checkly monitoring code for you. diff --git a/docs.json b/docs.json index b4868941..204e87d8 100644 --- a/docs.json +++ b/docs.json @@ -341,16 +341,23 @@ ] }, { - "group": "Integrations", + "group": "AI", "pages": [ { - "group": "AI Agents & Coding Assistants", + "group": "Agent resources", "pages": [ - "integrations/ai/overview", - "integrations/ai/skills", - "integrations/ai/rules" + "ai/overview", + "ai/skills", + "ai/markdown-access", + "ai/llms-txt", + "ai/rules" ] - }, + } + ] + }, + { + "group": "Integrations", + "pages": [ { "group": "Alerts & Notifications", "pages": [ diff --git a/guides/agentic-workflows.mdx b/guides/agentic-workflows.mdx index 535cd169..1eb42bc3 100644 --- a/guides/agentic-workflows.mdx +++ b/guides/agentic-workflows.mdx @@ -31,7 +31,7 @@ Before your AI assistant can effectively configure Checkly monitoring, it needs ### Add the Checkly rules file -Download [the official Checkly rules file](/integrations/ai/overview) and add it to your project. This file contains instructions on project structure, CLI commands, links to documentation and code examples for all the different Checkly check types. +Download [the official Checkly rules file](/ai/overview) and add it to your project. This file contains instructions on project structure, CLI commands, links to documentation and code examples for all the different Checkly check types. ```md checkly.rules.md # Checkly @@ -498,4 +498,4 @@ As mentioned in the beginning: **Checkly is by definition AI-ready** without com - Test your monitoring configuration before deploying. Use `npx checkly test` to validate checks locally before pushing to production. - Your AI agent might deploy your monitoring when running in YOLO or `--skip-permissions` mode. Be aware of this risk and implement guard rails. -For complete documentation on AI integrations, see [the AI overview](/integrations/ai/overview). +For complete documentation on AI integrations, see [the AI overview](/ai/overview). diff --git a/sitemap-crawl.md b/sitemap-crawl.md index 69a3816d..8b13fe2b 100644 --- a/sitemap-crawl.md +++ b/sitemap-crawl.md @@ -187,12 +187,15 @@ This file contains all valid URLs extracted from docs.json organized by director - /resolve/traces/instrumentation/java - /resolve/traces/instrumentation/dotnet -## Integrations +## AI + +- /ai/overview +- /ai/skills +- /ai/markdown-access +- /ai/llms-txt +- /ai/rules -### Integrations - AI -- /integrations/ai/overview -- /integrations/ai/skills -- /integrations/ai/rules +## Integrations ### Integrations - Alerts & Notifications - /integrations/alerts/discord diff --git a/snippets/agent-example.mdx b/snippets/agent-example.mdx index 01e90061..2af0390a 100644 --- a/snippets/agent-example.mdx +++ b/snippets/agent-example.mdx @@ -1,11 +1,16 @@ -"Can you create a new `BrowserCheck` monitoring `example.com`" - - - -"What are the currently used monitoring locations?" +"Can you set up a new `BrowserCheck` for `example.com`?" "Can you change all checks to run every 5 minutes instead of every 10 minutes?" + + +"I just received an alert. Can you tell me details about the failing checks?" + + + +"Can you please open an incident and investigate a fix?" + +