MCP Server

🚀 FastAlert MCP 服務器

FastAlert MCP 服務器是 FastAlert 的官方模型上下文協議（MCP）服務器。該服務器允許 AI 代理（如 Claude、ChatGPT 和 Cursor）列出你的頻道列表，並通過 FastAlert API 直接發送通知。

✨ 主要特性

• 頻道發現：列出你所有的頻道，並可選擇按名稱進行過濾。
• 發送通知：向一個或多個頻道發送豐富的消息（包括標題、內容、操作、圖像）。

🚀 快速開始

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

你可以訪問 FastAlert 並導航到 設置 來找到你的 API 密鑰。

💻 使用示例

可用工具

以下工具可通過此 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

向一個或多個頻道發送通知消息。

輸入參數：

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

📚 詳細文檔

與大語言模型（LLMs）的集成

在 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 許可證。