- Home
- MCP servers
- MCP Uptime Kuma Server
MCP Uptime Kuma Server
- typescript
13
GitHub Stars
typescript
Language
2 months ago
First Indexed
3 weeks ago
Catalog Refreshed
Documentation & install
Readme and setup notes from the catalogue, plus a client-ready config you can copy for your MCP host.
You can connect to Uptime Kuma monitors in real time through MCP, enabling you to query monitor data, view heartbeats, and receive instant status changes via transports that suit your setup. This server supports both local stdio and remote streamable HTTP transports for flexible integration with your MCP client.
How to use
Choose a transport that matches your environment. For a local setup, run the MCP server as a stdio process and connect using the provided command. For remote deployments, run the MCP server as a streamable HTTP service and point your MCP client to its HTTP endpoint. Once connected, you can retrieve monitor overviews, full monitor lists, monitor types, and detailed settings, or manage monitors by pausing, resuming, or inspecting heartbeats.
How to install
Prerequisites: Node.js and npm or a container runtime if you plan to use Docker. Ensure you have access to your Uptime Kuma instance and valid credentials.
Option A: Run via stdio transport (local process) using npx.
{
"mcpServers": {
"uptime-kuma": {
"command": "npx",
"args": ["-y", "@davidfuchs/mcp-uptime-kuma"],
"env": {
"UPTIME_KUMA_URL": "http://your-uptime-kuma-instance:3001",
"UPTIME_KUMA_USERNAME": "your_username",
"UPTIME_KUMA_PASSWORD": "your_password"
}
}
}
}
Option B: Run via streamable HTTP transport (Docker). Use either the Docker image directly or via Docker Compose.
docker run -d \
--name mcp-uptime-kuma \
-p 3000:3000 \
-e UPTIME_KUMA_URL=http://your-uptime-kuma-instance:3001 \
-e UPTIME_KUMA_USERNAME=your_username \
-e UPTIME_KUMA_PASSWORD=your_password \
davidfuchs/mcp-uptime-kuma:latest \
-t streamable-http
docker compose up -d
After starting, configure your MCP client to connect to the provided endpoint. Example configuration for an HTTP endpoint is shown below. Use the URL exposed by your deployment, typically something like http://localhost:3000/mcp.
{
"mcpServers": {
"uptime-kuma": {
"url": "http://localhost:3000/mcp",
"type": "http",
"args": []
}
}
}
Additional configuration notes
Authentication methods are available to secure access to Uptime Kuma through MCP. Anonymous access is possible if your Uptime Kuma instance allows it. JWT tokens are recommended for two-factor authentication users and take precedence when provided.
The MCP server exposes a set of tools to interact with monitors and heartbeats. You can quickly get an overview of all monitors, list detailed monitor configurations, inspect types, and manage monitor operation by pausing or resuming checks. You can also fetch heartbeat histories and retrieve current server settings.
Tools and capabilities overview
The following operations are available to interact with Uptime Kuma through MCP:
- getMonitorSummary: Retrieve a quick overview of all monitors with their current status. Supports filtering.
- listMonitors: Retrieve the full list of all monitors with configurations. Supports filtering.
- listMonitorTypes: Retrieve all available monitor types supported by Uptime Kuma.
- getMonitor: Retrieve detailed configuration for a specific monitor by ID.
- pauseMonitor: Pause a monitor to stop performing checks.
- resumeMonitor: Resume a paused monitor to restart checks.
- listHeartbeats: Retrieve status check history for all monitors.
- getHeartbeats: Retrieve status check history for a specific monitor.
- getSettings: Retrieve Uptime Kuma server settings.
Security and environment considerations
Keep credentials secure. Use separate credentials for each deployment and avoid embedding sensitive information in client configurations. When using JWT authentication, ensure tokens are stored securely and refreshed as needed.
Troubleshooting tips
If the MCP client fails to connect, verify the MCP endpoint URL, network reachability, and authentication method. Check environment variables for correctness and ensure the Uptime Kuma instance is accessible from the MCP server.
Available tools
getMonitorSummary
Get a quick overview of all monitors with their current status. Supports filtering.
listMonitors
Get the full list of all monitors with configurations. Supports filtering.
listMonitorTypes
Get all available monitor types supported by Uptime Kuma.
getMonitor
Get detailed configuration for a specific monitor by ID.
pauseMonitor
Pause a monitor to stop performing checks.
resumeMonitor
Resume a paused monitor to restart checks.
listHeartbeats
Get status check history for all monitors.
getHeartbeats
Get status check history for a specific monitor.
getSettings
Get Uptime Kuma server settings.