ntfy-me-mcp

NPM Version

License

A streamlined Model Context Protocol (MCP) server for sending notifications via ntfy service 📲

Overview

ntfy-me-mcp provides AI assistants with the ability to send real-time notifications to your devices through the ntfy service. Get notified when your AI completes tasks, encounters errors, or reaches important milestones - all without constant monitoring.

Features

🚀 Quick Setup: Run with npx or docker!
🔔 Real-time Notifications: Get updates on your phone/desktop when tasks complete
🎨 Rich Notifications: Support for topic, title, priorities, emoji tags, and detailed messages
🔒 Secure: Optional authentication with access tokens
🔑 Input Masking: Securely store your ntfy token in your vs config!
🌐 Self-hosted Support: Works with both ntfy.sh and self-hosted ntfy instances

(Coming soon...)

⁄ ntfy Actions: Use ntfy actions to trigger tasks or commands on your device
📨 Email: Send notifications to email (requires ntfy email server configuration)
🔗 Click urls: Ability to customize click urls
📄 Markdown: Support for markdown formatting
and more!

Quickstart - MCP Server Configuration

NPM / NPX (Recommended Method)

Requires npm / npx installed on your system.
This method is recommended for most users as it provides a simple & lightweight method to set up the server.

For the easiest setup with MCP-compatible assistants, add this to your MCP configuration:

Minimal configuration (for public topics on ntfy.sh)

{
  "ntfy-me-mcp": {
    "command": "npx",
    "args": ["ntfy-me-mcp"],
    "env": {
      "NTFY_TOPIC": "your-topic-name"
    }
  }
}

Full configuration (for private servers or protected topics)

Option 1: Direct token in configuration

{
  "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: Using VS Code inputs for secure token handling (recommended)

Add this to your VS Code settings.json file:

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

With this setup, VS Code will prompt you for the token when starting the server and the token will be masked when entered.

Docker

Using with MCP in Docker

Requires Docker installed on your system.
This method is useful for running the server in a containerized environment.
You can use the official Docker images available on Docker Hub or GitHub Container Registry.

Docker Images:

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

In your MCP configuration (e.g., 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

If you need to install and run the server directly (alternative to the MCP configuration above):

Option 1: Install globally

npm install -g ntfy-me-mcp

Option 2: Run with npx

npx ntfy-me-mcp

Option 3: Install locally

# 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: Build and use locally with node command

If you're developing or customizing the server, you might want to run it directly with node:

# 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

Using locally built server with MCP

When configuring your MCP to use a locally built version, specify the node command and path to the built index.js file:

{
  "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
    }
  }
}

Remember to use the absolute path to your build/index.js file in the args array.

Configuration

Environment Variables

Create a .env file in your project directory by copying the provided example:

# Copy the example file
cp .env.example .env

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

Your .env file should contain these variables:

# 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)

Note: The PROTECTED_TOPIC flag helps the application determine whether authentication is required for your topic. When set to "true" and no token is provided, you'll be prompted to enter one. This prevents authentication failures with protected topics.

Usage

Authentication

This server supports both authenticated and unauthenticated ntfy endpoints:

Public Topics: When using public topics on ntfy.sh or other public servers, no authentication is required.
Protected Topics: For protected topics or private servers, you need to provide an access token.

If authentication is required but not provided, you'll receive a clear error message explaining how to add your token.

Setting Up the Notification Receiver

Install the ntfy app on your device
Subscribe to your chosen topic (the same as your NTFY_TOPIC setting)

Using with AI Assistants

When working with your AI assistant, include phrases like:

Write me a React component, and notify me when it's done.

Your AI will use the ntfy_me tool to send a notification upon task completion.

Notification Parameters

The tool accepts these parameters:

| Parameter | Description | Required | |-----------|-------------|----------| | taskTitle | The notification title | Yes | | taskSummary | The notification body | Yes | | priority | Message priority: min, low, default, high, max | No | | tags | Array of notification tags (supports emoji shortcodes) | No |

#ntfy_me({
  taskTitle: "Task Complete", 
  taskSummary: "Your requested operation has been completed successfully.",
  priority: "default",
  tags: ["check", "rocket"]
})

Emoji Shortcodes

You can use emoji shortcodes in your tags for visual indicators:

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

See the full list of supported emoji shortcodes.

Example Notification

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

This will send a high-priority notification with a checkmark emoji.

Development

Building from Source

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

License

This project is licensed under the GNU General Public License v3.0 - see the LICENSE file for details.

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

Made with ❤️ by gitmotion

ntfy-me-mcp

ntfy-me-mcp

Overview

Table of Contents

Features

(Coming soon...)

Quickstart - MCP Server Configuration

NPM / NPX (Recommended Method)

Minimal configuration (for public topics on ntfy.sh)

Full configuration (for private servers or protected topics)

Option 1: Direct token in configuration

Option 2: Using VS Code inputs for secure token handling (recommended)

Docker

Using with MCP in Docker

Installation

Option 1: Install globally

Option 2: Run with npx

Option 3: Install locally

Option 4: Build and use locally with node command

Using locally built server with MCP

Configuration

Environment Variables

Usage

Authentication

Setting Up the Notification Receiver

Using with AI Assistants

Notification Parameters

Emoji Shortcodes

Example Notification

Development

Building from Source

License

Contributing