Labsco
sparfenyuk logo

Telegram

β˜… 175

from sparfenyuk

A server for interacting with Telegram via the MTProto API, requiring API credentials.

πŸ”₯πŸ”₯πŸ”₯βœ“ VerifiedAccount requiredAdvanced setup

Telegram MCP server

About

The server is a bridge between the Telegram API and the AI assistants and is based on the Model Context Protocol.

[!IMPORTANT] Ensure that you have read and understood the Telegram API Terms of Service before using this server. Any misuse of the Telegram API may result in the suspension of your account.

<a href="https://glama.ai/mcp/servers/484jega1au"> <img width="380" height="200" src="https://glama.ai/mcp/servers/484jega1au/badge" alt="Telegram Server MCP server" /> </a>

What is MCP?

The Model Context Protocol (MCP) is a system that lets AI apps, like Claude Desktop, connect to external tools and data sources. It gives a clear and safe way for AI assistants to work with local services and APIs while keeping the user in control.

What does this server do?

As of not, the server provides read-only access to the Telegram API.

  • Get the list of dialogs (chats, channels, groups)
  • Get the list of (unread) messages in the given dialog
  • Mark chanel as read
  • Retrieve messages by date and time
  • Download media files
  • Get the list of contacts
  • Draft a message
  • ...

Practical use cases

  • Create a summary of the unread messages
  • Find contacts with upcoming birthdays and schedule a greeting
  • Find discussions on a given topic, summarize them and provide a list of links

Development

Getting started

  1. Clone the repository

  2. Install the dependencies

    Copy & paste β€” that's it
    uv sync
  3. Run the server

    Copy & paste β€” that's it
    uv run mcp-telegram --help

Tools can be added to the src/mcp_telegram/tools.py file.

How to add a new tool:

  1. Create a new class that inherits from ToolArgs

    Copy & paste β€” that's it
    class NewTool(ToolArgs):
        """Description of the new tool."""
        pass

    Attributes of the class will be used as arguments for the tool. The class docstring will be used as the tool description.

  2. Implement the tool_runner function for the new class

    Copy & paste β€” that's it
    @tool_runner.register
    async def new_tool(args: NewTool) -> t.Sequence[TextContent | ImageContent | EmbeddedResource]:
        pass

    The function should return a sequence of TextContent, ImageContent or EmbeddedResource. The function should be async and accept a single argument of the new class.

  3. Done! Restart the client and the new tool should be available.

Validation can accomplished either through Claude Desktop or by running the tool directly.

Debugging the server in terminal

To run the tool directly, use the following command:

Copy & paste β€” that's it

# List all available tools
uv run cli.py list-tools

# Run the concrete tool
uv run cli.py call-tool --name ListDialogs --arguments '{"unread": true}'

Debugging the server in the Inspector

The MCP inspector is a tool that helps to debug the server using fancy UI. To run it, use the following command:

Copy & paste β€” that's it
npx @modelcontextprotocol/inspector uv run mcp-telegram

[!WARNING] Do not forget to define Environment Variables TELEGRAM_API_ID and TELEGRAM_API_HASH in the inspector.