- Home
- MCP servers
- Notifyme
Notifyme
- typescript
0
GitHub Stars
typescript
Language
7 months ago
First Indexed
3 months ago
Catalog Refreshed
Documentation & install
Readme and setup notes from the catalogue, plus a client-ready config you can copy for your MCP host.
Installation
Add the following to your MCP client configuration file.
Configuration
View docs{
"mcpServers": {
"thesammykins-notifyme_mcp": {
"command": "node",
"args": [
"path/to/notifyme_mcp/dist/index.js"
],
"env": {
"NOTIFY_ME_ENV_DIR": "/path/to/config",
"SLACK_WEBHOOK_URL": "YOUR_SLACK_WEBHOOK_URL",
"NOTIFY_ME_ENV_FILE": "/path/to/.env",
"DISCORD_WEBHOOK_URL": "YOUR_DISCORD_WEBHOOK_URL"
}
}
}
}You run a compact MCP server that sends rich notifications to Discord and Slack webhooks. It handles service auto-detection, secure handling of webhook URLs, and robust retry logic so you can reliably notify your team or agents from any MCP-enabled workflow.
How to use
Install and run the server, then connect your MCP client to send notifications. You can target Discord, Slack, or both, and you can supply rich content through embeds or blocks. The server will automatically pick the available webhook services if you do not specify a target, and it will retry on rate limits to ensure delivery.
From an MCP client, call the available tools to send a notification, validate a webhook, or list configured services. You can customize the sender you appear as, provide rich content, and control which service receives the message. Security is baked in, so webhook URLs are never logged or exposed in process details.
How to install
Prerequisites you need to have installed before you begin:
-
Node.js ≥ 23.7.0
-
npm ≥ 10.9.2
-
Discord and/or Slack webhook URLs
Follow these concrete steps to get started:
# 1. Clone the repository
git clone https://github.com/thesammykins/notifyme_mcp.git
cd notifyme_mcp
# 2. Install dependencies
npm install
# 3. Configure webhooks
cp .env.example .env
# Edit .env and replace webhook placeholders
# 4. Build the project
npm run build
# 5. Start the production server
npm start
Configuration and environment
Create a configuration file with your webhook URLs. The server supports both Discord and Slack webhooks. You provide the values for these environment variables to enable delivery to the respective services.
# Discord webhook URL (optional)
DISCORD_WEBHOOK_URL="https://discord.com/api/webhooks/YOUR_ID/YOUR_TOKEN"
# Slack webhook URL (optional)
SLACK_WEBHOOK_URL="https://hooks.slack.com/services/T00/B00/XXXX"
# Optional: Custom .env file location
# NOTIFY_ME_ENV_FILE="/path/to/.env"
# NOTIFY_ME_ENV_DIR="/path/to/directory"
Security and reliability
Webhook URLs are protected by design. They never appear in logs, error messages, or process listings, and sensitive information is automatically redacted from logs.
Inputs are validated with strict schemas. The server also handles rate limiting with automatic retry using exponential backoff, and temporary files are created with restrictive permissions (077) to minimize exposure.
Rich content and service detection
You can send rich content to Discord via embeds and to Slack via blocks or attachments. The server can auto-detect which services are configured and choose a default when not specified: if both are configured, the default is Discord for backward compatibility unless you explicitly request both.
If you want to target specific services, supply the service field with discord, slack, or both when sending a notification.
Troubleshooting
Common issues include missing or invalid webhook URLs, Discord message length limits, or JSON formatting errors for embeds/blocks. Ensure that your .env file exists with valid URLs and that the environment variable names match exactly.
If you experience timeouts or delivery problems, check network connectivity to webhook endpoints and verify that the configured webhooks are active.
Development and tooling
Run the development mode to watch for changes and rebuild automatically.
Development commands you will use:
npm run dev
Project structure and MCP integration notes
The MCP server is designed to be used through standard input/output with an MCP client. The primary entry points and related modules are organized to handle configuration, payload building for Discord and Slack, and secure sending with retry logic.
Available tools
send_notification
Send notifications to Discord and/or Slack webhooks, with optional rich content, username, avatar, and tts options.
validate_webhook
Test webhook connectivity by sending a test message to the configured services.
list_services
List the configured webhook services and indicate the auto-detected default.