Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 2 additions & 0 deletions ai/mcp-server.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ You can create and update standalone Browser and Multistep Checks through MCP us
- Inspect account membership, plan, and feature entitlements.
- Create, read, update, and delete synthetic checks, uptime monitors, and groups.
- Check which checks are passing, failing, muted, or deactivated.
- Display [interactive check cards, check lists, and response-time charts](/ai/mcp-server/interactive-views) in clients that support MCP Apps.
- Read compact check results and test session results.
- Fetch normalized result asset manifests and bounded text assets.
- Start or read Rocky AI root cause analyses.
Expand Down Expand Up @@ -100,6 +101,7 @@ See [Skills, MCP, and the CLI](/ai/overview#skills-mcp-and-the-cli) for a full c
## Learn more

- [Set up the MCP server](/ai/mcp-server/setup)
- [Interactive views](/ai/mcp-server/interactive-views)
- [MCP tools reference](/ai/mcp-server/tools)
- [Security and permissions](/ai/mcp-server/security-and-permissions)
- [Troubleshooting](/ai/mcp-server/troubleshooting)
76 changes: 76 additions & 0 deletions ai/mcp-server/interactive-views.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,76 @@
---
title: 'Interactive MCP views'
description: 'View check status, browse checks, and explore response times directly in your AI conversation with Checkly MCP Apps.'
sidebarTitle: 'Interactive views'
canonical: 'https://www.checklyhq.com/docs/ai/mcp-server/interactive-views/'
---

Checkly MCP UI brings check cards, check lists, and response-time charts into your AI conversation. You can inspect your monitoring data and ask follow-up questions without leaving the chat.

Interactive views are available on every Checkly account.

<Accordion title="Before you begin">
- [Connect the Checkly MCP Server](/ai/mcp-server/setup) to your client.
- Use a client that supports [MCP Apps](https://modelcontextprotocol.io/extensions/apps/overview), such as Claude Desktop. Support for MCP tools alone does not guarantee that a client can display interactive views.
- Allow the `checkly:checks:read` session permission and use an account role with [`checks:read`](/admin/team-management/permissions) access.
</Accordion>

You use the same MCP endpoint and authentication as other Checkly tools. If you have access to several accounts, name the account in your prompt or [select a default account](/ai/mcp-server/setup#select-an-account).

## Check status

Ask for a check card to see one check's current status, type, tags, and availability and response-time percentiles over the last 24 hours, when available.

```text title="Prompt" wrap
Show an interactive status card for my Checkout API check.
```

<Frame caption="Check status card with sample data.">
<img src="/images/ai/mcp/check-status.png" alt="Checkout API check card showing passing status, production and payments tags, availability, and P95 and P99 response times." />
</Frame>

This view uses `show-check-status`. It shows aggregate metrics, without individual run history.

## Check list

Ask for a check list to browse current status. You can filter by name, tag, check type, or passing, failing, and degraded status.

```text title="Prompt" wrap
Show an interactive list of my Checkly checks.
```

<Frame caption="Paginated check list with sample data.">
<img src="/images/ai/mcp/check-list.png" alt="Interactive list of checks with check-type icons, current status badges, and Previous and Next pagination controls." />
</Frame>

This view uses `show-check-list` and displays up to 20 checks per page. Use **Previous** and **Next** to browse more results. Pagination keeps your filters. The list shows current status without historical metrics.

## Response-time chart

Ask for a chart to explore one check's response times. The default time window is the last 24 hours.

```text title="Prompt" wrap
Show an interactive response-time chart for my Checkout API check over the last 24 hours.
```

<Frame caption="Response-time chart with sample data.">
<img src="/images/ai/mcp/response-time.png" alt="Checkout API response-time chart showing average and P95 time series with controls for average, P50, P95, and P99." />
</Frame>

For a different window, include a start and end time in your prompt:

```text title="Prompt" wrap
Show a response-time chart for my Checkout API check from 09:00 UTC yesterday to 09:00 UTC today.
```

This view uses `show-check-response-time`. Time windows must be in the past, span at most seven days, and fall within your plan's data retention. Chart times use UTC, and periods without results appear as gaps.

Response-time charts are unavailable for Heartbeat, ICMP, traceroute, and SSL monitors.

## Refresh a view

Views show the data returned when you request them. Use **Refresh** to fetch the latest data, or ask a follow-up question to change the check, filters, or time window. Views do not refresh automatically.

All three views are read-only and use your existing [MCP permissions](/ai/mcp-server/security-and-permissions). They do not run checks or change your monitoring configuration.

If a view is missing or fails to load, see [Troubleshoot interactive views](/ai/mcp-server/troubleshooting#interactive-views).
12 changes: 12 additions & 0 deletions ai/mcp-server/tools.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -101,6 +101,18 @@ Update the "Checkout API" check to run every 10 minutes and add the tag critical
Trigger the checks tagged production-smoke, then poll the test session until results are available.
```

## Interactive view tools

These read-only tools display [interactive views](/ai/mcp-server/interactive-views) in clients that support MCP Apps. They require the `checkly:checks:read` session permission and `checks:read` account permission.

| Tool | Type | Description |
| --- | --- | --- |
| `show-check-status` | Read | Display one check's status card, with last-24-hour availability, P95, and P99 response times when available. |
| `show-check-list` | Read | Display a filtered check list with current status and up to 20 checks per page. Supports pagination without historical metrics. |
| `show-check-response-time` | Read | Display a response-time chart for one check. Defaults to the last 24 hours; custom past windows span at most seven days and must fall within your plan's data retention. |

Use these tools when you want a visual view in your conversation. For structured results, use `list-check-stats` or `get-check-performance-summary`.

## Check group tools

| Tool | Type | Description |
Expand Down
18 changes: 18 additions & 0 deletions ai/mcp-server/troubleshooting.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -97,6 +97,24 @@ To always use the same account, set the `X-Checkly-Account` header in your MCP s

Service API keys are already scoped to one account. If a service-key session reports that it cannot access the account in `X-Checkly-Account`, remove the header or set it to the account configured on the key.

## Interactive views

### A view appears as text or data

Confirm your client supports [MCP Apps](https://modelcontextprotocol.io/extensions/apps/overview). A client can support MCP tools without rendering interactive views. Ask explicitly for an interactive card, list, or chart so your agent uses `show-check-status`, `show-check-list`, or `show-check-response-time`.

If your client cannot display views, use `list-check-stats` or `get-check-performance-summary` to read the data.

### A view tool is missing or fails to load

1. Refresh your client's tools list or reconnect to Checkly.
2. Confirm the session has `checkly:checks:read` and your account role grants [`checks:read`](/admin/team-management/permissions).
3. Confirm the selected account contains the check you requested. See [Select an account](/ai/mcp-server/setup#select-an-account).

For response-time charts, use a past window of at most seven days within your plan's data retention. Heartbeat, ICMP, traceroute, and SSL monitors do not support this chart. Gaps in a chart indicate periods without results.

Views do not refresh automatically. Use **Refresh** to request current data. If a view still fails, contact [Checkly Support](mailto:support@checklyhq.com) with your client, account, view tool, and approximate time of the error.

## Local check authoring

### The MCP server cannot access or deploy my local project
Expand Down
1 change: 1 addition & 0 deletions docs.json
Original file line number Diff line number Diff line change
Expand Up @@ -377,6 +377,7 @@
"pages": [
"ai/mcp-server",
"ai/mcp-server/setup",
"ai/mcp-server/interactive-views",
"ai/mcp-server/tools",
"ai/mcp-server/security-and-permissions",
"ai/mcp-server/troubleshooting"
Expand Down
Binary file added images/ai/mcp/check-list.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/ai/mcp/check-status.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/ai/mcp/response-time.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 @@ -45,6 +45,9 @@
<url>
<loc>https://www.checklyhq.com/docs/ai/mcp-server/</loc>
</url>
<url>
<loc>https://www.checklyhq.com/docs/ai/mcp-server/interactive-views/</loc>
</url>
<url>
<loc>https://www.checklyhq.com/docs/ai/mcp-server/security-and-permissions/</loc>
</url>
Expand Down
Loading