MCP server
Query and control your monitors from Claude, Cursor, Zed, or any MCP client.
PingBoard ships an MCP server (@pingboard/mcp) so your AI assistant can answer "what's down?" or schedule maintenance without you leaving the editor. It talks to a running PingBoard over its REST API — it works against localhost or a remote instance, and nothing is added to the container.
Setup
- In PingBoard, go to Settings → API tokens and create one. It's shown once — copy it now.
- Point the server at your instance with two environment variables:
| Variable | Example |
|---|---|
PINGBOARD_URL | http://localhost:3000 |
PINGBOARD_TOKEN | pb_... |
Claude Code
claude mcp add pingboard \
--env PINGBOARD_URL=http://localhost:3000 \
--env PINGBOARD_TOKEN=pb_... \
-- npx -y @pingboard/mcpClaude Desktop, Cursor, Zed
Add to the client's MCP config:
{
"mcpServers": {
"pingboard": {
"command": "npx",
"args": ["-y", "@pingboard/mcp"],
"env": {
"PINGBOARD_URL": "http://localhost:3000",
"PINGBOARD_TOKEN": "pb_..."
}
}
}
}Tools
Reading:
| Tool | What it answers |
|---|---|
list_monitors | What exists and what state it's in — optionally filtered by status |
get_monitor | Full config, recent heartbeats, and incident history for one check |
list_incidents | Every down→up transition, open or resolved |
list_status_pages | Public pages, their slugs, and how many monitors each publishes |
list_maintenance_windows | Scheduled downtime |
list_notification_channels | Where alerts go, and whether each channel is enabled |
run_check | Run one check right now without saving it — useful before creating a monitor |
Writing:
| Tool | Notes |
|---|---|
create_monitor | Attach channelIds, or failures page nobody |
set_monitor_paused | Pause or resume checks |
delete_monitor | Permanent — annotated destructive so clients confirm it |
resolve_incident | Manually close an open incident |
annotate_incident | Add an explanation; notes appear on the public status page |
schedule_maintenance | Preferred over pausing for planned downtime — heartbeats keep recording honestly |
Read-only tools are annotated as such, so clients can gate or confirm the rest.
Notes and boundaries
A token has the same access as the admin account — there are no scopes yet. Revoking it from Settings takes effect immediately, which also cuts off every MCP client using it.
Deliberately not included: anything that acts on the monitored systems. PingBoard observes; remediation belongs to whatever you actually run.
