Telegram MCP Server Oor

🚀 Telegram MCP Server

A server implementing the MCP protocol, offering tools to interact with the Telegram Bot API. This service enables AI assistants to send messages and retrieve bot information.

🚀 Quick Start

Prerequisites

• Set the environment variable TELEGRAM_BOT_TOKEN with your bot token. You can obtain it by creating a new bot with @BotFather on Telegram.

Steps

1. Install dependencies:

npm install

2. Start the server:

node index.js

3. Visit http://localhost:8090 for testing.

✨ Features

Tools

get_bot_info

Retrieve basic information about the bot.

• No parameters required.
• Returns a User object containing bot information.

send_message

Send a message to a specified chat.

• chatId: The unique identifier of the target chat (can be a string or number).
• text: The text of the message to be sent.
• params (optional): Additional message parameters (e.g., parse_mode, reply_markup, etc.).

get_updates

Receive incoming updates using long polling.

• params (optional): An object containing optional parameters:
  • offset (optional): The identifier of the first update to return.
  • limit (optional): Limit the number of updates to retrieve (1 - 100).
  • timeout (optional): The long polling timeout in seconds.
  • allowed_updates (optional): An array of update types to receive.
• Returns an array of Update objects containing various update types:
  • Messages and edited messages
  • Channel posts
  • Business information
  • Action queries
  • Callback queries
  • Shipping queries
  • Pre-checkout queries
  • Votes and their answers
  • Chat member updates
  • Join chat requests
  • Chat promotions

forward_message

Forward any type of message. Service messages and messages containing protected content cannot be forwarded.

• chatId: The unique identifier of the target chat or the channel username (in the format @channelusername).
• fromChatId: The unique identifier of the chat where the original message was sent (or the channel username in the format @channelusername).
• messageId: The identifier of the message in the chat specified by from_chat_id.
• params (optional): An object containing optional parameters:
  • message_thread_id (optional): The unique identifier of the target message thread (topic) (only for forum supergroups).
  • video_start_timestamp (optional): The new start timestamp for the forwarded video.
  • disable_notification (optional): Send the message silently. Users will receive a notification without sound.
  • protect_content (optional): Protect the content of the forwarded message from being forwarded and saved.
• Returns the sent Message object upon success.

📦 Installation

Environment Variables

You need to set the following environment variable:

TELEGRAM_BOT_TOKEN=your_bot_token

Creating a New Bot

Use the /newbot command to create a new bot. @BotFather will ask you for a name and username, then generate an authentication token for authorizing the bot.

The bot's name is displayed in contact details and other places.

The username is a short name used for searching, mentions, and t.me links. It must be 5 - 32 characters long, case-insensitive, and can only contain Latin characters, numbers, and underscores. Your bot won't be able to receive messages directly via @username unless you have a Telegram Channel.

Once done, @BotFather will send the new Telegram Bot API token to your private chat.

📄 License

MIT License

This document is the official guide for the NexusX-MCP/telegram-mcp-server project.