Ntfy Me MCP

🚀 ntfy-me-mcp 📤

ntfy-me-mcp is an efficient server designed to send notifications to your self-hosted ntfy server. This project supports token-based security authentication and can be run via npx or Docker.

Download the latest version

🚀 Quick Start

ntfy-me-mcp simplifies the process of sending notifications to your self-hosted ntfy server through the Model Context Protocol (MCP). Whether you're an individual developer or part of a team, this tool offers a reliable way to manage notifications.

✨ Features

• Secure Token Authentication: Protect your notifications with tokens.
• Easy to Use: Get started quickly with minimal setup.
• Docker Support: Run the server in a containerized environment.
• Cross-Platform Compatibility: Works on both Linux and Windows systems.
• Lightweight: Designed with low resource consumption while ensuring performance.

📦 Installation

To start using ntfy-me-mcp, follow these steps:

Prerequisites

Before installation, make sure you have the following:

• Node.js installed (for npx usage).
• Docker installed (for containerized usage).
• Access to a self-hosted ntfy server.

Using npx

1. Open your terminal.
2. Run the following command:

npx ntfy-me-mcp

This command will fetch the latest version and run it directly.

Using Docker

1. Pull the Docker image:

docker pull dieg0ski/ntfy-me-mcp

2. Run the Docker container:

docker run -d dieg0ski/ntfy-me-mcp

Configuration

After installation, set the server parameters in the configuration file. Make sure to set appropriate environment variables for your token authentication.

💻 Usage Examples

Basic Usage

Once installed, you can start sending notifications to the ntfy server. To send a notification, use the following command:

npx ntfy-me-mcp send "Your notification message"

Advanced Usage

Secure Token Authentication

To use a token in secure token authentication, pass it via an environment variable:

TOKEN=Your_security_token npx ntfy-me-mcp send "Your notification message"

Docker Usage

If you're using Docker, you can pass the token to the container via an environment variable:

docker run -e TOKEN=Your_security_token dieg0ski/ntfy-me-mcp send "Your notification message"

🤝 Contributing

We welcome contributions to ntfy-me-mcp! If you have any suggestions or improvements, please follow these steps:

1. Fork the repository.
2. Create a new branch for your feature or fix.
3. Commit your changes.
4. Push the branch to your forked repository.
5. Create a pull request.

Please ensure your code adheres to our coding standards and includes tests where applicable.

📄 License

This project is released under the MIT License. For more details, see the LICENSE file.

📞 Contact

If you have any questions or feedback, please use GitHub issues or contact the project maintainers directly.

Download the latest version

Check out more in the Release Notes.