Skip to main content

Agent for interacting with Uptime Kuma API

Project description

Uptime Kuma Agent - A2A | AG-UI | MCP

PyPI - Version MCP Server PyPI - Downloads GitHub Repo stars GitHub forks GitHub contributors PyPI - License GitHub

GitHub last commit (by committer) GitHub pull requests GitHub closed pull requests GitHub issues

GitHub top language GitHub language count GitHub repo size GitHub repo file count (file type) PyPI - Wheel PyPI - Implementation

Version: 0.10.0

Overview

Uptime Kuma Agent MCP Server + A2A Agent

Agent for interacting with Uptime Kuma API

This repository is actively maintained - Contributions are welcome!

MCP

Using as an MCP Server

The MCP Server can be run in two modes: stdio (for local testing) or http (for networked access).

Environment Variables

  • UPTIME_KUMA_URL: The URL of the target service.
  • UPTIME_KUMA_TOKEN: The API token or access token.

Run in stdio mode (default):

export UPTIME_KUMA_URL="http://localhost:8080"
export UPTIME_KUMA_TOKEN="your_token"
uptime-kuma-mcp --transport "stdio"

Run in HTTP mode:

export UPTIME_KUMA_URL="http://localhost:8080"
export UPTIME_KUMA_TOKEN="your_token"
uptime-kuma-mcp --transport "http" --host "0.0.0.0" --port "8000"

A2A Agent

Run A2A Server

export UPTIME_KUMA_URL="http://localhost:8080"
export UPTIME_KUMA_TOKEN="your_token"
uptime-kuma-agent --provider openai --model-id gpt-4o --api-key sk-...

Docker

Build

docker build -t uptime-kuma-agent .

Run MCP Server

docker run -d \
  --name uptime-kuma-agent \
  -p 8000:8000 \
  -e TRANSPORT=http \
  -e UPTIME_KUMA_URL="http://your-service:8080" \
  -e UPTIME_KUMA_TOKEN="your_token" \
  knucklessg1/uptime-kuma-agent:latest

Deploy with Docker Compose

services:
  uptime-kuma-agent:
    image: knucklessg1/uptime-kuma-agent:latest
    environment:
      - HOST=0.0.0.0
      - PORT=8000
      - TRANSPORT=http
      - UPTIME_KUMA_URL=http://your-service:8080
      - UPTIME_KUMA_TOKEN=your_token
    ports:
      - 8000:8000

Configure mcp.json for AI Integration (e.g. Claude Desktop)

{
  "mcpServers": {
    "uptime-kuma": {
      "command": "uv",
      "args": [
        "run",
        "--with",
        "uptime-kuma-agent",
        "uptime-kuma-mcp"
      ],
      "env": {
        "UPTIME_KUMA_URL": "http://your-service:8080",
        "UPTIME_KUMA_TOKEN": "your_token"
      }
    }
  }
}

Install Python Package

python -m pip install uptime-kuma-agent
uv pip install uptime-kuma-agent

Repository Owners

GitHub followers GitHub User's stars

MCP Configuration Examples

1. Standard IO (stdio) Deployment

{
  "mcpServers": {
    "uptime-kuma-agent": {
      "command": "uv",
      "args": [
        "run",
        "uptime-mcp"
      ],
      "env": {
        "AGENT_DESCRIPTION": "<YOUR_AGENT_DESCRIPTION>",
        "AGENT_SYSTEM_PROMPT": "<YOUR_AGENT_SYSTEM_PROMPT>",
        "DEFAULT_AGENT_NAME": "<YOUR_DEFAULT_AGENT_NAME>",
        "MONITORSTOOL": "True",
        "STATUSTOOL": "True",
        "UPTIME_KUMA_PASSWORD": "<YOUR_UPTIME_KUMA_PASSWORD>",
        "UPTIME_KUMA_TOKEN": "<YOUR_UPTIME_KUMA_TOKEN>",
        "UPTIME_KUMA_URL": "<YOUR_UPTIME_KUMA_URL>",
        "UPTIME_KUMA_USERNAME": "<YOUR_UPTIME_KUMA_USERNAME>"
      }
    }
  }
}

2. Streamable HTTP (SSE) Deployment

{
  "mcpServers": {
    "uptime-kuma-agent": {
      "command": "uv",
      "args": [
        "run",
        "uptime-mcp",
        "--transport",
        "http",
        "--host",
        "0.0.0.0",
        "--port",
        "8000"
      ],
      "env": {
        "AGENT_DESCRIPTION": "<YOUR_AGENT_DESCRIPTION>",
        "AGENT_SYSTEM_PROMPT": "<YOUR_AGENT_SYSTEM_PROMPT>",
        "DEFAULT_AGENT_NAME": "<YOUR_DEFAULT_AGENT_NAME>",
        "MONITORSTOOL": "True",
        "STATUSTOOL": "True",
        "UPTIME_KUMA_PASSWORD": "<YOUR_UPTIME_KUMA_PASSWORD>",
        "UPTIME_KUMA_TOKEN": "<YOUR_UPTIME_KUMA_TOKEN>",
        "UPTIME_KUMA_URL": "<YOUR_UPTIME_KUMA_URL>",
        "UPTIME_KUMA_USERNAME": "<YOUR_UPTIME_KUMA_USERNAME>"
      }
    }
  }
}

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

uptime_kuma_agent-0.10.0.tar.gz (13.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

uptime_kuma_agent-0.10.0-py3-none-any.whl (15.4 kB view details)

Uploaded Python 3

File details

Details for the file uptime_kuma_agent-0.10.0.tar.gz.

File metadata

  • Download URL: uptime_kuma_agent-0.10.0.tar.gz
  • Upload date:
  • Size: 13.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.3

File hashes

Hashes for uptime_kuma_agent-0.10.0.tar.gz
Algorithm Hash digest
SHA256 275d179f6ddbe6b7f61ad3699fdbb4308ad6aca060bd0d202152f89c16f1ff5c
MD5 bf6bd0de46b59bab2ee7b29128688235
BLAKE2b-256 f148c0c50f9b2914632826ac822570e1b170ffdc8a105cc9962688b04ad48335

See more details on using hashes here.

File details

Details for the file uptime_kuma_agent-0.10.0-py3-none-any.whl.

File metadata

File hashes

Hashes for uptime_kuma_agent-0.10.0-py3-none-any.whl
Algorithm Hash digest
SHA256 ab9b7934fc2ffd3985a7dd2e5e8d2fe45b510265e76856a308d1abd12031b860
MD5 700d325f436a6bdee0ed0c498b15600a
BLAKE2b-256 57d641426ea05f29394e2da2f927ef084d13ba5fe5fb1ba747c3bd5b15032ca4

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page