docs(readme): add tools-exposed table and Claude Desktop config example

This commit is contained in:
tiennm99 committed 2026-05-11 21:45:35 +07:00
1 parent f862220a04
commit 1ef5f63535
1 file changed
+25 -1
+25 -1
View File
@@ -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://<your-worker>.workers.dev/mcp"],
"headers": { "Authorization": "Bearer <MCP_SECRET>" }
}
}
}
```
## License
Apache-2.0 — see [LICENSE](LICENSE).