simple-notify-mcp
v0.1.11
Published
Model Context Protocol (MCP) server for text-to-speech and Telegram notifications in Codex and Claude Code.
Maintainers
Readme
simple-notify-mcp
Model Context Protocol (MCP) server for Codex and Claude Code with text-to-speech (TTS) and Telegram notifications.
Tools
simple_notify_status: always available; returns capabilities, missing config, and setup-web state.tts_say: text-only input; async by default, uses configured provider (openai,fal-minimax,fal-elevenlabs) with macOSsayfallback.telegram_notify: available when Telegram bot token + chat id are configured; supportsparse_mode(plain,markdown,html) and returnshasUnreadIncomingfrom a non-advancing unread peek.telegram_send_photo: available when Telegram bot token + chat id are configured; sends local image files (jpg,jpeg,png,webp,gif,bmp) with optional caption andparse_mode.telegram_read_incoming: available when Telegram bot token + chat id are configured; reads incoming updates for configured chat.telegram_read_media: available when Telegram bot token + chat id are configured; reads image updates and can return MCP image content blocks.
Telegram formatting quick examples:
telegram_notify({ "text": "**Build done**. [Diff](https://example.com)", "parse_mode": "markdown" })telegram_send_photo({ "filePath": "/tmp/plan.png", "caption": "<b>Plan snapshot</b>", "parse_mode": "html" })- Markdown mode supports a safe subset:
**bold**,*italic*,_italic_,~~strike~~,`code`,[text](https://url), and#headings. - HTML mode is validated and allows only Telegram-safe tags; links must be
https://orhttp://. - If Markdown entity parsing fails on Telegram side, the server retries once with plain text for reliability.
- Telegram limits are enforced before send (message: 4096 chars, caption: 1024 chars).
Install (npx)
1) Recommended: keep setup web always enabled
Use this if you want easy reconfiguration anytime.
codex mcp remove simple-notify
codex mcp add simple-notify -- \
npx -y simple-notify-mcp@latest \
--enable-setup-webAsk your agent (Codex / Claude Code / another agent) to run simple_notify_status and send you setupWeb.url, then open that link.
2) Minimal runtime: no setup web
Use this if config is already done and you do not want the setup server running.
codex mcp remove simple-notify
codex mcp add simple-notify -- npx -y simple-notify-mcp@latestIf you need to change provider/keys later, switch back to mode 1.
Optional: pass API keys via env when adding:
codex mcp add simple-notify -- \
--env OPENAI_API_KEY="$OPENAI_API_KEY" \
--env FAL_KEY="$FAL_KEY" \
-- npx -y simple-notify-mcp@latest \
--enable-setup-web \
--setup-port 21420Install (Claude Code)
1) Recommended: keep setup web always enabled
Use this if you want easy reconfiguration anytime.
claude mcp remove simple-notify
claude mcp add --transport stdio simple-notify -- \
npx -y simple-notify-mcp@latest \
--enable-setup-webAsk Claude Code to run simple_notify_status and share setupWeb.url, then open that link.
2) Minimal runtime: no setup web
Use this if config is already done and you do not want the setup server running.
claude mcp remove simple-notify
claude mcp add --transport stdio simple-notify -- npx -y simple-notify-mcp@latestIf you need to change provider/keys later, switch back to mode 1.
Optional: pass API keys via env when adding:
claude mcp add --transport stdio \
--env OPENAI_API_KEY="$OPENAI_API_KEY" \
--env FAL_KEY="$FAL_KEY" \
simple-notify -- \
npx -y simple-notify-mcp@latest \
--enable-setup-webHow To Use
Think of simple-notify-mcp as your "agent communication layer":
- voice message when work is done (
tts_say) - Telegram ping when work is done or while work is in progress (
telegram_notify) - optional Telegram inbox reads (
telegram_read_incoming,telegram_read_media)
Typical flow
Start with setup web enabled (recommended mode above).
Ask your agent for setup link:
- "Run
simple_notify_statusand send mesetupWeb.url."
Open the link, set keys/provider/chat id, then click Save. In some clients, you may need to restart the agent process after adding keys so all tools become available.
After that, ask your agent to always:
- speak on completion
- send Telegram on completion
- send Telegram updates during long tasks
What to ask your agent (examples)
- Setup:
- "Please configure simple-notify and give me the setup link."
- Completion behavior:
- "When you finish a task, call TTS and Telegram notify."
- Long task behavior:
- "If task is long, notify me on progress milestones and before escalation requests."
- Read incoming Telegram:
- "If notify result says unread incoming, read it and continue."
TTS/Notification style tips (easy and practical)
You can tune:
- language (EN/RU/etc)
- tone (calm/energetic/formal/casual)
- emotion (neutral/cheerful/serious)
- slang level
- pacing
Examples:
- EN calm:
Task complete. Build passed. I left a short summary.
- EN upbeat:
Done. All checks are green.
- RU neutral:
Готово. Проверки прошли успешно.
- RU casual:
Запилил фичу, всё пашет, тесты зеленые.
Copy-Paste For AGENTS.md / CLAUDE.md
The easiest way to tune agent behavior is to add explicit tool-usage instructions to your agent config. You can copy-paste this block and adjust it as needed:
If user uses simple-notify-mcp:
1) Setup flow
- Call simple_notify_status.
- If setupWeb.running=true, return setupWeb.url to user.
- If setup web is disabled, tell user to run MCP with --enable-setup-web.
2) Completion flow
- On task completion, call tts_say with a short completion message.
- Then call telegram_notify with a short completion summary.
- If telegram_notify returns hasUnreadIncoming=true, optionally call telegram_read_incoming.
3) Long-task flow
- For long tasks, send milestone progress via telegram_notify.
- Send a notify before asking user for escalation/approval.
- Keep updates useful (no spam).
4) Safety
- Never include secrets/tokens in TTS or Telegram messages.Configuration Schema
Config file path (default):
$XDG_CONFIG_HOME/simple-notify-mcp/config.json- or
~/.config/simple-notify-mcp/config.json
Env key precedence:
OPENAI_API_KEYoverrideskeys.openai.apiKeyFAL_KEY/FAL_API_KEYoverridekeys.fal.apiKey
{
"tts": {
"provider": "openai",
"params": {
"openai": {
"model": "gpt-4o-mini-tts",
"voice": "alloy",
"speed": 1,
"responseFormat": "mp3",
"instructions": "Speak calmly and clearly."
},
"falMinimax": {
"voiceId": "Wise_Woman",
"speed": 1,
"vol": 1,
"pitch": 0,
"emotion": "neutral",
"englishNormalization": false,
"languageBoost": "auto",
"outputFormat": "url",
"audioFormat": "mp3",
"audioSampleRate": 32000,
"audioChannel": 1,
"audioBitrate": 128000,
"normalizationEnabled": true,
"normalizationTargetLoudness": -18,
"normalizationTargetRange": 8,
"normalizationTargetPeak": -0.5,
"voiceModifyPitch": 0,
"voiceModifyIntensity": 0,
"voiceModifyTimbre": 0,
"pronunciationToneList": [
"燕少飞/(yan4)(shao3)(fei1)"
]
},
"falElevenlabs": {
"voice": "Rachel",
"stability": 0.5,
"similarityBoost": 0.75,
"style": 0,
"speed": 1,
"timestamps": false,
"languageCode": "en",
"applyTextNormalization": "auto"
}
}
},
"telegram": {
"chatId": "123456789"
},
"keys": {
"openai": {
"apiKey": "sk-..."
},
"fal": {
"apiKey": "fal_..."
},
"telegram": {
"botToken": "123:ABC"
}
},
"misc": {
"ttsAsyncByDefault": true
}
}MiniMax voices available in setup UI:
Wise_Woman,Friendly_Person,Inspirational_girl,Deep_Voice_Man,Calm_Woman,Casual_Guy,Lively_Girl,Patient_Man,Young_Knight,Determined_Man,Lovely_Girl,Decent_Boy,Imposing_Manner,Elegant_Man,Abbess,Sweet_Girl_2,Exuberant_Girl
Setup Web UI Flags (disabled by default)
Flags:
--enable-setup-web(default off)--setup-host(default127.0.0.1; non-loopback values are clamped to127.0.0.1)--setup-port(default21420)--setup-token(optional; if omitted, generated per run)
Behavior:
- setup web starts whenever
--enable-setup-webis set - local bind only
- if
--setup-portis occupied, server uses the next free local port - setup URL includes the current run token query parameter
- use
simple_notify_statusto discoversetupWeb.urlandmissingConfig
Tool Contracts
simple_notify_status
Input:
{}tts_say
Input:
{ "text": "Job done" }Output notes:
- default mode is async (
misc.ttsAsyncByDefault=true), so tool returns immediately after queuing speech - set
misc.ttsAsyncByDefault=falsein setup web Misc tab for blocking/sync behavior
telegram_notify
Input:
{ "text": "Job done" }Output notes:
- returns
{ "accepted": true }by default - adds
hasUnreadIncoming: trueonly when unread messages are detected - performs a non-advancing unread peek (
limit=6) before returning
telegram_read_incoming
Input:
{
"limit": 20,
"timeoutSeconds": 0,
"advanceCursor": true
}Output notes:
- reads updates filtered to configured
telegram.chatId - tracks cursor in memory for the current server run
- set
advanceCursor=falseto peek without moving cursor
telegram_read_media
Input:
{
"limit": 20,
"timeoutSeconds": 0,
"advanceCursor": true,
"includeData": true,
"maxImages": 1,
"maxBytesPerImage": 8000000
}Output notes:
- only image media is returned (text-only updates are ignored)
- when
includeData=true, tool can return MCPimagecontent blocks (base64 + mime type) - large files are skipped based on
maxBytesPerImage - media cursor is tracked in memory for current server run
Self-test
npm run self-test -- --text "Task complete. Build passed and your results are ready."Disable one side:
npm run self-test -- --no-tts
npm run self-test -- --no-telegramNotes
tts_sayis text-only; provider/model/voice/etc are server config.tts_sayruns async by default; switch in setup webMisctab if you need sync mode.- OpenAI and FAL network errors fall back to macOS
saywhen available. - OpenAI
responseFormat=pcmis not directly playable by this local player path. - Runtime config is reloaded from disk before tool calls, so manual config edits are picked up without restarting the MCP process.
