Ntfy Notifications MCP server

ntfy-mcp is a handy server that integrates with the Model Context Protocol to send ntfy notifications when your AI assistant completes a task. It allows you to step away from your computer and receive mobile notifications when your AI has finished generating code or completing other tasks.

Installation

Prerequisites

Before installing ntfy-mcp, you'll need:

• Node.js installed on your system
• Git for cloning the repository
• The ntfy app installed on your mobile device

Setup Process

1. Clone the repository and navigate to the project directory:

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

2. Install dependencies:

   npm install
   

3. Build the project:

   npm run build
   

Usage

Running the Server

You have two options for running the ntfy-mcp server:

Manual Start

Start the server directly with:

npm start

Integration with Cline

Configure ntfy-mcp in your Cline configuration:

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

Setting Up Notifications

1. Download the ntfy app on your mobile device
2. Open the app and subscribe to the same topic name you configured in the server
3. Make sure notifications are enabled for the ntfy app

Triggering Notifications

When working with your AI assistant, include a phrase like this in your prompt:

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

This instructs the AI to use the notification function when it completes the task.

How It Works

The ntfy-mcp server listens for task completion events from the AI assistant via the Model Context Protocol. When a task is completed, it sends a notification to your specified ntfy topic, which then appears as a push notification on your mobile device.

Troubleshooting

• If you're not receiving notifications, make sure you've subscribed to the correct topic name in the ntfy app
• Verify that your server is running and configured with the proper environment variables
• Ensure you've included notification instructions in your prompts to the AI

How to install this MCP server

For Claude Code

To add this MCP server to Claude Code, run this command in your terminal:

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

See the official Claude Code MCP documentation for more details.

For Cursor

There are two ways to add an MCP server to Cursor. The most common way is to add the server globally in the ~/.cursor/mcp.json file so that it is available in all of your projects.

If you only need the server in a single project, you can add it to the project instead by creating or adding it to the .cursor/mcp.json file.

Adding an MCP server to Cursor globally

To add a global MCP server go to Cursor Settings > Tools & Integrations and click "New MCP Server".

When you click that button the ~/.cursor/mcp.json file will be opened and you can add your server like this:

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

Adding an MCP server to a project

To add an MCP server to a project you can create a new .cursor/mcp.json file or add it to the existing one. This will look exactly the same as the global MCP server example above.

How to use the MCP server

Once the server is installed, you might need to head back to Settings > MCP and click the refresh button.

The Cursor agent will then be able to see the available tools the added MCP server has available and will call them when it needs to.

You can also explicitly ask the agent to use the tool by mentioning the tool name and describing what the function does.

For Claude Desktop

To add this MCP server to Claude Desktop:

1. Find your configuration file:

• macOS: ~/Library/Application Support/Claude/claude_desktop_config.json
• Windows: %APPDATA%\Claude\claude_desktop_config.json
• Linux: ~/.config/Claude/claude_desktop_config.json

2. Add this to your configuration file:

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

3. Restart Claude Desktop for the changes to take effect