MCP Server

🚀 FastAlert MCP Server

FastAlertの公式モデルコンテキストプロトコル（MCP）サーバーです。このサーバーを使用すると、AIエージェント（Claude、ChatGPT、Cursorなど）があなたのチャンネルの一覧を取得し、FastAlert APIを介して直接通知を送信できます。

✨ 主な機能

• チャンネル検索：任意の名前フィルターを使用して、すべてのチャンネルを一覧表示します。
• 通知送信：リッチなメッセージ（タイトル、内容、アクション、画像）を1つまたは複数のチャンネルに送信します。

🚀 クイックスタート

{
  "mcpServers": {
    "fastalert": {
      "command": "npx",
      "args": ["-y", "fastalert-mcp-server"],
      "env": {
        "API_KEY": "your-api-key-here"
      }
    }
  }
}

APIキーは、FastAlertにアクセスし、設定に移動することで見つけることができます。

💻 使用例

利用可能なツール

このMCPサーバーを通じて、以下のツールが利用可能です。各ツールは、AIアシスタントによって特定のアクションを実行するために呼び出すことができます。

1. list_channels

利用可能なFastAlertチャンネルのリストを返します。

入力パラメーター:

• name (文字列、オプション): チャンネルを名前でフィルタリングするための検索用語。

呼び出し例:

{
  "name": "Service Alerts"
}

構造化JSON出力（デフォルト）:

{
  "status": true,
  "message": "You have fetch channels successfully",
  "data": {
    "channels": [
      {
        "uuid": "sdf12sdf-6541-5d56-s5sd-1fa513e88a81",
        "name": "Service Alerts",
        "subscriber": 1000
      }
    ]
  }
}

人間が読みやすいテキスト出力:

Here are your FastAlert channels:

Service Alerts
UUID: sdf12sdf-6541-5d56-s5sd-1fa513e88a81
Subscribers: 1000

2. send_message

1つまたは複数のチャンネルに通知メッセージを送信します。

入力パラメーター:

• channel-uuid (文字列、必須): ターゲットチャンネルの一意の識別子。
• title (文字列、必須): アラート通知のタイトル。
• content (文字列、必須): 通知の本文。
• action (文字列、オプション): アクションの種類（'call'、'email'、'website'、'image'）。
• action_value (文字列、オプション): アクションの値（例: URLまたは電話番号）。
• image (文字列、オプション): 含める画像のURLまたは識別子。

呼び出し例:

{
  "channel-uuid": "sdf12sdf-6541-5d56-s5sd-1fa513e88a81",
  "title": "System Update",
  "content": "A new version of the system is now live.",
  "action": "website",
  "action_value": "https://fastalert.now/updates"
}

構造化JSON出力（デフォルト）:

{
  "status": true,
  "message": "Message has been sent successfully"
}

人間が読みやすいテキスト出力:

Message Sent Successfully!

Your message "System Update" has been sent to Service Alerts.

Channel UUID: sdf12sdf-6541-5d56-s5sd-1fa513e88a81
Title: System Update
Content: A new version of the system is now live.

LLMとの統合

Cursorでの設定

1. 設定 -> MCPに移動します。
2. 新しいMCPサーバーを追加をクリックします。
3. 名前: FastAlert
4. タイプ: command
5. コマンド: npx -y fastalert-mcp-server
6. 環境変数: API_KEYを追加します。

ChatGPTでの設定

1. 設定 -> 統合に移動します。
2. MCPサーバーを追加をクリックします。
3. サーバーのホストURL（例: https://mcp.fastalert.now/mcp）を使用します。
4. OAuthのプロンプトに従います。

Claudeでの設定

1. claude_desktop_config.jsonを開きます。
2. 以下のエントリを追加します。

{
  "mcpServers": {
    "fastalert": {
      "command": "npx",
      "args": ["-y", "fastalert-mcp-server"],
      "env": {
        "API_KEY": "your-api-key-here"
      }
    }
  }
}

📦 インストール

必要条件

• Node: バージョン18以上が推奨されます。
• API_KEY: 認証に有効なFastAlert APIキーが必要です。

ローカルインストール

1. リポジトリをクローンします。
2. 環境ファイルの例をコピーします。

   cp .env.example .env
   

3. .envファイルで環境変数を設定します。
4. 依存関係をインストールします。

   npm install
   

5. プロジェクトをビルドします。

   npm run build
   

6. インスペクターテストを実行します。

   npm run inspector
   

7. ローカルで実行します。

   npm start
   

設定（環境変数）

以下の環境変数は、.envファイルで設定する必要があります。

🤝 コントリビュート

コントリビューションを歓迎します！プルリクエストを送信してください。

📄 ライセンス

このプロジェクトはMITライセンスの下でライセンスされています。