Skip to content

docs: update MCP check stats tool reference #407

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
thebiglabasky merged 1 commit into from
Jun 25, 2026
Merged

docs: update MCP check stats tool reference #407

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions ai/mcp-server/tools.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,19 +32,21 @@ Prepare the local Checkly CLI steps to create a browser check for checkout.

| Tool | Type | Description |
| --- | --- | --- |
| `get-check-status` | Read | Return a paginated, filterable list of current check status rows, including check type, activation state, and passing, degraded, or failing state. |
| `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 `get-check-status` filters instead of asking for every check at once. The tool supports:
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.

Expand Down
Loading