ntfy-mcp

Sends ntfy notifications when tasks complete by integrating with the Model Context Protocol.

javascript

41

GitHub Stars

javascript

Language

6 months ago

First Indexed

2 months ago

Catalog Refreshed

Documentation & install

Readme and setup notes from the catalogue, plus a client-ready config you can copy for your MCP host.

Installation

Add the following to your MCP client configuration file.

Configuration

View docs

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

ntfy-mcp is an MCP server that notifies you via ntfy whenever your AI assistant completes a task. It integrates with the Model Context Protocol to keep you informed without breaking your workflow, so you can focus on writing code while your notifications arrive on cue.

How to use

You use ntfy-mcp by running its local server as part of your MCP client setup. Once it is running, the server listens for task completion events from the MCP client and sends a push notification to your chosen ntfy topic. To receive these alerts, install the ntfy app on your device and subscribe to the topic you configure. When a task finishes, you’ll get a notification, letting you step away from the console and enjoy your break.

How to install

Prerequisites: ensure you have Node.js and npm installed on your machine.

Clone the project and navigate into the folder.

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

Install dependencies.

npm install

Build the project.

npm run build

Connect and configure the MCP server. You can start it manually or configure a startup command. The following example shows the stdio configuration used to run the built index file and set your ntfy topic.

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

Additional notes

Start the server (manual start) if you did not use a configuration entry above.

Troubleshooting tips

Ensure the NTFY_TOPIC environment variable is set to a topic you own or have access to. If notifications don’t arrive, verify that the ntfy app is installed and subscribed to the topic, and confirm the MCP client is emitting task-complete events.