diff --git a/ai/mcp-server/setup.mdx b/ai/mcp-server/setup.mdx index 01c57599..511ddcb6 100644 --- a/ai/mcp-server/setup.mdx +++ b/ai/mcp-server/setup.mdx @@ -80,6 +80,10 @@ claude mcp add --transport http checkly https://api.checklyhq.com/mcp Start a Claude Code session and complete the OAuth flow when prompted. + +A Checkly Connector has been submitted to Anthropic and is awaiting review. Once approved, you can connect Checkly directly from the connector directory instead of adding the server manually. + + **Devin CLI** diff --git a/ai/plugin.mdx b/ai/plugin.mdx new file mode 100644 index 00000000..f5fae8a0 --- /dev/null +++ b/ai/plugin.mdx @@ -0,0 +1,99 @@ +--- +title: 'Checkly Plugin for AI Coding Agents' +description: 'Install the Checkly plugin to give your AI coding agent Checkly monitoring skills and Playwright best practices in a single package.' +sidebarTitle: 'Plugin' +canonical: 'https://www.checklyhq.com/docs/ai/plugin/' +--- + +The [Checkly plugin](https://github.com/checkly/checkly-plugin) bundles the official Checkly skills and the Checkly MCP server for AI coding agents in a single installable package. It targets Claude Code, OpenAI Codex, Cursor, and any agent supporting the plugins standard. + +## Getting started + +### Installation + + + + Add the Checkly plugin marketplace and install the plugin from within Claude Code: + + ```txt + /plugin marketplace add checkly/checkly-plugin + /plugin install checkly@checkly + ``` + + + 1. Open the plugin settings and click **Add marketplace**. + 2. Select **Add from a repository**. + 3. Enter `https://github.com/checkly/checkly-plugin/` as the URL and click **Sync**. + + + The 'Add marketplace' dialog with the Checkly plugin repository URL entered and automatic syncing enabled + + + 4. Install the Checkly plugin from the newly added marketplace. + + + The plugin directory listing the Checkly plugin from the checkly-plugin marketplace with an install button + + + + + +The Checkly plugin has been submitted to Anthropic and is awaiting review. Until it's approved, install it from the GitHub repository as described above. + + +After installation, restart your AI agent to load the plugin. + +## What the plugin provides + +### MCP server + +The plugin configures the [Checkly MCP server](/ai/mcp-server), connecting your agent to your Checkly account for live operations like inspecting check status and results, triggering checks, or starting root cause analyses. + +### Skills + +The plugin also ships two skills. Both are synced daily from their source repositories, so you always get the latest guidance. + +| Skill | Description | +| --- | --- | +| `checkly` | Set up, create, test, and manage monitoring checks with the Checkly CLI. See [Checkly Skills](/ai/skills) for details on what the skill covers. | +| `playwright-best-practices-for-agents` | Agent-first best practices for writing, structuring, debugging, and stabilizing Playwright tests. | + +## Usage + +Once installed, your agent automatically loads the relevant skill whenever a Checkly or Playwright task comes up — no manual context loading required. + +```txt Claude Code Example highlight={3-4} +❯ Can you create a new URLMonitor with Checkly for example.com? + +⏺ Skill(checkly:checkly) + ⎿ Successfully loaded skill · 3 tools allowed + +⏺ Let me read more references and check the existing project structure +``` + +In agents supporting slash commands, you can also invoke the bundled skills explicitly: + +```txt +/checkly:checkly +/checkly:playwright-best-practices-for-agents +``` + + +If you only want the Checkly monitoring skill without the plugin wrapper, install it directly via the Checkly CLI. See [Checkly Skills](/ai/skills). + + +## Reporting issues + +If a skill gives incorrect advice or the plugin doesn't behave as expected, [file an issue on GitHub](https://github.com/checkly/checkly-plugin/issues). + +## Additional resources + +- [checkly/checkly-plugin on GitHub](https://github.com/checkly/checkly-plugin) +- [Checkly Skills](/ai/skills) +- [Agent Skills Specification](https://agentskills.io/specification.md) diff --git a/ai/skills.mdx b/ai/skills.mdx index afa127b3..9bc74484 100644 --- a/ai/skills.mdx +++ b/ai/skills.mdx @@ -25,6 +25,10 @@ npx skills add checkly/checkly-cli After installation, restart your AI agent to load the skills. + +Prefer a plugin? The [Checkly plugin](/ai/plugin) bundles this skill together with Playwright best practices for Claude Code, OpenAI Codex, Cursor, and other agents. + + ## Usage Now when your agent needs to perform a Checkly-related task, it can automatically pull in the relevant context and use the provided instructions and resources to execute the task effectively. diff --git a/docs.json b/docs.json index d3ce24c6..ed2e48a8 100644 --- a/docs.json +++ b/docs.json @@ -382,6 +382,7 @@ "ai/mcp-server/troubleshooting" ] }, + "ai/plugin", "ai/skills", "ai/markdown-access", "ai/llms-txt" diff --git a/images/plugin-add-marketplace.png b/images/plugin-add-marketplace.png new file mode 100644 index 00000000..9a698d90 Binary files /dev/null and b/images/plugin-add-marketplace.png differ diff --git a/images/plugin-directory-install.png b/images/plugin-directory-install.png new file mode 100644 index 00000000..34ef65d5 Binary files /dev/null and b/images/plugin-directory-install.png differ diff --git a/sitemap.xml b/sitemap.xml index 987ae4da..3edb6c77 100644 --- a/sitemap.xml +++ b/sitemap.xml @@ -51,6 +51,9 @@ https://www.checklyhq.com/docs/ai/overview/ + + https://www.checklyhq.com/docs/ai/plugin/ + https://www.checklyhq.com/docs/ai/rocky-ai/