plugin.json

{
  "$schema": "https://agent-plugins.org/schemas/1.0.0/plugin.schema.json",
  "name": "checkly",
  "version": "1.0.0",
  "description": "Checkly skills for creating, testing, and managing monitoring checks with AI coding agents.",
  "author": {
    "name": "Checkly",
    "url": "https://github.com/checkly"
  },
  "homepage": "https://www.checklyhq.com",
  "repository": "https://github.com/checkly/checkly-plugin",
  "license": "Apache-2.0",
  "keywords": [
    "checkly",
    "monitoring",
    "synthetic-monitoring",
    "playwright",
    "uptime",
    "api-monitoring",
    "browser-checks"
  ],
  "extensions": {
    "com.openai": {
      "review": {
        "test_cases": {
          "positive": [
            {
              "description": "Review the status of every check",
              "prompt": "Which of my Checkly checks are failing right now?",
              "tools_triggered": "show-check-status, show-check-list",
              "expected_behavior": "List the checks in the connected Checkly account with their current status and call out the failing ones. Only checks the connected account can see are reported."
            },
            {
              "description": "Inspect the latest result of a failing check",
              "prompt": "Show me the latest result for my API checks and explain what failed.",
              "tools_triggered": "list-check-results, get-check-result",
              "expected_behavior": "Fetch the most recent results for the account's API checks and summarise any failure, including response status and timing, without inventing values that the results do not contain."
            },
            {
              "description": "Create an API check from a description",
              "prompt": "Add an API check for https://example.com that runs every 10 minutes from Frankfurt and fails on a non-200 response.",
              "tools_triggered": "get-check-type-schema, create-check",
              "expected_behavior": "Read the API check schema, create the check in the connected account with the requested interval, location and assertion, then report the created check and its ID."
            },
            {
              "description": "Run a check on demand",
              "prompt": "Run my Login check now and tell me whether it passed.",
              "tools_triggered": "trigger-checks, get-check-result",
              "expected_behavior": "Trigger the named check, wait for the run to finish, and report pass or fail with the result of that run."
            },
            {
              "description": "Investigate a recurring failure",
              "prompt": "Investigate why my Products API check has been failing this morning.",
              "tools_triggered": "get-error-group-root-cause-analyses, trigger-root-cause-analysis, get-root-cause-analysis",
              "expected_behavior": "Look up an existing root cause analysis for the failing check or start one, then summarise the probable cause from the returned analysis without speculating beyond it."
            }
          ],
          "negative": [
            {
              "description": "Environment variable writes are not exposed",
              "prompt": "Set the CHECKLY_API_KEY environment variable in my Checkly account to a new secret."
            },
            {
              "description": "Deploy and infrastructure actions are out of scope",
              "prompt": "Roll back the last deploy - the API checks started failing after it."
            },
            {
              "description": "Billing and subscription changes are out of scope",
              "prompt": "Upgrade my Checkly subscription to the Enterprise plan and update the payment method."
            }
          ]
        },
        "demo_recording_url": "https://drive.google.com/file/d/1jhFK6kTJuk22ph2m7L-fcqaWPR6rbOd7/view?usp=sharing",
        "commerce": false,
        "commerce_description": "This plugin does not sell products or process payments. Checkly subscription and billing changes happen in the Checkly dashboard."
      },
      "publication": {
        "release_notes": "Initial directory release. Bundles the Checkly CLI skill and the Playwright best-practices skill, plus the Checkly MCP server for inspecting checks, results, test sessions and root cause analyses, running checks on demand, and managing API checks, monitors, check groups and status page incidents."
      },
      "interface": {
        "displayName": "Checkly",
        "shortDescription": "Synthetic monitoring as code",
        "longDescription": "Checkly is synthetic monitoring as code: API checks, browser checks, URL and uptime monitors, and Playwright Check Suites that run from global locations and alert you when something breaks.\n\nThis plugin bundles two skills and the Checkly MCP server. The skills teach Codex how to scaffold monitoring-as-code projects with the Checkly CLI, write API and browser checks, and apply Playwright best practices for stable end-to-end tests. The MCP server connects to your Checkly account so Codex can list and inspect checks, read check results and test sessions, trigger checks, run root cause analyses, and manage API checks, monitors, check groups, and status page incidents.\n\nIntended for developers and SREs who already use Checkly or want to add monitoring to a project without leaving their editor. A Checkly account is required; the MCP server authenticates with OAuth.\n\nLimitations: Playwright Check Suites and checks whose code lives in a repository are managed with the Checkly CLI, not through MCP tools. Environment variables can be read but not created or updated from this plugin.",
        "developerName": "Checkly",
        "category": "Developer Tools",
        "capabilities": [
          "Instructions",
          "Monitoring",
          "CLI workflows"
        ],
        "websiteURL": "https://www.checklyhq.com",
        "supportURL": "https://www.checklyhq.com/support/",
        "privacyPolicyURL": "https://www.checklyhq.com/privacy/",
        "termsOfServiceURL": "https://www.checklyhq.com/terms/",
        "defaultPrompt": [
          "Create a Checkly browser check for this flow.",
          "Add API monitoring for this endpoint.",
          "Investigate failing Checkly checks."
        ],
        "brandColor": "#0075FF",
        "composerIcon": "./assets/checkly-logo.png",
        "logo": "./assets/checkly-logo.png"
      },
      "apps": "./.app.json"
    }
  }
}