From 1ef5f63535a182655fdb6483c3ac1dd283ffd362 Mon Sep 17 00:00:00 2001 From: tiennm99 Date: Mon, 11 May 2026 21:45:35 +0700 Subject: [PATCH] docs(readme): add tools-exposed table and Claude Desktop config example --- README.md | 26 +++++++++++++++++++++++++- 1 file changed, 25 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index db9f6d1..d9e06bc 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # telegram-mcp -Telegram MCP server exposing a bot via the [Model Context Protocol](https://modelcontextprotocol.io). Can be hosted on Cloudflare Workers. +Cloudflare Worker exposing a Telegram bot as a Model Context Protocol server. ## Quick start @@ -17,6 +17,30 @@ wrangler deploy Local dev: `wrangler dev` +## Tools exposed + +| Tool | Description | Key inputs | +|------|-------------|------------| +| `send_message` | Send a message to the configured Telegram chat | `text` (required), `parse_mode` (HTML/Markdown/MarkdownV2) | +| `get_updates` | Fetch recent pending messages received by the bot | `limit` (1–100, default 10) | +| `get_bot_info` | Return metadata about the configured bot | — | + +## Claude Desktop config + +Add to your `claude_desktop_config.json`: + +```json +{ + "mcpServers": { + "telegram": { + "command": "npx", + "args": ["mcp-remote", "https://.workers.dev/mcp"], + "headers": { "Authorization": "Bearer " } + } + } +} +``` + ## License Apache-2.0 — see [LICENSE](LICENSE).