MCP Server Notifier

🚀 MCP Server Notifier

The MCP Server Notifier is a tool designed to send notifications from MCP servers. It supports multiple Webhook types and offers flexible configuration options, making it easy to integrate into various systems.

🚀 Quick Start

Start via Command Line

mcp-server-notifier --port 3000

Start with Docker

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

📦 Installation

Install with npm

npm install -g mcp-server-notifier

Install with Docker

docker pull zudsniper/mcp-server-notifier:latest

💻 Usage Examples

Send a Simple Notification

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

Send a Notification Using a Template

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

Node.js Example

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

mcpNotifier.sendNotification({
  message: '系统状态正常',
  severity: 'info'
}, function (error, response) {
  if (error) {
    console.error('发送通知失败:', error);
  } else {
    console.log('通知已成功发送，响应:', response);
  }
});

📚 Documentation

Configuration

Environment Variable Configuration

• PORT: Specifies the port on which the service runs, defaulting to 3000.
• WEBHOOK_URL: Specifies the target URL of the Webhook.
• WEBHOOK_TYPE: Specifies the type of the Webhook, supporting discord, slack, and http.

Development

Set Up the Development Environment

1. Clone the repository:

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

2. Install dependencies:

npm install

3. Start the development server:

npm run dev

Test Changes

1. Start the server using the MCP monitor:

npx @modelcontextprotocol/inspector node build/index.js

2. Open the browser to access the monitor interface for testing and debugging.

Release a New Version

1. Update the version number in package.json.
2. Push to the release branch.
3. GitHub Actions will automatically perform the following actions:
   • Run tests.
   • Build and push the Docker image.
   • Publish to npm.
   • Create a GitHub release.

📄 License

MIT License - See the LICENSE file for details.

✨ Contribution

Contributions are welcome! Please feel free to submit a Pull Request.