Uptime Kuma MCP Open

Uptime Kuma MPC desarrollado por GryfAi. Soporta

GitHub

Documentación

Build Status

(Antecedentes: Este repositorio pertenecía anteriormente a uno de mis proyectos secundarios, GryfAI. Ese proyecto ha sido descartado y la propiedad me ha sido transferida a mí, personalmente. Esto se sigue ofreciendo bajo la misma licencia BSL.

Vamos a modificar la información de contacto y la licencia será más abierta. Sin embargo, me gustaría recibir reconocimiento y atribución por el trabajo que he invertido en ello.)

mcp-uptime-kuma-open

Esta es la versión abierta de nuestro servidor MCP de Uptime Kuma. Está abierto para uso personal y las pequeñas empresas pueden usarlo libremente de forma interna para sus operaciones. Consulta nuestra licencia para más información. Esta versión se publica bajo la licencia BSL. Ofrecemos una solución alojada con más funcionalidad integrada en la versión de código cerrado. Si quieres la versión más avanzada, por favor contáctanos en hello (at) gryfai.com

El repositorio sigue activo y añadiremos contenido de forma continua. Somos conscientes de que nos faltan pruebas, pero lo hemos probado con un par de clientes. ¡Está todo listo para usar! Escribir pruebas es lo siguiente en nuestra agenda.

La versión abierta

Esta versión expone un conjunto limitado pero útil de herramientas para interactuar con Uptime Kuma a través de tu herramienta LLM favorita.

Este servidor proporciona estas funciones:

  • Recuperación del estado de los monitores, tanto todos como individuales
  • Obtener latidos de monitores
  • Recuperación de notificaciones, tanto todas como individuales
  • Recuperación de páginas de estado, tanto todas como individuales
  • Recuperación de latidos
  • Recuperación de etiquetas, tanto todas como individuales
  • Recuperación del tamaño de la base de datos
  • Recuperación del mantenimiento de páginas de estado.

Todas estas funciones son de solo lectura en la versión abierta.

Publicamos esta versión abierta bajo BSL con cambio de licencia a Apache 2.0 en el futuro. Tanto para proporcionarte excelentes herramientas como para asegurarnos de que el tiempo y el esfuerzo que invertimos en mantener este repositorio no sea mal utilizado. Por supuesto, puedes desarrollar un servicio de código abierto competidor por tu cuenta. Fomentamos la competencia y el código abierto. Solo regulamos el código base para que nuestro código no se use en un SaaS competidor u otros proyectos con fines de lucro.

¿Quieres más?

GryfAi tiene una versión más potente de esto que se puede alojar a través de nuestra solución. Incluye capacidades como:

  • Añadir, editar y eliminar monitores
  • Añadir, editar y eliminar notificaciones
  • Añadir, editar y eliminar etiquetas
  • Funcionalidad de mantenimiento
  • Funcionalidad de Docker
  • Gestión de claves API
  • Gestión de proxies

Solo contáctanos en: hello (at) gryfai.com

Requisitos previos

Este proyecto usa uv como su sistema de compilación. Asegúrate de tener uv o pip instalado. Puedes instalar uv con:

pip install uv

Instalación y uso (usuarios finales).

Instala localmente, configura las variables de entorno y luego deja que tu cliente MCP inicie el servidor STDIO. Normalmente no necesitas ejecutarlo manualmente a menos que estés depurando.

  1. Crea y activa un entorno virtual (Python 3.10+).

    • Verifica tu versión de Python ejecutando python3 --version. Si no tienes Python 3.10 o más reciente, puedes descargarlo desde el sitio web oficial de Python.
    • Para crear un entorno virtual, ejecuta el siguiente comando desde la raíz del directorio del proyecto: python3 -m venv .venv
    • Para activar el entorno virtual, ejecuta uno de los siguientes comandos, según tu sistema operativo:
      • Linux/macOS: source .venv/bin/activate
      • Windows: .venv\Scripts\activate
    • Cuando el entorno virtual esté activado, el prompt de tu shell normalmente cambiará para mostrar el nombre del entorno virtual (por ejemplo, (.venv) user@host:...$).

  2. Instala el paquete dentro de ese entorno virtual: pip install . (o uv pip install .).

    • Este comando debe ejecutarse desde la raíz del directorio del proyecto.

  3. Configura las variables de entorno para tu instancia de Uptime Kuma:

    • UPTIME_KUMA_URL (predeterminado: http://localhost:3001)
    • UPTIME_KUMA_USERNAME
    • UPTIME_KUMA_PASSWORD
    • Puedes establecer estas variables de entorno en tu shell, o puedes crear un archivo .env en la raíz del directorio del proyecto y añadirlas allí. Por ejemplo: 
      UPTIME_KUMA_URL=http://localhost:3001
UPTIME_KUMA_USERNAME=my-username
UPTIME_KUMA_PASSWORD=my-password
    • Nota: Si estás usando un archivo .env, el servidor cargará automáticamente las variables de entorno desde él.

  4. Apunta tu cliente MCP al comando python -m mcp_uptime_kuma_open.server (ejemplos abajo).

    • Si tu cliente MCP se ejecuta en el mismo entorno virtual, puedes usar el comando python -m mcp_uptime_kuma_open.server.
    • Si tu cliente MCP se ejecuta fuera del entorno virtual, necesitas proporcionar la ruta completa al ejecutable de Python en el entorno virtual. Puedes encontrar la ruta completa ejecutando el comando which python (en Linux/macOS) o where python (en Windows) cuando el entorno virtual esté activado. Por ejemplo: .venv/bin/python -m mcp_uptime_kuma_open.server.
    • Al usar el comando mcp add, asegúrate de que el entorno virtual esté activado, o proporciona la ruta completa al ejecutable de Python.

Notas del cliente (todos usan STDIO; las claves coinciden con la documentación actual del cliente):

Gemini CLI

  • La forma recomendada de añadir el servidor es ejecutar el siguiente comando: gemini mcp add uptime-kuma python -m mcp_uptime_kuma_open.server
  • Reinicia o recarga el CLI para que detecte el nuevo servidor.
  • Alternativamente, puedes añadir una entrada de servidor en tu configuración MCP de Gemini CLI (mcpServers en ~/.gemini/settings.json):
{
  "mcpServers": {
    "uptime-kuma": {
      "command": "python",
      "args": ["-m", "mcp_uptime_kuma_open.server"]
    }
  }
}

Codex CLI

  • La forma recomendada de añadir el servidor es ejecutar el siguiente comando: codex mcp add uptime-kuma python -m mcp_uptime_kuma_open.server
  • Reinicia o recarga el CLI para que detecte el nuevo servidor.
  • Alternativamente, puedes añadir una entrada de servidor STDIO en tu configuración de Codex (~/.codex/config.toml):
[mcp_servers.uptime-kuma]
command = "python"
args = ["-m", "mcp_uptime_kuma_open.server"]
  • Guarda y reinicia el CLI de Codex para cargar el servidor.

Claude CLI

  • Añade el servidor MCP a tu configuración de Claude CLI (~/.claude.json). Se recomienda usar el comando claude mcp add.
  • Si editas el archivo manualmente, añade lo siguiente al objeto mcpServers:
{
  "mcpServers": {
    "uptime-kuma": {
      "command": "python -m mcp_uptime_kuma_open.server"
    }
  }
}
  • Ejecuta claude como de costumbre; iniciará el servidor STDIO automáticamente.

Claude Desktop

  • La forma recomendada de añadir un servidor MCP es instalarlo como una extensión (archivo .mcpb) o editar el archivo de configuración directamente.
  • El archivo de configuración se encuentra en:
    • macOS: ~/Library/Application Support/Claude/claude_desktop_config.json
    • Windows: %APPDATA%\Claude\claude_desktop_config.json
  • Si editas el archivo manualmente, añade lo siguiente al objeto mcpServers:
{
  "mcpServers": {
    "uptime-kuma": {
      "command": "<path-to-root-folder-of-project>/mcp-uptime-kuma-open/.venv/bin/python",
      "args": ["-m", "mcp_uptime_kuma_open.server"]
    }
  }
}
  • Después de añadir el servidor, debes reiniciar la aplicación Claude Desktop.

También ofrecemos una versión comercial HTTP/SSE que puede proporcionar un mejor rendimiento. Siéntete libre de usar la versión abierta STDIO bajo la licencia proporcionada, o contáctanos si prefieres la opción alojada HTTP/SSE.

Sabemos que algunos clientes a veces se comportan mejor si lo ejecutas directamente en el entorno virtual.