mcpField
R
revx-telegram

revx-telegram

github.com/revolut-engineeringOther7490 installsUpdated 1w ago
Repository

About revx-telegram

revx-telegram is a skill for configuring and managing Telegram alert connections through the `revx` CLI. It guides setup of bot credentials and enables monitor and grid bot notifications.

Key features

  1. 01Add Telegram connections with token and chat ID
  2. 02Test messages before saving a connection
  3. 03List, enable, disable, and delete connections
  4. 04Send monitor and grid bot notifications

Use cases

  1. 01Configure Telegram delivery for monitor alerts
  2. 02Receive grid bot lifecycle, fill, and P&L updates

Install

Copy the command and run it in a terminal.

$npx skills add https://github.com/revolut-engineering/revolut-x-api --skill revx-telegram

After installing, type/revx-telegramin Claude Code to confirm it loaded.

Details

From the project README

Telegram Connector (revx connector telegram)

Configure Telegram bot integrations for alert notifications from monitors and the grid bot.

Auth required. Make sure revx is installed and configured before running these commands. If any command fails with an auth-related error — Auth not configured, No private key found, Authentication failed (401), Invalid signature, insecure permissions, or a missing key/config file at ~/.config/revolut-x/ — invoke the revx-auth skill immediately and apply the fix yourself. Do not interrupt the user to ask them to run setup. Only escalate to the user for steps only they can perform (pasting the API key, registering the public key in their Revolut X profile, choosing a passphrase). After the fix, retry the original command.


Add a Connection

revx connector telegram add --token <bot-token> --chat-id <chat-id>
revx connector telegram add --token <token> --chat-id <id> --label prod --test
FlagDescription
--token <token>Telegram Bot API token (required)
--chat-id <id>Telegram chat ID (required)
--label <name>Connection label (default: "default")
--testSend a test message first and save the connection only if it arrives
Behavioral Instructions for Claude

When the user wants to set up Telegram notifications, they need two things: a bot token and a chat ID. If either is missing, walk them through the setup below. Share the relevant steps as a message the user can follow — do not attempt to perform these steps via tools, as they require the user's Telegram app.

Setup Guide: Getting a Bot Token and Chat ID

Share the following instructions with the user when they need help setting up Telegram:

Step 1 — Create a Telegram Bot (to get the bot token):

  1. Open Telegram (mobile or desktop)
  2. Search for @BotFather and start a chat
  3. Send /newbot
  4. BotFather will ask for a display name (e.g., "My RevX Alerts") — type any name
  5. BotFather will ask for a username ending in bot (e.g., my_revx_alerts_bot) — must be unique
  6. BotFather replies with your bot token — it looks like 123456789:ABCdefGHI-jklMNOpqrSTUvwxYZ
  7. Copy the token and share it back here

Step 2 — Get your Chat ID:

  1. Open Telegram and find your new bot (search for the username you just created)
  2. Send any message to the bot (e.g., "hello")
  3. Open this URL in a browser — replace <YOUR_TOKEN> with the token from Step 1:
    https://api.telegram.org/bot<YOUR_TOKEN>/getUpdates
    
  4. In the JSON response, find "chat":{"id": <number>} — that number is your chat ID
  5. It's usually a positive number for personal chats (e.g., 123456789) or a negative number for group chats (e.g., -1001234567890)
  6. Copy the chat ID and share it back here

Step 3 — Add the connection (Claude runs this):

Once the user provides both values, run:

revx connector telegram add --token <bot-token> --chat-id <chat-id> --test

The --test flag sends a test message before saving. The connection is saved only if the message arrives. If it fails, the command exits 1, says why and saves nothing, so fix the token or chat ID and run it again. The token must look like 123456789:AA... and the chat ID like 123456789, -1001234567890 or @mychannel, otherwise nothing is saved either.

Troubleshooting:

  • "chat not found" or empty getUpdates response — the user must send a message to the bot first, then retry the URL
  • "Unauthorized" — the token is incorrect, ask the user to copy it again from BotFather
  • For group chats: the bot must be added to the group as a member, then someone must send a message in the group before getUpdates shows the group chat ID

Manage Connections

revx connector telegram list                       # List all connections
revx connector telegram test <connection-id>       # Send test message
revx connector telegram test <id> --message "Custom test"
revx connector telegram enable <connection-id>     # Enable connection
revx connector telegram disable <connection-id>    # Disable connection
revx connector telegram delete <connection-id>     # Delete connection

How Notifications Work

Once a Telegram connection is configured and enabled:

  • Monitor alerts (see revx-monitor skill) are automatically sent as Telegram messages when triggered
  • Grid bot events (see revx-strategy skill) send notifications on startup, shutdown, fills, and P&L changes

No additional configuration is needed — active monitors and the grid bot detect enabled Telegram connections automatically.


Related Skills

SkillPurpose
revx-monitorSet up price/indicator alerts that notify via Telegram
revx-strategyGrid bot sends trade notifications via Telegram
revx-authAPI key setup and configuration

Comments

Markdown supported