Skip to main content
Glama
Sign In
deenesjakoruzh

ntfy-me-mcp

by gitmotion
npmGitHub
JavaScript
GPL 3.0
174
12
  • Linux
  • Apple
OverviewInspectNewSchemaRelated ServersReviewsScore
Need Help?View Source CodeReport Issue

📤 ntfy-me-mcp

Ein optimierter Model Context Protocol (MCP)-Server zum Senden von Benachrichtigungen über den ntfy-Dienst (öffentlich oder selbst gehostet mit Token-Unterstützung) 📲

Überblick

ntfy-me-mcp ermöglicht KI-Assistenten, Echtzeitbenachrichtigungen über den ntfy- Dienst (öffentlich oder selbstgehostet mit Token-Unterstützung) an Ihre Geräte zu senden. Sie erhalten Benachrichtigungen, wenn Ihre KI Aufgaben erledigt, Fehler feststellt oder wichtige Meilensteine erreicht – ganz ohne ständige Überwachung.

Der Server umfasst intelligente Funktionen wie die automatische URL-Erkennung zum Erstellen von Ansichtsaktionen und eine intelligente Markdown-Formatierungserkennung, wodurch KI-Assistenten einfacher umfangreiche, interaktive Benachrichtigungen ohne zusätzliche Konfiguration erstellen können.

Verfügbar über:

NameLink/Abzeichen
Glama.ai
Smithery.ai
MseeP.ai

Inhaltsverzeichnis

Merkmale

  • 🚀 Schnelle Einrichtung : Mit npx oder Docker ausführen!
  • 🔔 Echtzeitbenachrichtigungen : Erhalten Sie Updates auf Ihrem Telefon/Desktop, wenn Aufgaben abgeschlossen sind
  • 🎨 Umfangreiche Benachrichtigungen : Unterstützung für Thema, Titel, Prioritäten, Emoji-Tags und detaillierte Nachrichten
  • 🔍 Abrufen von Benachrichtigungen : Rufen Sie zwischengespeicherte Nachrichten aus Ihren NTFY-Themen ab und filtern Sie sie
  • 🎯 Smart Action Links : Erkennt automatisch URLs in Nachrichten und erstellt Anzeigeaktionen
  • 📄 Intelligentes Markdown : Erkennt und aktiviert automatisch die Markdown-Formatierung, wenn vorhanden
  • 🔒 Sicher : Optionale Authentifizierung mit Zugriffstoken
  • 🔑 Eingabemaskierung : Speichern Sie Ihr NTFY-Token sicher in Ihrer VS-Konfiguration!
  • 🌐 Selbstgehosteter Support : Funktioniert sowohl mit ntfy.sh als auch mit selbstgehosteten ntfy-Instanzen

(Demnächst verfügbar...)

  • 📨 E-Mail : Senden Sie Benachrichtigungen per E-Mail (erfordert NTFY-E-Mail-Serverkonfiguration)
  • 🔗 Klick-URLs : Möglichkeit zum Anpassen von Klick-URLs
  • 🖼️ Bild-URLs : Intelligente Bild-URL-Erkennung zum automatischen Einfügen von Bild-URLs in Nachrichten und Benachrichtigungen
  • 🏁 und mehr!

Schnellstart – MCP-Serverkonfiguration

NPM/NPX (empfohlene Methode)

  • Erfordert die Installation von npm/npx auf Ihrem System.
  • Diese Methode wird den meisten Benutzern empfohlen, da sie eine einfache und unkomplizierte Methode zum Einrichten des Servers bietet.

Für die einfachste Einrichtung mit MCP-kompatiblen Assistenten fügen Sie Folgendes zu Ihrer MCP-Konfiguration hinzu:

Minimale Konfiguration (für öffentliche Themen auf ntfy.sh)
{ "ntfy-me-mcp": { "command": "npx", "args": ["ntfy-me-mcp"], "env": { "NTFY_TOPIC": "your-topic-name" } } }
Vollständige Konfiguration (für private Server oder geschützte Themen)
Option 1: Direktes Token in der Konfiguration
{ "ntfy-me-mcp": { "command": "npx", "args": ["ntfy-me-mcp"], "env": { "NTFY_TOPIC": "your-topic-name", "NTFY_URL": "https://your-ntfy-server.com", "NTFY_TOKEN": "your-auth-token" // Use if using a protected topic/server } } }
Option 2: Verwenden von VS Code-Eingaben für die sichere Token-Verarbeitung (empfohlen)

Fügen Sie dies zu Ihrer VS Code-Datei „settings.json“ hinzu:

"mcp": { "inputs": [ { // Add this to your inputs array "type": "promptString", "id": "ntfy_token", "description": "Ntfy Token", "password": true } ], "servers": { // Other servers... "ntfy-me-mcp": { "command": "npx", "args": ["ntfy-me-mcp"], "env": { "NTFY_TOPIC": "your-topic-name", "NTFY_URL": "https://your-ntfy-server.com", "NTFY_TOKEN": "${input:ntfy_token}", // Use the input id variable for the token "PROTECTED_TOPIC": "true" // Prompts for token and masks it in your config } } } }

Bei dieser Konfiguration fordert VS Code Sie beim Starten des Servers zur Eingabe des Tokens auf und das Token wird bei der Eingabe maskiert.

Docker

Verwendung mit MCP in Docker

  • Erfordert, dass Docker auf Ihrem System installiert ist.
  • Diese Methode ist nützlich, um den Server in einer Containerumgebung auszuführen.
  • Sie können die offiziellen Docker-Images verwenden, die auf Docker Hub oder GitHub Container Registry verfügbar sind.

Docker-Images:

  • gitmotion/ntfy-me-mcp:latest (Docker Hub)
  • ghcr.io/gitmotion/ntfy-me-mcp:latest (GitHub Container Registry)

In Ihrer MCP-Konfiguration (z. B. VS Code settings.json):

"mcp": { "servers": { "ntfy-mcp": { "command": "docker", "args": [ "run", "-i", "--rm", "-e", "NTFY_TOPIC", "-e", "NTFY_URL", "-e", "NTFY_TOKEN", "-e", "PROTECTED_TOPIC", "gitmotion/ntfy-me-mcp", // OR use ghcr.io/gitmotion/ntfy-me-mcp:latest ], "env": { "NTFY_TOPIC": "your-topic-name", "NTFY_URL": "https://your-ntfy-server.com", "NTFY_TOKEN": "${input:ntfy_token}", "PROTECTED_TOPIC": "true" } } } }

Installation

Wenn Sie den Server direkt installieren und ausführen müssen (Alternative zur obigen MCP-Konfiguration):

Option 1: Global installieren

npm install -g ntfy-me-mcp

Option 2: Ausführen mit npx

npx ntfy-me-mcp

Option 3: Lokal installieren

# Clone the repository git clone https://github.com/gitmotion/ntfy-me-mcp.git cd ntfy-me-mcp # Install dependencies npm install # Copy the example environment file and configure it cp .env.example .env # Edit .env with your preferred editor and update the variables # nano .env # or use your preferred editor # Build the project npm run build # Start the server npm start

Option 4: Lokal erstellen und verwenden mit dem Knotenbefehl

Wenn Sie den Server entwickeln oder anpassen, möchten Sie ihn möglicherweise direkt mit dem Knoten ausführen:

# Clone the repository git clone https://github.com/gitmotion/ntfy-me-mcp.git cd ntfy-me-mcp # Install dependencies npm install # Copy the example environment file and configure it cp .env.example .env # Edit the .env file to set your NTFY_TOPIC and other optional settings # nano .env # or use your preferred editor # Build the project npm run build # Run using node directly npm start
Verwenden eines lokal erstellten Servers mit MCP

Wenn Sie Ihr MCP für die Verwendung einer lokal erstellten Version konfigurieren, geben Sie den Knotenbefehl und den Pfad zur erstellten Datei index.js an:

{ "ntfy-me": { "command": "node", "args": ["/path/to/ntfy-mcp/build/index.js"], "env": { "NTFY_TOPIC": "your-topic-name", //"NTFY_URL": "https://your-ntfy-server.com", // Use if using a self-hosted server //"NTFY_TOKEN": "your-auth-token" // Use if using a protected topic/server } } }

Denken Sie daran, im args-Array den absoluten Pfad zu Ihrer Datei build/index.js zu verwenden.

Option 5: MCP Marketplace-Installationen

Installation über Smithery

So installieren Sie ntfy-me-mcp für Claude Desktop automatisch über Smithery :

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

Konfiguration

Umgebungsvariablen

Erstellen Sie eine .env Datei in Ihrem Projektverzeichnis, indem Sie das bereitgestellte Beispiel kopieren:

# Copy the example file cp .env.example .env # Edit the file with your preferred editor nano .env # or vim, code, etc.

Ihre .env Datei sollte diese Variablen enthalten:

# Required NTFY_TOPIC=your-topic-name # Optional - Configure these if using a private/protected ntfy server # NTFY_URL=https://ntfy.sh # Default is ntfy.sh, change to your self-hosted ntfy server URL if needed # Include port if needed, e.g., https://your-ntfy-server.com:8443 # NTFY_TOKEN=your-access-token # Required for authentication with protected topics/servers # PROTECTED_TOPIC=false # Set to "true" if your topic requires authentication (helps prevent auth errors)

Hinweis : Mithilfe des Flags PROTECTED_TOPIC kann die Anwendung feststellen, ob für Ihr Thema eine Authentifizierung erforderlich ist. Wenn dieses Flag auf „true“ gesetzt ist und kein Token angegeben ist, werden Sie aufgefordert, eines einzugeben. Dies verhindert Authentifizierungsfehler bei geschützten Themen.

Verwendung

Authentifizierung

Dieser Server unterstützt sowohl authentifizierte als auch nicht authentifizierte NTFY-Endpunkte:

  • Öffentliche Themen : Bei der Verwendung öffentlicher Themen auf ntfy.sh oder anderen öffentlichen Servern ist keine Authentifizierung erforderlich.
  • Geschützte Themen : Für geschützte Themen oder private Server müssen Sie ein Zugriffstoken angeben.

Wenn eine Authentifizierung erforderlich ist, aber nicht bereitgestellt wird, erhalten Sie eine klare Fehlermeldung mit einer Erklärung zum Hinzufügen Ihres Tokens.

Einrichten des Benachrichtigungsempfängers

  1. Installieren Sie die ntfy-App auf Ihrem Gerät
  2. Abonnieren Sie das von Ihnen gewählte Thema (dasselbe wie Ihre NTFY_TOPIC Einstellung)

Senden von Benachrichtigungen (ntfy_me-Tool)

Dieser Abschnitt behandelt alle Funktionen im Zusammenhang mit dem Senden von Benachrichtigungen mit dem Tool ntfy_me.

Verwendung natürlicher Sprache

Wenn Sie mit Ihrem KI-Assistenten arbeiten, können Sie natürliche Ausdrücke verwenden wie:

"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"
Nachrichtenparameter

Das Tool akzeptiert diese Parameter:

ParameterBeschreibungErforderlich
AufgabentitelDer BenachrichtigungstitelJa
AufgabenzusammenfassungDie NotifizierungsstelleJa
PrioritätNachrichtenpriorität: min., niedrig, Standard, hoch, max.NEIN
SchlagworteArray von Benachrichtigungs-Tags (unterstützt Emoji-Shortcodes)NEIN
AbschlagBoolescher Wert zum Aktivieren der Markdown-Formatierung (true/false)NEIN
AktionenArray von Ansichtsaktionsobjekten für anklickbare LinksNEIN

Beispiel:

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

Dadurch wird eine Benachrichtigung mit hoher Priorität und einem Häkchen-Emoji gesendet.

Sie können Ihren Benachrichtigungen mithilfe des actions anklickbare Aktionsschaltflächen hinzufügen oder den Server die URLs in Ihrer Nachricht automatisch erkennen lassen.

Automatische URL-Erkennung

Wenn Ihr Nachrichtentext URLs enthält, erstellt der Server automatisch bis zu drei Ansichtsaktionen (maximales Limit von ntfy) aus den ersten erkannten URLs. Dies erleichtert das Einfügen anklickbarer Links, ohne das Aktions-Array manuell angeben zu müssen.

Beispielsweise diese Nachricht:

{ taskTitle: "Build Complete", taskSummary: "Your PR has been merged! View the changes at https://github.com/org/repo/pull/123 or check the deployment at https://staging.app.com" }

Generiert automatisch Anzeigeaktionen für beide URLs, sodass sie in der Benachrichtigung einfach anklickbar sind.

Manuelle Aktionskonfiguration

Für mehr Kontrolle können Sie Aktionen manuell angeben:

EigentumBeschreibungErforderlich
AktionMuss "Ansicht" seinJa
EtikettAnzuzeigender SchaltflächentextJa
URLBeim Anklicken zu öffnende URLJa
klarOb die Benachrichtigung beim Klicken gelöscht werden soll (optional)NEIN

Beispiel mit Aktionslinks:

{ taskTitle: "Pull Request Review", taskSummary: "Your code has been reviewed and is ready for final checks", priority: "high", tags: ["check", "code"], 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 } ] }
Emoji-Kurzcodes

Sie können Emoji-Shortcodes in Ihren Tags als visuelle Indikatoren verwenden:

  • warning → ⚠️
  • check → ✅
  • rocket → 🚀
  • tada → 🎉

Sehen Sie sich die vollständige Liste der unterstützten Emoji-Kurzcodes an.

Markdown-Formatierung

Ihre Benachrichtigungen unterstützen umfangreiche Markdown-Formatierung mit intelligenter Erkennung! Wenn Sie Markdown-Syntax in Ihre taskSummary aufnehmen, erkennt der Server dies automatisch und aktiviert die Markdown-Analyse – Sie müssen markdown: true nicht explizit festlegen.

Automatische Erkennung

Der Server sucht nach gängigen Markdown-Mustern wie:

  • Überschriften (#, ## usw.)
  • Listen (-, *, Zahlen)
  • Codeblöcke (```)
  • Links ( Text )
  • Fett/Kursiv ( Text , Text )

Wenn diese Muster erkannt werden, wird die Markdown-Analyse für die Nachricht automatisch aktiviert.

Manuelle Übersteuerung

Obwohl die automatische Erkennung in den meisten Fällen funktioniert, können Sie die Markdown-Analyse dennoch explizit steuern:

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

Nachrichten abrufen (Tool ntfy_me_fetch)

Dieser Abschnitt behandelt alle Funktionen im Zusammenhang mit dem Abrufen und Filtern von Nachrichten mit dem Tool ntfy_me_fetch.

Verwendung natürlicher Sprache

KI-Assistenten kennen verschiedene Möglichkeiten, den Abruf von Nachrichten anzufordern:

"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"
Nachrichtenparameter

Das Tool akzeptiert diese Parameter:

ParameterBeschreibungErforderlich
ntfyThemaThema, aus dem Nachrichten abgerufen werden (standardmäßig NTFY_TOPIC-Umgebungsvariable)NEIN
seitWie weit zurück sollen Nachrichten abgerufen werden ('10m', '1h', '1d', Zeitstempel, Nachrichten-ID oder 'alle')NEIN
Nachrichten-IDSuchen einer bestimmten Nachricht anhand ihrer IDNEIN
NachrichtentextSuchen Sie nach Nachrichten mit exaktem TextinhaltNEIN
NachrichtentitelNachrichten mit exaktem Titel/Betreff findenNEIN
PrioritätenSuchen nach Nachrichten mit bestimmten PrioritätsstufenNEIN
SchlagworteSuchen Sie nach Nachrichten mit bestimmten TagsNEIN
Beispiele
  1. Aktuelle Nachrichten abrufen
{ since: "30m" // Get messages from last 30 minutes }
  1. Filtern nach Titel und Priorität
{ messageTitle: "Build Complete", priorities: "high", since: "1d" }
  1. Suche nach verschiedenen Themen mit Tags
{ ntfyTopic: "updates", tags: ["error", "warning"], since: "all" }
  1. Bestimmte Nachricht suchen
{ messageId: "xxxxXXXXxxxx" }

Die Nachrichten werden mit allen Einzelheiten zurückgesendet, darunter:

  • Nachrichten-ID und Zeitstempel
  • Thema und Titel
  • Inhalt und Priorität
  • Tags und Anhänge
  • Aktionslinks und Ablauf

Hinweis : Die Verfügbarkeit des Nachrichtenverlaufs hängt von den Cache-Einstellungen Ihres NTFY-Servers ab. Der öffentliche NTFY.SH-Server speichert Nachrichten normalerweise 12 Stunden lang im Cache.

Entwicklung

Erstellen aus der Quelle

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

Lizenz

Dieses Projekt ist unter der GNU General Public License v3.0 lizenziert – Einzelheiten finden Sie in der Datei LICENSE .

Beitragen

Beiträge sind willkommen! Senden Sie gerne einen Pull Request.

Mit ❤️ von gitmotion erstellt

You must be authenticated.

A
security – no known vulnerabilities
A
license - permissive license
A
quality - confirmed to work

remote-capable server

The server can be hosted and run remotely because it primarily relies on remote services or has no dependency on the local environment.

Ein optimierter MCP-Server, der es KI-Assistenten ermöglicht, über den ntfy-Dienst Echtzeitbenachrichtigungen an Ihre Geräte zu senden, sodass Sie Benachrichtigungen erhalten, wenn Aufgaben abgeschlossen sind oder wichtige Ereignisse eintreten.

  1. Überblick
    1. Verfügbar über:
  2. Inhaltsverzeichnis
    1. Merkmale
      1. (Demnächst verfügbar...)
    2. Schnellstart – MCP-Serverkonfiguration
      1. NPM/NPX (empfohlene Methode)
    3. Docker
      1. Verwendung mit MCP in Docker
    4. Installation
      1. Option 1: Global installieren
      2. Option 2: Ausführen mit npx
      3. Option 3: Lokal installieren
      4. Option 4: Lokal erstellen und verwenden mit dem Knotenbefehl
      5. Option 5: MCP Marketplace-Installationen
    5. Konfiguration
      1. Umgebungsvariablen
    6. Verwendung
      1. Authentifizierung
      2. Einrichten des Benachrichtigungsempfängers
      3. Senden von Benachrichtigungen (ntfy\_me-Tool)
      4. Nachrichten abrufen (Tool ntfy\_me\_fetch)
    7. Entwicklung
      1. Erstellen aus der Quelle
    8. Lizenz
      1. Beitragen

        Related MCP Servers

        • lunchmoney-mcp

          leafeye
          A
          security
          A
          license
          A
          quality
          An MCP server that lets AI assistants interact with your Lunchmoney data, enabling natural language queries about transactions, budgets, and spending patterns.
          Last updated -
          4
          3
          8
          TypeScript
          MIT License

        • ntfy-mcp

          teddyzxcv
          -
          security
          A
          license
          -
          quality
          The MCP server that keeps you informed by sending the notification on phone using ntfy.sh
          Last updated -
          10
          6
          JavaScript
          Apache 2.0
          • Linux
          • Apple

        • Scrapling Fetch MCP

          cyberchitta
          -
          security
          A
          license
          -
          quality
          An MCP server that helps AI assistants access text content from websites that implement bot detection, bridging the gap between what you can see in your browser and what the AI can access.
          Last updated -
          1
          Python
          Apache 2.0

        • NTFY MCP Server

          cyanheads
          -
          security
          A
          license
          -
          quality
          A Model Context Protocol server enabling AI systems to send real-time notifications to phones, desktops, and other devices through the ntfy publish/subscribe service.
          Last updated -
          10
          8
          TypeScript
          Apache 2.0
          • Apple

        View all related MCP servers

        New MCP Servers

        MCP directory API

        We provide all the information about MCP servers via our MCP API.

        curl -X GET 'https://glama.ai/api/mcp/v1/servers/gitmotion/ntfy-me-mcp'

        If you have feedback or need assistance with the MCP directory API, please join our Discord server