Cyanheads Ntfy MCP Server

🚀 Ntfy MCP 服務器

Ntfy MCP 服務器是一款基於 Model Context Protocol (MCP) 的實用工具，它能將長語言模型 (LLM) 與 Ntfy.sh 通知服務相連接。藉助該服務器，LLM 可通過自然語言處理來發送通知、設置提醒以及觸發警報。

🚀 快速開始

Ntfy MCP 服務器可讓長語言模型輕鬆與 Ntfy.sh 通知服務交互。你可以按照以下步驟使用該服務器：

# 安裝依賴
npm install

# 編譯代碼
npm run build

# 啟動開發服務器
npm start

# 測試命令
npm test

✨ 主要特性

• send_ntfy 工具：LLM 可藉助此工具向指定的 Ntfy 頻道發送自定義通知，還支持豐富的通知格式。
• 資源模板：
  • ntfy://default：用於查詢默認 Ntfy 主題的信息。
  • ntfy://{topic}：可獲取特定 Ntfy 主題的詳細信息。

📦 安裝指南

# 安裝依賴
npm install

# 編譯代碼
npm run build

💻 使用示例

基礎用法

長時間運行的任務通知

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

設置提醒

<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 頁面 或聯繫 項目維護人員。