Ntfy Notifications MCP Server

Ntfy Notifications is a Model Context Protocol server that integrates with the ntfy notification service to keep you informed about your AI assistant's task completions. This tool allows you to step away from your computer while your AI works, receiving a convenient notification on your phone or other devices when the task is finished. The server acts as a notification bridge between your AI assistant and the ntfy app, enabling a more flexible workflow where you don't need to constantly monitor your AI's progress. Simply set up the notification, start your task, and get alerted when it's time to return to your work.

Overview

Ntfy Notifications allows you to receive alerts on your devices when your AI assistant completes tasks. This is particularly useful for longer tasks where you might want to step away from your computer while the AI works.

Installation

Prerequisites

Node.js installed on your system
npm package manager
ntfy app installed on your device(s)

Installation Steps

Clone the repository:

git clone https://github.com/teddyzxcv/ntfy-mcp.git
cd ntfy-mcp

Install dependencies:

npm install

Build the project:

npm run build

Start the server manually:

npm start

Client Configuration

To configure your AI client to use this MCP server, add the following configuration to your client settings:

"ntfy-mcp": {
  "command": "node",
  "args": [
    "/path/to/ntfy-mcp/build/index.js"
  ],
  "env": {
    "NTFY_TOPIC": "<your chosen topic name>"
  },
  "autoApprove": [
    "notify_user"
  ]
}

Replace /path/to/ntfy-mcp/build/index.js with the actual path to the built index.js file on your system, and <your chosen topic name> with a unique topic name of your choice.

Setting Up Notifications

Download the ntfy app on your phone or other devices
Open the app and subscribe to the same topic name you specified in your client configuration
Make sure notifications are enabled for the ntfy app on your device

Usage

When working with your AI assistant, include a phrase like "notify me when the task is done" in your prompt. For example:

Write me a hello world program in Python, notify me when the task is done

The AI will then use the notification function when it completes the task, sending an alert to your subscribed devices.

Troubleshooting

If you're not receiving notifications, check that you've subscribed to the correct topic in the ntfy app
Ensure the environment variable for NTFY_TOPIC is correctly set in your client configuration
Verify that the ntfy app has permission to send notifications on your device
Make sure your prompt includes a clear instruction to notify you when the task is complete

Advanced Configuration

You can customize the notification behavior by modifying the environment variables:

NTFY_SERVER: Change the ntfy server URL (default is https://ntfy.sh)
NTFY_TOPIC: Your chosen topic name for notifications
NTFY_PRIORITY: Set notification priority (1-5, with 5 being highest)
NTFY_TITLE: Customize the notification title