MCP Server Notifier

🚀 MCP 服務器通知器

MCP 服務器通知器是一款實用工具，可幫助用戶便捷地發送服務器通知。它支持多種安裝方式和配置選項，能滿足不同場景下的通知需求。

🚀 快速開始

你可以通過命令行或者 Docker 來啟動 MCP 服務器通知器。

使用命令行啟動

mcp-server-notifier --port 3000

使用 Docker 啟動

docker run -p 3000:3000 zudsniper/mcp-server-notifier

📦 安裝指南

本工具支持使用 npm 和 Docker 進行安裝。

使用 npm 安裝

npm install -g mcp-server-notifier

使用 Docker 安裝

docker pull zudsniper/mcp-server-notifier:latest

💻 使用示例

基礎用法

發送簡單通知

{
  "message": "任務已完成",
  "severity": "info"
}

使用模板發送通知

{
  "template": "status",
  "templateData": {
    "status": "completed",
    "details": "所有任務已成功完成。"
  }
}

高級用法

Node.js 示例

const mcpNotifier = require('mcp-server-notifier');

mcpNotifier.sendNotification({
  message: '系統狀態正常',
  severity: 'info'
}, function (error, response) {
  if (error) {
    console.error('發送通知失敗:', error);
  } else {
    console.log('通知已成功發送，響應:', response);
  }
});

📚 詳細文檔

配置

你可以通過環境變量對 MCP 服務器通知器進行配置。

開發

設置開發環境

1. 克隆倉庫：

git clone https://github.com/zudsniper/mcp-server-notifier.git
cd mcp-server-notifier

2. 安裝依賴：

npm install

3. 啟動開發服務器：

npm run dev

測試更改

1. 使用 MCP 監視器啟動服務器：

npx @modelcontextprotocol/inspector node build/index.js

2. 打開瀏覽器訪問監視器界面，進行測試和調試。

發佈新版本

1. 更新 package.json 中的版本號。
2. 推送到 release 分支。
3. GitHub Actions 將自動執行以下操作：
   • 運行測試
   • 構建並推送 Docker 鏡像
   • 發佈到 npm
   • 創建 GitHub 發佈

📄 許可證

本項目採用 MIT 許可證，詳見 LICENSE 文件。

✨ 貢獻

歡迎貢獻！請隨意提交 Pull Request。