Cyanheads Ntfy MCP Server

🚀 Ntfy MCP サーバー

Ntfy MCP サーバーは、Model Context Protocol (MCP) をベースにしたツールで、長言語モデル (LLM) を Ntfy.sh 通知サービスに接続するために使用されます。このサーバーにより、LLM は自然言語処理を通じて通知を送信し、リマインダーを設定し、アラートをトリガーすることができます。

✨ 主な機能

• send_ntfy ツール：LLM がカスタム通知を指定の Ntfy チャンネルに送信できるようにし、豊富な通知形式をサポートします。
• リソーステンプレート：
  • ntfy://default：デフォルトの Ntfy トピックの情報を照会します。
  • ntfy://{topic}：特定の Ntfy トピックの詳細情報を取得します。

📦 インストール

# 依存関係のインストール
npm install

# コードのコンパイル
npm run build

# 開発サーバーの起動
npm start

# テストコマンド
npm test

💻 使用例

基本的な使用法

例 1：長時間実行されるタスクの通知

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

例 2：リマインダーの設定

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

📚 ドキュメント

ツールパラメータ

send_ntfy ツールパラメータ

このツールは以下のパラメータをサポートしています。

リソーステンプレート

ntfy://default

• 説明：デフォルトの Ntfy トピックの情報を返します。
• 応答形式：

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

ntfy://{topic}

• 説明：指定されたトピックの詳細情報を返します。
• URL の例：ntfy://alerts
• 応答形式：

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

貢献ガイド

貢献の方法

1. 問題の報告：GitHub Issues を通じてエラーや機能リクエストを送信します。
2. 修正の提出：リポジトリを Fork し、ブランチを作成し、Pull Request を送信します。
3. 新機能の開発：未完成の機能リストを確認し、貢献を始めます。

開発のベストプラクティス

• TypeScript のベストプラクティスに従い、強い型付けを維持します。
• コードの可読性とドキュメントの明確性を確保します。
• 小さく頻繁な変更を提出し、詳細なコミットメッセージを提供します。
• マージリクエストに関連するテストケースを含めます。

📄 ライセンス

このプロジェクトは MIT License で配布されており、詳細な条項は LICENSE ファイルを参照してください。

謝辞

以下のプロジェクトの貢献者に感謝します。

• 開発チーム：[Your Name], [Collaborator Name]
• コミュニティ貢献者：[Contributor 1], [Contributor 2]

詳細情報については、GitHub ページ を訪問するか、プロジェクトメンテナー に連絡してください。