Ntfy MCP Server

🚀 Ntfy-MCP サーバー

Ntfy-MCP サーバーは、Node.js をベースにしたツールです。Model Context Protocol (MCP) を通じて言語モデルと Ntfy.sh 通知サービスを接続することを目的としています。このプロジェクトにより、LLM（大規模言語モデル）が直接携帯電話や他のデバイスに通知を送信できるようになります。

🚀 クイックスタート

Ntfy-MCP サーバーを使用することで、LLM が Ntfy を介して通知を送信できます。以下のセクションでは、その機能、使い方、インストール方法などを詳しく説明します。

✨ 主な機能

コア機能

• プロトコルサポート：MCP プロトコルを実装し、LLM がツールを介して API を呼び出して通知を送信できるようにします。
• Ntfy 統合：すべての Ntfy 機能をサポートします。具体的には以下のようなものがあります。
  • メッセージのタイトルと内容
  • タグ（#tag）
  • 優先度設定
  • 遅延送信
  • カスタムアクション
• 複数トピックサポート：異なるトピックを使用して、異なる通知ロジックを実現できます。

💻 使用例

基本的な使用法

Ntfy 通知の送信

{
  "tool_name": "send_ntfy",
  "args": {
    "topic": "string", // 必須、Ntfy トピック名
    "title?: string, // オプション、通知タイトル
    "message?: string, // オプション、通知内容
    "tags?: string[], // オプション、通知タグ
    "priority?: number, // オプション、優先度（1 - 5）
    "schedule?: string, // オプション、ISO 8601 形式の時間文字列、遅延送信時間を表す
    "actions?: {
      id: string,
      label: string,
      action: "view" | "http",
      url: string,
      method?: "GET" | "POST" | "PUT" | "DELETE",
      body?: string
    }[]
  }
}

高度な使用法

MCP クライアントでの基本的な使用例

<use_mcp_tool>
  <server_name>ntfy-mcp-server</server_name>
  <tool_name>send_ntfy</tool_name>
  <arguments>
    {
      "topic": "my-topic",
      "message": "これはテスト通知です。"
    }
  </arguments>
</use_mcp_tool>

カスタムアクション付きの使用例

<use_mcp_tool>
  <server_name>ntfy-mcp-server</server_name>
  <tool_name>send_ntfy</tool_name>
  <arguments>
    {
      "topic": "my-topic",
      "title": "システム通知",
      "message": "以下のリンクをクリックして詳細を表示します。",
      "tags": ["system", "notification"],
      "actions": [
        {
          "id": "click_me",
          "label": "詳細を表示",
          "action": "http",
          "url": "https://example.com/notification/123"
        }
      ]
    }
  </arguments>
</use_mcp_tool>

使用シナリオ例

例 1：携帯電話への通知

<use_mcp_tool>
  <server_name>ntfy-mcp-server</server_name>
  <tool_name>send_ntfy</tool_name>
  <arguments>
    {
      "topic": "my-phone",
      "message": "新しいメールが届きました。確認してください。"
    }
  </arguments>
</use_mcp_tool>

例 2：Web プッシュ

<use_mcp_tool>
  <server_name>ntfy-mcp-server</server_name>
  <tool_name>send_ntfy</tool_name>
  <arguments>
    {
      "topic": "web-notifications",
      "title": "システムメッセージ",
      "message": "新しいコメントがあり、処理待ちです。",
      "tags": ["system", "comment"]
    }
  </arguments>
</use_mcp_tool>

📚 ドキュメント

ディレクトリ構造

src/
├── tools/                 # ツールモジュールディレクトリ
│   └── send_ntfy.ts      # Ntfy 通知送信ツールの実装
├── services/             # サードパーティサービスアダプター
│   └── ntfy.ts          # Ntfy サービスアダプター
└── main.ts               # アプリケーションのエントリーファイル

ディレクトリ構造の説明

.
├── src/
│   ├── tools/
│   │   └── send_ntfy.ts       # Ntfy 通知送信の具体的な実装
│   ├── services/
│   │   └── ntfy.ts           # Ntfy サービスインターフェースを提供するアダプター
│   └── main.ts               # アプリケーションの起動ファイル
├── .env                       # 環境変数の設定ファイル
└── package.json              # プロジェクトの依存関係とスクリプト情報

📦 インストール

依存関係のインストール

npm install @model-context-protocol/core ntfy axios

環境変数の設定

プロジェクトのルートディレクトリにある .env ファイルを編集します。

NFTY_API_KEY=your_api_key_here # 必須、あなたの Ntfy API キー
PORT=3001                    # オプション、デフォルトは 3001
DEBUG=true                   # オプション、デバッグモードを有効にする

利用可能なスクリプト

# 開発モードで起動
npm run dev

# 本番環境用のビルド
npm run build

# ビルド後のアプリケーションを起動
npm start

🔧 技術詳細

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

• ログ記録：main.ts でデバッグモードを有効にすることで、問題のトラブルシューティングが容易になります。
• 依存関係管理：定期的にパッケージの依存関係をチェックして更新し、互換性を保ちます。
• モジュール分割：機能モジュールに基づいてコードを分割し、プロジェクト構造を明確に保ちます。

🤝 貢献ガイド

1. コードリポジトリ：GitHub リポジトリ
2. 問題の報告：GitHub で Issues または Pull Request を送信してください。
3. 開発規約：
   • プロジェクトの既存のコードスタイルと構造に従ってください。
   • 新しい機能を追加する場合は、ユニットテストを用意してください。

📄 ライセンス

このプロジェクトは MIT ライセンスの下でオープンソース化されています。詳細なライセンス情報は LICENSE ファイルを参照してください。

詳細については、プロジェクトの Wiki ページ を参照するか、メンテナに連絡してください。