> ## Documentation Index
> Fetch the complete documentation index at: https://www.checklyhq.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Checkly Plugin for AI Coding Agents

> Install the Checkly plugin to give your AI coding agent Checkly monitoring skills and Playwright best practices in a single package.

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

**Claude Code (CLI)**

Add the Checkly plugin marketplace and install the plugin from within Claude Code:

```txt theme={null}
/plugin marketplace add checkly/checkly-plugin
/plugin install checkly@checkly
```

**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**.

   ![The 'Add marketplace' dialog with the Checkly plugin repository URL entered and automatic syncing enabled](https://mintcdn.com/checkly-422f444a/9_c6PDdjcpmBrOs_/images/plugin-add-marketplace.png?fit=max\&auto=format\&n=9_c6PDdjcpmBrOs_\&q=85\&s=982ca73182cf83a88e449f862d99cdd3)

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](https://mintcdn.com/checkly-422f444a/9_c6PDdjcpmBrOs_/images/plugin-directory-install.png?fit=max\&auto=format\&n=9_c6PDdjcpmBrOs_\&q=85\&s=a231c207bb2ad88bbbecb8785b8b60a2)

**Codex & ChatGPT**

1. Open the plugin settings and click **Add marketplace**.

2. Enter `https://github.com/checkly/checkly-plugin` as the source and click **Add marketplace**.

   ![The 'Add plugin marketplace' dialog with the Checkly plugin repository URL entered as the source](https://mintcdn.com/checkly-422f444a/viVjDLu2QxPGHLR_/images/plugin-codex-add-marketplace.png?fit=max\&auto=format\&n=viVjDLu2QxPGHLR_\&q=85\&s=b4a0cb8e037a3b99ba6bd9bb0c223439)

3. Install the Checkly plugin from the newly added marketplace and connect it to your Checkly account.

   ![The Checkly plugin listed in the plugin directory with an install button](https://mintcdn.com/checkly-422f444a/viVjDLu2QxPGHLR_/images/plugin-codex-install.png?fit=max\&auto=format\&n=viVjDLu2QxPGHLR_\&q=85\&s=7cc4cb4ea727ddcb0d2e458481bdfb02)

4. Once installed, the plugin registers the [Checkly MCP server](https://www.checklyhq.com/docs/ai/mcp-server.md) so you can inspect checks, trigger runs, and investigate failures from Codex.

> [!NOTE]
>
> The Checkly plugin has been submitted to Anthropic and OpenAI 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](https://www.checklyhq.com/docs/ai/mcp-server.md), 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](https://www.checklyhq.com/docs/ai/skills.md) 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} theme={null}
❯ 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 theme={null}
/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](https://www.checklyhq.com/docs/ai/skills.md).

## 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](https://www.checklyhq.com/docs/ai/skills.md)
* [Agent Skills Specification](https://agentskills.io/specification.md)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.