Telegram MCP server

This server provides Telegram integration through the Model Context Protocol (MCP), allowing you to send messages through Telegram with secure chat ID validation and easy configuration.

Installation

Prerequisites

• Node.js 18 or higher
• Telegram bot token
• Valid chat ID

Setup Steps

1. Clone the repository:

   git clone https://github.com/username/telegram-mcp-server.git
   cd telegram-mcp-server
   

2. Install dependencies:

   npm install
   

3. Configure your Telegram bot token and chat ID (see Configuration section below)

4. Build and run the server:

   npm run build && npm start
   

Configuration

Telegram Bot Setup

1. Create a new Telegram bot by messaging @BotFather on Telegram
2. Follow the prompts to create a new bot
3. Save the bot token provided by BotFather

Finding Your Chat ID

1. Start a conversation with your bot
2. Visit https://api.telegram.org/bot<YOUR_BOT_TOKEN>/getUpdates
3. Look for the chat object in the JSON response to find your chat ID

Server Configuration

Create a configuration file with your bot token and chat ID:

{
  "botToken": "YOUR_BOT_TOKEN",
  "chatId": "YOUR_CHAT_ID",
  "allowedChatIds": ["YOUR_CHAT_ID"]
}

Usage

Starting the Server

Run the server with:

npm start

Sending Messages

The server accepts MCP protocol requests. Here's an example of how to send a message:

const response = await fetch('http://localhost:3000/api/message', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    message: "Hello from MCP server!",
    chatId: "YOUR_CHAT_ID"  // Must match an allowed chat ID
  })
});

API Endpoints

Send Message

• URL: /api/message
• Method: POST
• Body:

  {
    "message": "Your message text",
    "chatId": "YOUR_CHAT_ID"
  }
  

• Response: Status 200 if successful

Troubleshooting

Common Issues

• Authentication Errors: Ensure your bot token is correct
• Forbidden Error: Verify that your chat ID is in the allowed list
• Connection Issues: Make sure your server can reach Telegram's API

How to add this MCP server to Cursor

There are two ways to add an MCP server to Cursor. The most common way is to add the server globally in the ~/.cursor/mcp.json file so that it is available in all of your projects.

If you only need the server in a single project, you can add it to the project instead by creating or adding it to the .cursor/mcp.json file.

Adding an MCP server to Cursor globally

To add a global MCP server go to Cursor Settings > MCP and click "Add new global MCP server".

When you click that button the ~/.cursor/mcp.json file will be opened and you can add your server like this:

{
    "mcpServers": {
        "cursor-rules-mcp": {
            "command": "npx",
            "args": [
                "-y",
                "cursor-rules-mcp"
            ]
        }
    }
}

Adding an MCP server to a project

To add an MCP server to a project you can create a new .cursor/mcp.json file or add it to the existing one. This will look exactly the same as the global MCP server example above.

How to use the MCP server

Once the server is installed, you might need to head back to Settings > MCP and click the refresh button.

The Cursor agent will then be able to see the available tools the added MCP server has available and will call them when it needs to.

You can also explictly ask the agent to use the tool by mentioning the tool name and describing what the function does.