Ntfy

ntfy-me-mcp

Un servidor de Protocolo de Contexto de Modelo (MCP) simplificado para enviar notificaciones a través del servicio ntfy (público o autoalojado con soporte de tokens) 📲

Resumen

ntfy-me-mcp proporciona a los asistentes de IA la capacidad de enviar notificaciones en tiempo real a tus dispositivos a través del servicio ntfy.sh (ya sea público o autoalojado con soporte de tokens). Recibe notificaciones cuando tu IA completa tareas, encuentra errores o alcanza hitos importantes, todo sin necesidad de monitoreo constante.

El servidor incluye funciones inteligentes como detección automática de URL para crear acciones de vista y detección inteligente de formato markdown, lo que facilita a los asistentes de IA crear notificaciones ricas e interactivas sin configuración adicional.

Vista previa	Disponible en
	Nombre Enlace / Insignia ntfy.sh Destacado en ntfy.sh Glama.ai Smithery.ai MseeP.ai Archestra.ai

Características

• 🚀 Configuración rápida: ¡Ejecuta con npx o docker!
• 🔔 Notificaciones en tiempo real: Recibe actualizaciones en tu teléfono/escritorio cuando las tareas se completan
• 🎨 Notificaciones enriquecidas: Soporte para tema, título, prioridades, etiquetas emoji y mensajes detallados
• 🔍 Obtención de notificaciones: Obtén y filtra mensajes en caché de tus temas ntfy
• 🎯 Enlaces de acción inteligentes: Detecta automáticamente URLs en mensajes y crea acciones de vista
• 📄 Markdown inteligente: Detecta y habilita automáticamente el formato markdown cuando está presente
• 🔒 Seguro: Autenticación opcional con tokens de acceso
• 🔑 Enmascaramiento de entrada: ¡Almacena de forma segura tu token ntfy en tu configuración de vs!
• 🌐 Soporte autoalojado: Funciona tanto con ntfy.sh como con instancias ntfy autoalojadas

Próximamente...

• 📨 Correo electrónico: Envía notificaciones por correo electrónico (requiere configuración del servidor de correo ntfy)
• 🔗 URLs de clic: Capacidad para personalizar URLs de clic
• 🖼️ URLs de imágenes: Detección inteligente de URLs de imágenes para incluir automáticamente URLs de imágenes en mensajes y notificaciones
• 🏁 ¡y más!

Tabla de Contenidos

Inicio rápido - Configuración del servidor MCP

Elige la forma de configuración que coincida con tu cliente. Todos los ejemplos a continuación usan NTFY_TOPIC como la variable requerida y mantienen las opciones de autenticación opcionales comentadas hasta que las necesites.

Ejemplos de configuración

{
  "ntfy-me-mcp": {
    "command": "npx",
    "args": ["-y", "ntfy-me-mcp"],
    "env": {
      "NTFY_TOPIC": "your-ntfy-topic",
      "NTFY_URL": "https://ntfy.sh",
      // "NTFY_TOKEN": "add-your-ntfy-token"
    }
  }
}

{
  "ntfy-me-mcp": {
    "command": "node",
    "args": ["/absolute/path/to/ntfy-me-mcp/build/index.js"],
    "env": {
      "NTFY_TOPIC": "your-ntfy-topic",
      "NTFY_URL": "https://ntfy.sh",
      // "NTFY_TOKEN": "add-your-ntfy-token"
    }
  }
}

{
  "ntfy-me-mcp": {
    "command": "docker",
    "args": [
      "run",
      "-i",
      "--rm",
      "-e",
      "NTFY_TOPIC",
      "-e",
      "NTFY_URL",
      "-e",
      "NTFY_TOKEN",
      "gitmotion/ntfy-me-mcp:latest"
    ],
    "env": {
      "NTFY_TOPIC": "your-ntfy-topic",
      "NTFY_URL": "https://ntfy.sh",
      // "NTFY_TOKEN": "add-your-ntfy-token"
    }
  }
}

{
  "$schema": "https://opencode.ai/config.json",
  "mcp": {
    "ntfy-me-mcp": {
      "type": "local",
      "command": ["npx", "-y", "ntfy-me-mcp"],
      "environment": {
        "NTFY_TOPIC": "your-ntfy-topic",
        "NTFY_URL": "https://ntfy.sh",
        // "NTFY_TOKEN": "add-your-ntfy-token"
      }
    }
  }
}

{
  "mcpServers": {
    "ntfy-me-mcp": {
      "command": "npx",
      "args": ["-y", "ntfy-me-mcp"],
      "env": {
        "NTFY_TOPIC": "your-ntfy-topic",
        "NTFY_URL": "https://ntfy.sh",
        "NTFY_TOKEN": "${NTFY_TOKEN}"
      }
    }
  }
}

{
  "mcpServers": {
    "ntfy-me-mcp": {
      "type": "local",
      "command": "npx",
      "args": ["-y", "ntfy-me-mcp"],
      "env": {
        "NTFY_TOPIC": "your-ntfy-topic",
        "NTFY_URL": "https://ntfy.sh",
        "NTFY_TOKEN": "your-access-token"
      },
      "tools": ["*"]
    }
  }
}

{
  "ntfy-me-mcp": {
    "command": "npx",
    "args": ["-y", "ntfy-me-mcp"],
    "env": {
      "NTFY_TOPIC": "your-ntfy-topic",
      "NTFY_URL": "https://your-ntfy-server.com",
      "NTFY_TOKEN": "your-access-token"
    }
  }
}

Instalación

Si necesitas instalar y ejecutar el servidor directamente (alternativa a la configuración MCP anterior):

# Clona el repositorio, instala dependencias, configura .env, compila y ejecuta

git clone https://github.com/gitmotion/ntfy-me-mcp.git
cd ntfy-me-mcp
npm install
cp .env.example .env
npm run build
npm start

npx -y @smithery/cli install @gitmotion/ntfy-me-mcp --client claude

Configuración del receptor de notificaciones

Configuración

Variables de entorno

Crea un archivo .env copiando el ejemplo: cp .env.example .env — consulta .env.example como referencia.

Autenticación

// Add this to your VS Code `mcp.json` file, either the user-level file or your workspace `.vscode/mcp.json`
// Set `NTFY_TOKEN` exactly to `"${input:ntfy_token}"` when you want VS Code to treat it as a secure prompt-backed value.

{
  "inputs": [
    {
      "type": "promptString",
      "id": "ntfy_token",
      "description": "Ntfy Token",
      "password": true
    }
  ],
  "servers": {
    "ntfy-me-mcp": {
      "command": "npx",
      "args": ["-y", "ntfy-me-mcp"],
      "env": {
        "NTFY_TOPIC": "your-ntfy-topic",
        "NTFY_URL": "https://your-ntfy-server.com",
        "NTFY_TOKEN": "${input:ntfy_token}"
      }
    }
  }
}

Herramientas y uso

ntfy_me: Envío de notificaciones

Uso con lenguaje natural

• Cuando trabajes con tu asistente de IA, puedes usar frases naturales para solicitar notificaciones:

"ntfyme with a summary of the task when complete"
"Send me a notification when the build is complete"
"Notify me when the task is done"
"Alert me after generating the code"
"Message me when the process finishes"
"Send an alert with high priority"

Ejemplo de uso

{
  "title": "Code Generation Complete",
  "message": "Your React component has been
created successfully with proper
TypeScript typing.",
  "priority": "high",
  "tags": ["white_check_mark", "code", "react"]
}

{
  "success": true,
  "endpoint": "https://ntfy.sh/ntfymetest"
}

Parámetros del Mensaje

{
  title: "Task Complete",
  message: "Regular plain text message",
  markdown: false  // Force disable
}

{
  title: "Build Complete",
  message: "View at https://github.com/org/repo/pull/123"
}

{
  title: "Pull Request Review",
  message: "Ready for final checks",
  actions: [
    {
      action: "view",
      label: "View PR",
      url: "https://github.com/org/repo/pull/123"
    },
    {
      action: "view",
      label: "View Changes",
      url: "https://github.com/org/repo/pull/123/files",
      clear: true
    }
  ]
}

ntfy_me_fetch: Consulta de Notificaciones

Uso de Lenguaje Natural

Los asistentes de IA entienden diversas formas de solicitar la recuperación de mensajes:

"Show me my recent notifications"
"Get messages from the last hour"
"Find notifications with title 'Build Complete'"
"Search for messages with the test_tube tag"
"Show notifications from the updates topic from the last 24hr"
"Check my latest alerts"

Ejemplo de Uso

{
  "since": "6h"
}

{
  "success": true,
  "messageCount": 1,
  "topics": {
    "ntfymetest": [
      {
        "id": "On4Jeo1ENDCB",
        "time": 1775859291,
        "event": "message",
        "topic": "ntfymetest",
        "message": "Test",
        "title": "Test",
        "priority": 3,
        "expires": 1775902491
      }
    ]
  }
}

Parámetros de Consulta

Desarrollo y Contribuciones

¡Las contribuciones son bienvenidas! Consulte CONTRIBUTING.md, que incluye pautas generales, pasos de configuración, etc.

Licencia

Este proyecto está bajo la Licencia Pública General GNU v3.0 — consulte el archivo LICENSE para más detalles.

Hecho con ❤️ por gitmotion