> ## Documentation Index > Fetch the complete documentation index at: https://checkly-422f444a-auto-update-api-spec.mintlify.site/llms.txt > Use this file to discover all available pages before exploring further. # Checkly MCP tools > Reference for the tools exposed by the Checkly MCP Server, grouped by workflow. This reference reflects the current MCP Server v1 tool surface. It is not a roadmap or a commitment to future tools. Each tool is shown only when the MCP session has the required permission. Some write tools also require a matching Checkly account role, such as Admin or Read & Write. ## Account tools | Tool | Type | Description | | ------------------------------- | ----- | -------------------------------------------------------------------------------------------------------------------------------- | | `whoami` | Read | Return the authenticated user and account memberships visible to the MCP session. | | `get-account-entitlements` | Read | Return the resolved account plan and feature entitlement state. | | `list-account-members` | Read | List account members and pending invites. | | `invite-account-member` | Write | Invite a user to the resolved account. OAuth-only. Requires Owner or Admin access, sends an invite email, and is not idempotent. | | `prepare-local-check-authoring` | Read | Return an account-aware runbook for creating, testing, and deploying check code with the local Checkly CLI. | Example prompts: ```text title="Prompt" wrap theme={null} Use Checkly to show which accounts I can access. ``` ```text title="Prompt" wrap theme={null} Prepare the local Checkly CLI steps to create a browser check for checkout. ``` ## Check tools | Tool | Type | Description | | ------------------------------- | ----- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `list-check-stats` | Read | Return a paginated, filterable list of checks with current pass, fail, and degraded status. Set `includeReliability` to also return availability, response-time percentiles, and ICMP latency or packet loss over a quick range. | | `list-check-results` | Read | List recent compact results for one check, including HTTP response status and assertion counts when available. Raw logs, traces, screenshots, videos, and download URLs are omitted. | | `get-check-result` | Read | Return compact detail for one check result. | | `get-check-performance-summary` | Read | Return average, P50, P95, and P99 response-time metrics for one check over a date range when data is available. | | `trigger-checks` | Write | Run existing deployed checks on demand and record the run as a test session. Consumes check-run execution quota. | For large accounts, start with `list-check-stats` filters instead of asking for every check at once. The default response is status-only. The tool supports: * `tag`: filter by one or more tags. * `type` or `checkType`: filter by check type. * `search`: filter by check name. * `status`: filter by `passing`, `failing`, or `degraded`. * `limit` and `page`: page through matching checks. The default page size is 25 and the maximum is 100. * `includeReliability`: set to `true` to include availability, response-time percentiles, and ICMP latency or packet-loss metrics. * `range`: set the analytics range when `includeReliability` is `true`. The default is `last24Hours`. The response includes pagination metadata (`length`, `total`, `page`, `limit`, and `totalPages`) plus the applied `filters`, so your client can continue with the next page only when needed. `list-check-results` stays compact for fast triage. Result rows include `responseStatusCode`, `responseStatusText`, `totalAssertions`, and `failingAssertions` when available, so your client can inspect common URL and API failure signals before fetching full result details or assets. `trigger-checks` only runs checks that already exist on the account. Use `prepare-local-check-authoring` and the Checkly CLI when you need to create, test, or deploy local check code. Example prompts: ```text title="Prompt" wrap theme={null} Show me the first page of failing API checks tagged production, then summarize what changed in their latest results. ``` ```text title="Prompt" wrap theme={null} Trigger the checks tagged production-smoke, then poll the test session until results are available. ``` ## Test session tools | Tool | Type | Description | | ------------------------- | ---- | ----------------------------------------------------------------------------------------------------- | | `list-test-sessions` | Read | List recent test sessions with filters and cursor ordering. | | `get-test-session` | Read | Return one test session and compact result rows. | | `get-test-session-result` | Read | Return compact detail for one test-session result, including useful run metadata and small summaries. | Example prompt: ```text title="Prompt" wrap theme={null} Find the latest failed test session and show me the failed result IDs. ``` ## Result asset tools | Tool | Type | Description | | --------------------------------- | ---- | -------------------------------------------------------------------------------------------------------------------------------------------------- | | `list-check-result-assets` | Read | Return a normalized asset manifest for a check result. | | `fetch-check-result-asset` | Read | Fetch one selected check-result asset. Text assets may be returned inline with a byte limit; binary or large assets return a download link. | | `list-test-session-result-assets` | Read | Return a normalized asset manifest for a test-session result. | | `fetch-test-session-result-asset` | Read | Fetch one selected test-session-result asset. Text assets may be returned inline with a byte limit; binary or large assets return a download link. | Example prompt: ```text title="Prompt" wrap theme={null} For the failed check result, list available assets and fetch the text log if one exists. ``` ## Root cause analysis tools | Tool | Type | Description | | ------------------------------------- | ----- | ----------------------------------------------------------------------------------------------------------------- | | `get-error-group-root-cause-analyses` | Read | Return a check or test-session error group and any existing root cause analyses. | | `get-root-cause-analysis` | Read | Return one root cause analysis by RCA ID. Pending analyses return compact polling status. | | `trigger-root-cause-analysis` | Write | Trigger a new RCA for a check or test-session error group. Requires run access and consumes RCA invocation quota. | Call `get-error-group-root-cause-analyses` before triggering a new RCA so your agent can reuse existing analysis when available. Example prompt: ```text title="Prompt" wrap theme={null} Check whether this error group already has an RCA. If it does not, ask me before triggering a new one. ``` ## Environment variable tools | Tool | Type | Description | | ------------------------------------- | ----- | -------------------------------------------------------------------------------------------- | | `list-account-environment-variables` | Read | List account-level variables and secrets. Secret values are returned as `null`. | | `get-account-environment-variable` | Read | Get one account-level variable by key. Secret values are returned as `null`. | | `create-account-environment-variable` | Write | Create an account-level variable or secret. Secret values are encrypted and not echoed back. | | `update-account-environment-variable` | Write | Update an account-level variable or secret by key. To update a secret, pass `secret: true`. | Example prompt: ```text title="Prompt" wrap theme={null} List account environment variables and tell me whether API_TOKEN is stored as a secret. ``` ## Status page tools | Tool | Type | Description | | ------------------- | ---- | ------------------------------------------------------------------------------ | | `list-status-pages` | Read | List status pages, including cards and services needed for incident targeting. | | `get-status-page` | Read | Get one status page with cards and services. | Example prompt: ```text title="Prompt" wrap theme={null} List my status pages and show the service IDs for the production page. ``` ## Incident tools | Tool | Type | Description | | ------------------------------ | ----- | ------------------------------------------------------------------------------------------------------------ | | `list-status-page-incidents` | Read | List status page incidents, optionally filtered by page and incident status. | | `get-status-page-incident` | Read | Get one status page incident with services and incident updates. | | `create-status-page-incident` | Write | Create a new status page incident and optionally notify subscribers. Not idempotent. | | `update-status-page-incident` | Write | Post a progress update to an existing incident and optionally notify subscribers. Not idempotent. | | `resolve-status-page-incident` | Write | Resolve an incident by posting a final resolved update and optionally notifying subscribers. Not idempotent. | Example prompts: ```text title="Prompt" wrap theme={null} Show open status page incidents and summarize their latest updates. ``` ```text title="Prompt" wrap theme={null} Draft a major status page incident for the API outage and wait for confirmation before notifying subscribers. ```