diff --git a/ai/mcp-server.mdx b/ai/mcp-server.mdx index 84499ca4..1b563896 100644 --- a/ai/mcp-server.mdx +++ b/ai/mcp-server.mdx @@ -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. @@ -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) diff --git a/ai/mcp-server/interactive-views.mdx b/ai/mcp-server/interactive-views.mdx new file mode 100644 index 00000000..cac5ea3d --- /dev/null +++ b/ai/mcp-server/interactive-views.mdx @@ -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. + + +- [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. + + +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. +``` + + + Checkout API check card showing passing status, production and payments tags, availability, and P95 and P99 response times. + + +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. +``` + + + Interactive list of checks with check-type icons, current status badges, and Previous and Next pagination controls. + + +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. +``` + + + Checkout API response-time chart showing average and P95 time series with controls for average, P50, P95, and P99. + + +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). diff --git a/ai/mcp-server/tools.mdx b/ai/mcp-server/tools.mdx index e9c237b2..cd8e7ff3 100644 --- a/ai/mcp-server/tools.mdx +++ b/ai/mcp-server/tools.mdx @@ -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 | diff --git a/ai/mcp-server/troubleshooting.mdx b/ai/mcp-server/troubleshooting.mdx index 386c6fae..80a7de0f 100644 --- a/ai/mcp-server/troubleshooting.mdx +++ b/ai/mcp-server/troubleshooting.mdx @@ -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 diff --git a/docs.json b/docs.json index 24655442..e8cfc46a 100644 --- a/docs.json +++ b/docs.json @@ -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" diff --git a/images/ai/mcp/check-list.png b/images/ai/mcp/check-list.png new file mode 100644 index 00000000..73e5e0a3 Binary files /dev/null and b/images/ai/mcp/check-list.png differ diff --git a/images/ai/mcp/check-status.png b/images/ai/mcp/check-status.png new file mode 100644 index 00000000..ded42e58 Binary files /dev/null and b/images/ai/mcp/check-status.png differ diff --git a/images/ai/mcp/response-time.png b/images/ai/mcp/response-time.png new file mode 100644 index 00000000..80b857e7 Binary files /dev/null and b/images/ai/mcp/response-time.png differ diff --git a/sitemap.xml b/sitemap.xml index fb745d5b..238e85cb 100644 --- a/sitemap.xml +++ b/sitemap.xml @@ -45,6 +45,9 @@ https://www.checklyhq.com/docs/ai/mcp-server/ + + https://www.checklyhq.com/docs/ai/mcp-server/interactive-views/ + https://www.checklyhq.com/docs/ai/mcp-server/security-and-permissions/