🚀 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 服务器通知器进行配置。
| 属性 | 详情 |
|---|---|
PORT |
指定服务运行的端口，默认为 3000。 |
WEBHOOK_URL |
指定 Webhook 的目标 URL。 |
WEBHOOK_TYPE |
指定 Webhook 的类型，支持 discord、slack 和 http。 |
开发
设置开发环境
- 克隆仓库：
git clone https://github.com/zudsniper/mcp-server-notifier.git
cd mcp-server-notifier
- 安装依赖：
npm install
- 启动开发服务器：
npm run dev
测试更改
- 使用 MCP 监视器启动服务器：
npx @modelcontextprotocol/inspector node build/index.js
- 打开浏览器访问监视器界面，进行测试和调试。
发布新版本
- 更新
package.json中的版本号。 - 推送到
release分支。 - GitHub Actions 将自动执行以下操作：
- 运行测试
- 构建并推送 Docker 镜像
- 发布到 npm
- 创建 GitHub 发布
📄 许可证
本项目采用 MIT 许可证，详见 LICENSE 文件。
✨ 贡献
欢迎贡献！请随意提交 Pull Request。