Skip to content
4 changes: 4 additions & 0 deletions ai/mcp-server/setup.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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.

<Note>
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.
</Note>

<span id="devin-cli"></span>

**Devin CLI**
Expand Down
99 changes: 99 additions & 0 deletions ai/plugin.mdx
Original file line number Diff line number Diff line change
@@ -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

<Tabs>
<Tab title="Claude Code (CLI)">
Add the Checkly plugin marketplace and install the plugin from within Claude Code:

```txt
/plugin marketplace add checkly/checkly-plugin
/plugin install checkly@checkly
```
</Tab>
<Tab title="Claude Code (Desktop) & Claude Cowork">
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**.

<Frame>
<img
src="/images/plugin-add-marketplace.png"
alt="The 'Add marketplace' dialog with the Checkly plugin repository URL entered and automatic syncing enabled"
/>
</Frame>

4. Install the Checkly plugin from the newly added marketplace.

<Frame>
<img
src="/images/plugin-directory-install.png"
alt="The plugin directory listing the Checkly plugin from the checkly-plugin marketplace with an install button"
/>
</Frame>
</Tab>
</Tabs>

<Note>
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.
</Note>

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
```

<Note>
If you only want the Checkly monitoring skill without the plugin wrapper, install it directly via the Checkly CLI. See [Checkly Skills](/ai/skills).
</Note>

## 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)
4 changes: 4 additions & 0 deletions ai/skills.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,10 @@ npx skills add checkly/checkly-cli

After installation, restart your AI agent to load the skills.

<Note>
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.
</Note>

## 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.
Expand Down
1 change: 1 addition & 0 deletions docs.json
Original file line number Diff line number Diff line change
Expand Up @@ -382,6 +382,7 @@
"ai/mcp-server/troubleshooting"
]
},
"ai/plugin",
"ai/skills",
"ai/markdown-access",
"ai/llms-txt"
Expand Down
Binary file added images/plugin-add-marketplace.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/plugin-directory-install.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
3 changes: 3 additions & 0 deletions sitemap.xml
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,9 @@
<url>
<loc>https://www.checklyhq.com/docs/ai/overview/</loc>
</url>
<url>
<loc>https://www.checklyhq.com/docs/ai/plugin/</loc>
</url>
<url>
<loc>https://www.checklyhq.com/docs/ai/rocky-ai/</loc>
</url>
Expand Down
Loading