Cyanheads Ntfy MCP Server

🚀 Ntfy MCP Server

The Ntfy MCP Server is a tool based on the Model Context Protocol (MCP) that connects large language models (LLMs) to the Ntfy.sh notification service. This server enables LLMs to send notifications, set reminders, and trigger alerts through natural language processing.

🚀 Quick Start

The Ntfy MCP Server provides a seamless way for LLMs to interact with the Ntfy.sh notification service. With its intuitive tools and resource templates, you can quickly integrate notification capabilities into your LLM applications.

✨ Features

• send_ntfy Tool: Allows LLMs to send custom notifications to specified Ntfy channels, supporting rich notification formats.
• Resource Templates:
  • ntfy://default: Query information about the default Ntfy topic.
  • ntfy://{topic}: Retrieve detailed information about a specific Ntfy topic.

📦 Installation

# Install dependencies
npm install

# Compile the code
npm run build

# Start the development server
npm start

# Test commands
npm test

💻 Usage Examples

Basic Usage

Example 1: Notification for a Long-running Task

<TN>
  <action>tnfy Notify</action>
  <parameters>
    <topic>default</topic>
    <title>Long-running Task Complete</title>
    <message>The background data processing task has finished successfully.</message>
    <tags>info</tags>
  </parameters>
</TN>

Example 2: Setting a Reminder

<TN>
  <action>tnfy Schedule Reminder</action>
  <parameters>
    <topic>reminders</topic>
    <title>Team Meeting</title>
    <message>Don't forget the team meeting at 3 PM today.</message>
    <tags>calendar, reminder</tags>
    <priority>4</priority>
  </parameters>
</TN>

📚 Documentation

Tool Parameters

send_ntfy Tool Parameters

This tool supports the following parameters:

Resource Templates

ntfy://default

• Description: Returns information about the default Ntfy topic.
• Response Format:

{
    "topic": "default",
    "messages": number,
    "created_at": timestamp,
    "updated_at": timestamp
}

ntfy://{topic}

• Description: Returns detailed information about the specified topic.
• Example URL: ntfy://alerts
• Response Format:

{
    "topic": string,
    "messages": array of messages,
    "created_at": timestamp,
    "updated_at": timestamp
}

🤝 Contribution Guidelines

How to Contribute

1. Report Issues: Submit bugs or feature requests via GitHub Issues.
2. Submit Fixes: Fork the repository, create a branch, and submit a Pull Request.
3. Develop New Features: Check the list of unfinished features and start contributing.

Development Best Practices

• Follow TypeScript best practices and maintain strong typing.
• Ensure code readability and clear documentation.
• Submit small and frequent changes with detailed commit messages.
• Include relevant test cases in merge requests.

📄 License

This project is distributed under the MIT License. Please refer to the LICENSE file for specific terms.

🙏 Acknowledgments

Thanks to the contributors of the following projects:

• Development Team: [Your Name], [Collaborator Name]
• Community Contributors: [Contributor 1], [Contributor 2]

For more information, please visit our GitHub page or contact Project Maintainers.