uptime-kuma-agent 0.23.2

Agent for interacting with Uptime Kuma API

Uptime Kuma Agent

CLI or API | MCP | Agent

Version: 0.23.2

---

Table of Contents

• Overview
• Key Features
• Environment Variables
• Usage & Quick Start
• MCP Architecture
• Agentic Graph Architecture
• Security & Access Governance
• Installation
• Contribution Guidelines

---

Overview

Uptime Kuma Agent is a production-grade Agent and Model Context Protocol (MCP) server designed to interface directly with Agent for interacting with Uptime Kuma API.

---

Key Features

• Consolidated Action-Routed MCP Tools: Minimizes token overhead and eliminates tool bloat in LLM contexts by grouping methods into optimized, togglable tool modules.
• Enterprise-Grade Security: Comprehensive support for Eunomia policies, OIDC token delegation, and granular execution context tracking.
• Integrated Graph Agent: Built-in Pydantic AI agent supporting the Agent Control Protocol (ACP) and standard Web interfaces (AG-UI).
• Native Telemetry & Tracing: Out-of-the-box OpenTelemetry exports and native Langfuse tracing.

---

Environment Variables

The agent's behavior and connections can be fully configured via environment variables.

Environment Variable	Source Type	Default Value	Description
HOST	System / Docker	0.0.0.0	IP interface address for the MCP and Agent servers to bind to.
PORT	System / Docker	8000	Port number for HTTP/SSE transports.
TRANSPORT	System / Docker	stdio	MCP transport channel. Supported values: stdio, streamable-http, sse.
SUPERTOKEN	Auth / Security	None	Optional master bearer token for client request validation.
UPTIME_KUMA_URL	App Credential	http://localhost:3001	The base URL of your target Uptime Kuma instance.
AUTH_TYPE	App Credential	None	Type of authentication used. Supported values: password, token.
UPTIME_KUMA_TOKEN	App Credential	None	Authentication token (if AUTH_TYPE is token).
UPTIME_KUMA_USERNAME	App Credential	None	Login username (if AUTH_TYPE is password).
UPTIME_KUMA_PASSWORD	App Credential	None	Login password (if AUTH_TYPE is password).
MONITORSTOOL	Toggle switch	True	Set to False to completely disable the uptime_kuma_monitors MCP tool.
STATUSTOOL	Toggle switch	True	Set to False to completely disable the uptime_kuma_status MCP tool.
ENABLE_OTEL	Tracing Switch	True	Enable telemetry exports via OpenTelemetry standards.
OTEL_EXPORTER_OTLP_ENDPOINT	Tracing	http://langfuse.arpa/api/public/otel	Core endpoint URL for exporting tracing and span data.
EUNOMIA_TYPE	Governance	none	Policy enforcement style. Options: none, embedded, remote.
EUNOMIA_POLICY_FILE	Governance	mcp_policies.json	Path to your local Eunomia JSON policy parameters.

---

Usage & Quick Start

To bootstrap and run the agent:

1. Configure Environment: Create a .env file from the provided template:

   cp .env.example .env
   # Add your target Uptime Kuma credentials
   

2. Run MCP Server locally via CLI:

   uv run uptime-mcp
   

3. Interact with the Pydantic AI Graph Agent CLI:

   uv run uptime-agent --provider openai --model-id gpt-4o
   

---

MCP

This server utilizes dynamic Action-Routed tools to optimize token overhead and maximize IDE compatibility.

Available MCP Tools

Tool Module	Toggle Env Var	Enabled by Default	Description & Nested Methods
Monitors	MONITORSTOOL	True	Manage uptime kuma monitors operations. Action-routed methods: add_monitor, delete_monitor, edit_monitor, get_monitor, get_monitors, pause_monitor, resume_monitor.
Status	STATUSTOOL	True	Manage uptime kuma status operations. Action-routed methods: get_heartbeats, info.

Detailed tool schemas, parameter shapes, and validation constraints are preserved in docs/index.md.

Detailed Tool Actions Mapping

The action-routed tools wrap complex calls behind a simple, unified parameters scheme:

1. uptime_kuma_monitors

Manage uptime kuma monitors operations. Action parameter must be one of:

• get_monitors: List all monitors.
• get_monitor: Fetch a single monitor details by ID (in params_json).
• add_monitor: Create a new monitor.
• edit_monitor: Modify an existing monitor.
• delete_monitor: Delete a monitor by ID.
• pause_monitor: Pause monitoring for a specific ID.
• resume_monitor: Resume monitoring for a specific ID.

2. uptime_kuma_status

Retrieve status and analytics. Action parameter must be one of:

• get_heartbeats: Fetch monitor heartbeat records.
• info: Retrieve system stats and general status info.

Dynamic Tool Selection & Visibility

This MCP server supports dynamic toolset selection and visibility filtering at runtime. This allows you to restrict the set of exposed tools in order to prevent blowing up the LLM's context window.

You can configure tool filtering via multiple input channels:

• CLI Arguments: Pass --tools or --toolsets (or their disabled counterparts --disabled-tools and --disabled-toolsets) during startup.
• Environment Variables: Define standard environment variables:
  • MCP_ENABLED_TOOLS / MCP_DISABLED_TOOLS
  • MCP_ENABLED_TAGS / MCP_DISABLED_TAGS
• HTTP SSE Request Headers: Pass custom headers during transport initialization:
  • x-mcp-enabled-tools / x-mcp-disabled-tools
  • x-mcp-enabled-tags / x-mcp-disabled-tags
• HTTP SSE Request Query Parameters: Append query parameters directly to your transport connection URL:
  • ?tools=tool1,tool2
  • ?tags=tag1

When query strings or parameters are supplied, an LLM-free Knowledge Graph resolution layer (using DynamicToolOrchestrator) matches query intents against known tool tags, names, or descriptions, with safe fallback and automated 24-hour background cache refreshing.

---

MCP Configuration Examples

stdio Transport (Recommended for local IDEs e.g., Cursor, Claude Desktop)

Configure your IDE's mcp.json to launch the MCP server via uvx:

{
  "mcpServers": {
    "uptime-kuma-agent": {
      "command": "uvx",
      "args": [
        "--from",
        "uptime-kuma-agent",
        "uptime-mcp"
      ],
      "env": {
        "UPTIME_KUMA_URL": "http://localhost:3001",
        "AUTH_TYPE": "password",
        "UPTIME_KUMA_USERNAME": "admin",
        "UPTIME_KUMA_PASSWORD": "your_password_here"
      }
    }
  }
}

Streamable-HTTP Transport (Recommended for production deployments)

Configure your client's mcp.json to launch the Streamable-HTTP server via uvx with explicit host and port definition:

{
  "mcpServers": {
    "uptime-kuma-agent": {
      "command": "uvx",
      "args": [
        "--from",
        "uptime-kuma-agent",
        "uptime-mcp"
      ],
      "env": {
        "TRANSPORT": "streamable-http",
        "HOST": "0.0.0.0",
        "PORT": "8000",
        "UPTIME_KUMA_URL": "http://localhost:3001",
        "AUTH_TYPE": "password",
        "UPTIME_KUMA_USERNAME": "admin",
        "UPTIME_KUMA_PASSWORD": "your_password_here"
      }
    }
  }
}

Alternatively, connect to a pre-deployed remote or local Streamable-HTTP instance:

{
  "mcpServers": {
    "uptime-kuma-agent": {
      "url": "http://localhost:8000/uptime-kuma-agent/mcp"
    }
  }
}

Deploying the Streamable-HTTP server via Docker:

docker run -d \
  --name uptime-kuma-agent-mcp \
  -p 8000:8000 \
  -e TRANSPORT=streamable-http \
  -e PORT=8000 \
  -e UPTIME_KUMA_URL="http://your-kuma:3001" \
  -e AUTH_TYPE="password" \
  -e UPTIME_KUMA_USERNAME="admin" \
  -e UPTIME_KUMA_PASSWORD="your-password" \
  knucklessg1/uptime-kuma-agent:latest

---

Agent

This repository features a fully integrated Pydantic AI Graph Agent. It communicates over the Agent Control Protocol (ACP) and interacts seamlessly with the Agent Web UI (AG-UI) and Terminal interface.

Running the Agent CLI

To start the interactive command-line agent:

# Set credentials
export UPTIME_KUMA_URL="http://localhost:3001"
export AUTH_TYPE="password"
export UPTIME_KUMA_USERNAME="admin"
export UPTIME_KUMA_PASSWORD="your-password"

# Run the agent server
uptime-agent --provider openai --model-id gpt-4o

Docker Compose Orchestration

The following docker/agent.compose.yml configures the Agent, Web UI, and Terminal Interface together:

version: '3.8'

services:
  uptime-kuma-agent-mcp:
    image: knucklessg1/uptime-kuma-agent:latest
    container_name: uptime-kuma-agent-mcp
    hostname: uptime-kuma-agent-mcp
    restart: always
    env_file:
      - ../.env
    environment:
      - PYTHONUNBUFFERED=1
      - HOST=0.0.0.0
      - PORT=8000
      - TRANSPORT=streamable-http
    ports:
      - "8000:8000"
    healthcheck:
      test: ["CMD", "python3", "-c", "import urllib.request; urllib.request.urlopen('http://localhost:8000/health')"]
      interval: 30s
      timeout: 10s
      retries: 3
      start_period: 10s
    logging:
      driver: json-file
      options:
        max-size: "10m"
        max-file: "3"

  uptime-kuma-agent-agent:
    image: knucklessg1/uptime-kuma-agent:latest
    container_name: uptime-kuma-agent-agent
    hostname: uptime-kuma-agent-agent
    restart: always
    depends_on:
      - uptime-kuma-agent-mcp
    env_file:
      - ../.env
    command: [ "uptime-agent" ]
    environment:
      - PYTHONUNBUFFERED=1
      - HOST=0.0.0.0
      - PORT=9004
      - MCP_URL=http://uptime-kuma-agent-mcp:8000/mcp
      - PROVIDER=${PROVIDER:-openai}
      - MODEL_ID=${MODEL_ID:-gpt-4o}
      - ENABLE_WEB_UI=True
      - ENABLE_OTEL=True
    ports:
      - "9004:9004"
    healthcheck:
      test: ["CMD", "python3", "-c", "import urllib.request; urllib.request.urlopen('http://localhost:9004/health')"]
      interval: 30s
      timeout: 10s
      retries: 3
      start_period: 10s
    logging:
      driver: json-file
      options:
        max-size: "10m"
        max-file: "3"

Detailed graph node architecture explanations, custom skill configurations, and agentic trace guides are available in docs/index.md#agent.

---

Security & Governance

Built directly upon the enterprise-ready agent-utilities core, standard security parameters are fully supported:

Access Control & Policy Enforcement

• Eunomia Policies: Fine-grained, policy-driven tool authorization. Supports none, local embedded (mcp_policies.json), or centralized remote modes.
• OIDC Token Delegation: Compliant with RFC 8693 token exchange for flowing authenticating user credentials from Web UI / ACP → Agent → MCP.
• Scoped Credentials: Execution context runs restricted to the specific caller identity.

Runtime Security Grid

Feature	Functionality	Enablement
Tool Guard	Sensitivity inspection with human-in-the-loop validation	Enabled by default
Prompt Injection Defense	Input scanning, repetition monitoring, and recursive loop blocks	Enabled by default
Context Safety Guard	Stuck-loop detectors and contextual overflow preemptive alerts	Enabled by default

---

Installation

Install the Python package locally:

# Using uv (highly recommended)
uv pip install uptime-kuma-agent[all]

# Using standard pip
python -m pip install uptime-kuma-agent[all]

---

Repository Owners

---

Contribute

Contributions are welcome! Please ensure code quality by executing local checks before submitting pull requests:

• Format code using ruff format .
• Lint code using ruff check .
• Validate type-safety with mypy .
• Execute test suites using pytest