telegram-dev 0.4.0__tar.gz

telegram_dev-0.4.0/.agents/plugins/marketplace.json

@@ -0,0 +1,20 @@
+{
+  "name": "telegram-dev-tools",
+  "interface": {
+    "displayName": "Telegram Dev Tools"
+  },
+  "plugins": [
+    {
+      "name": "telegram-dev",
+      "source": {
+        "source": "local",
+        "path": "./"
+      },
+      "policy": {
+        "installation": "AVAILABLE",
+        "authentication": "ON_INSTALL"
+      },
+      "category": "Developer Tools"
+    }
+  ]
+}

telegram_dev-0.4.0/.claude-plugin/marketplace.json

@@ -0,0 +1,17 @@
+{
+  "name": "telegram-dev-tools",
+  "owner": {"name": "Kay0k1"},
+  "metadata": {"description": "Independent Telegram development tools with official documentation", "version": "0.4.0"},
+  "plugins": [
+    {
+      "name": "telegram-dev",
+      "source": "./",
+      "description": "Source-verified Telegram development with official documentation search",
+      "version": "0.4.0",
+      "homepage": "https://github.com/Kay0k1/telegram-dev",
+      "repository": "https://github.com/Kay0k1/telegram-dev",
+      "license": "MIT",
+      "keywords": ["telegram", "documentation", "bot-api", "mini-apps", "mtproto", "tdlib"]
+    }
+  ]
+}

telegram_dev-0.4.0/.claude-plugin/plugin.json

@@ -0,0 +1,19 @@
+{
+  "name": "telegram-dev",
+  "version": "0.4.0",
+  "displayName": "Telegram Dev",
+  "description": "Source-verified Telegram development across Bot API, Mini Apps, MTProto, TDLib, media and public releases. Independent project by Kay0k1.",
+  "author": {
+    "name": "Kay0k1",
+    "url": "https://github.com/Kay0k1"
+  },
+  "homepage": "https://github.com/Kay0k1/telegram-dev",
+  "repository": "https://github.com/Kay0k1/telegram-dev",
+  "license": "MIT",
+  "icon": "./assets/logo.svg",
+  "documentationUrl": "https://github.com/Kay0k1/telegram-dev#readme",
+  "supportUrl": "https://github.com/Kay0k1/telegram-dev/issues",
+  "privacyPolicyUrl": "https://github.com/Kay0k1/telegram-dev/blob/main/docs/privacy.md",
+  "termsOfServiceUrl": "https://github.com/Kay0k1/telegram-dev/blob/main/docs/terms.md",
+  "keywords": ["telegram", "bot-api", "mini-apps", "mtproto", "tdlib", "documentation"]
+}

telegram_dev-0.4.0/.codex-plugin/plugin.json

@@ -0,0 +1,53 @@
+{
+  "name": "telegram-dev",
+  "version": "0.4.0",
+  "description": "Source-verified Telegram development across Bot API, Mini Apps, MTProto, TDLib and public release history",
+  "author": {
+    "name": "Kay0k1",
+    "url": "https://github.com/Kay0k1"
+  },
+  "homepage": "https://github.com/Kay0k1/telegram-dev",
+  "repository": "https://github.com/Kay0k1/telegram-dev",
+  "license": "MIT",
+  "keywords": ["telegram", "bot-api", "mini-apps", "mtproto", "tdlib", "documentation"],
+  "skills": "./skills/",
+  "mcpServers": {
+    "telegram-knowledge": {
+      "type": "stdio",
+      "command": "uv",
+      "args": ["run", "--frozen", "telegram_knowledge.py", "serve"],
+      "cwd": "./"
+    }
+  },
+  "interface": {
+    "displayName": "Telegram Dev",
+    "shortDescription": "Telegram development knowledge",
+    "longDescription": "Develop Telegram bots, Mini Apps, clients and integrations using public official documentation. Telegram Dev helps identify the API surface, verify feature eligibility, inspect release changes and read current documentation before implementation. The bundled local MCP maintains a documentation cache; uv is required. This independent community project is maintained by Kay0k1 and is not affiliated with Telegram. It does not connect to Telegram accounts or operate on private chats.",
+    "developerName": "Kay0k1",
+    "category": "Developer Tools",
+    "capabilities": ["Search Telegram documentation", "Read official sources", "Check documentation freshness"],
+    "websiteURL": "https://github.com/Kay0k1/telegram-dev",
+    "supportURL": "https://github.com/Kay0k1/telegram-dev/issues",
+    "privacyPolicyURL": "https://github.com/Kay0k1/telegram-dev/blob/main/docs/privacy.md",
+    "termsOfServiceURL": "https://github.com/Kay0k1/telegram-dev/blob/main/docs/terms.md",
+    "defaultPrompt": ["Implement a Telegram feature using the current official API documentation.", "Verify how colored Telegram buttons and custom emoji work.", "Check Telegram release changes that affect this project."],
+    "brandColor": "#1678C8",
+    "brandColorDark": "#58BAFF",
+    "composerIcon": "./assets/icon.svg",
+    "composerIconDark": "./assets/icon-dark.svg",
+    "logo": "./assets/logo.svg",
+    "logoDark": "./assets/logo-dark.svg"
+  },
+  "extensions": {
+    "com.openai": {
+      "publication": {
+        "translations": {
+          "ru-RU": {
+            "subtitle": "Знания для разработки Telegram",
+            "description": "Разрабатывайте ботов, Mini Apps, клиенты и интеграции Telegram по официальной публичной документации. Telegram Dev помогает выбрать API, проверить ограничения функции и изучить изменения релизов. Независимый проект Kay0k1; не связан с Telegram. Локальный MCP хранит кэш документации и требует uv. Доступа к аккаунтам и личным чатам Telegram нет."
+          }
+        }
+      }
+    }
+  }
+}

telegram_dev-0.4.0/.cursor-plugin/plugin.json

@@ -0,0 +1,13 @@
+{
+  "name": "telegram-dev",
+  "version": "0.4.0",
+  "description": "Source-verified Telegram development: Bot API, Mini Apps, MTProto, TDLib, media and public releases",
+  "author": {"name": "Kay0k1"},
+  "license": "MIT",
+  "repository": "https://github.com/Kay0k1/telegram-dev",
+  "homepage": "https://github.com/Kay0k1/telegram-dev",
+  "keywords": ["telegram", "bot-api", "mini-apps", "mtproto", "tdlib", "documentation"],
+  "logo": "assets/logo.svg",
+  "skills": "./skills/",
+  "mcpServers": "./.mcp.json"
+}

telegram_dev-0.4.0/.dockerignore

@@ -0,0 +1,9 @@
+.git
+.venv
+__pycache__
+*.sqlite3*
+*.zip
+dist
+build
+.source-monitor
+.env

telegram_dev-0.4.0/.mcp.json

@@ -0,0 +1,9 @@
+{
+  "mcpServers": {
+    "telegram-knowledge": {
+      "type": "stdio",
+      "command": "uv",
+      "args": ["run", "--frozen", "--directory", "${CLAUDE_PLUGIN_ROOT}", "telegram_knowledge.py", "serve"]
+    }
+  }
+}

telegram_dev-0.4.0/AGENTS.md

@@ -0,0 +1,20 @@
+# Telegram Dev — notes for coding agents
+
+MCP server + agent skill that give Claude Code, Codex and Cursor current official Telegram documentation. `CLAUDE.md` is a symlink to this file.
+
+## Layout
+
+- `telegram_knowledge.py` — the whole server and CLI: crawler, SQLite FTS5 cache, freshness policy, MCP tools (`serve`, `search`, `status`, `sync`, `maintain`; `install` is dispatched to the installer).
+- `telegram_dev_install.py` — project installer. From a checkout it points the agent at the checkout's Python; from the package it writes a pinned `uvx --from <spec> telegram-dev serve` launcher (spec detected from `direct_url.json`).
+- `skills/telegram-dev/` — the skill; shipped in the wheel as the `telegram_dev_skill` package (see `[tool.setuptools]` in `pyproject.toml`).
+- `.claude-plugin/`, `.codex-plugin/`, `.cursor-plugin/`, `.agents/plugins/` — native plugin manifests and catalogs. `server.json` — MCP Registry entry.
+- `scripts/check_sources.py` — daily source monitor (`.github/workflows/documentation.yml`, results on the `docs-status` branch). `scripts/package_openai.py` — OpenAI submission ZIPs.
+- `docs/` — runtime settings, deployment, validation record, catalog submission steps.
+
+## Rules
+
+- Run `uv run --frozen python -m unittest discover -s tests -v` before committing. Add a regression test for logic changes.
+- A release bumps the version in `pyproject.toml`, all plugin manifests, `server.json` and `CHANGELOG.md` together (`VersionTests` enforces it), then `uv lock`. Tag `vX.Y.Z` triggers `.github/workflows/release.yml`.
+- `README.md` is English, `README.ru.md` Russian; keep them in sync. Keep the `mcp-name:` comment in `README.md`.
+- The server only reads public documentation. Never add Telegram account access, message sending or bundled copies of Telegram docs.
+- Conventional commits.

telegram_dev-0.4.0/CHANGELOG.md

@@ -0,0 +1,40 @@
+# Changelog
+
+All notable changes to this project. Versions follow [Semantic Versioning](https://semver.org/).
+
+## [0.4.0] - 2026-11-10
+
+### Added
+
+- `telegram-dev install --agent claude|codex|cursor` installs the MCP server and the skill into a project with one command: `uvx telegram-dev install --agent claude`. The skill now ships inside the Python package.
+- Installs from the package pin the server to the installed version (or exact git commit) through `uvx`, so no checkout has to stay on disk. Installs from a checkout keep using the checkout's Python.
+- `--from` overrides the package the server is launched from; `--project` defaults to the current directory and refuses the home directory.
+- `telegram-dev --version`; the MCP server reports the package version and project URL.
+- `server.json` for the official MCP Registry.
+- Release workflow: a tag builds, tests and publishes the GitHub release with the wheel, sdist, source ZIP, skill-only ZIP and checksums. PyPI and MCP Registry publishing are opt-in through repository variables.
+- `CHANGELOG.md`.
+
+### Changed
+
+- The Python distribution is named `telegram-dev` (was `telegram-dev-knowledge`).
+- `README.md` is in English and starts with a real agent run; the Russian guide is in `README.ru.md`.
+- `scripts/install.py` is a thin wrapper around `telegram_dev_install.py` and keeps working for existing checkouts.
+
+## [0.3.0] - 2026-10-10
+
+### Added
+
+- Reference guides for bots, Mini Apps, MTProto/TDLib, calls, Secret Chats, business, payments, groups, channels and media.
+- Freshness checks on read and search, a background refresh cycle and a daily public monitor of 52 official sources.
+- `--update` for installed skills, refusing to overwrite local edits.
+- Custom Codex and Claude Code plugin catalogs, Streamable HTTP transport and a container deployment.
+
+## [0.2.0] - 2026-09-24
+
+### Added
+
+- First public release: documentation MCP server with an on-demand local cache, agent skill, project installer for Codex, Claude Code and Cursor, and a Claude Code plugin catalog.
+
+[0.4.0]: https://github.com/Kay0k1/telegram-dev/compare/v0.3.0...v0.4.0
+[0.3.0]: https://github.com/Kay0k1/telegram-dev/compare/v0.2.0...v0.3.0
+[0.2.0]: https://github.com/Kay0k1/telegram-dev/releases/tag/v0.2.0

telegram_dev-0.4.0/Dockerfile

@@ -0,0 +1,13 @@
+FROM ghcr.io/astral-sh/uv:0.11.6 AS uv
+FROM python:3.12-slim
+COPY --from=uv /uv /usr/local/bin/uv
+WORKDIR /app
+COPY pyproject.toml uv.lock ./
+RUN uv sync --frozen --no-install-project --no-dev
+COPY telegram_knowledge.py ./
+RUN groupadd --gid 10001 telegram && useradd --uid 10001 --gid telegram --create-home telegram && mkdir /data && chown telegram:telegram /data
+ENV TELEGRAM_KNOWLEDGE_DB=/data/corpus.sqlite3
+USER telegram
+EXPOSE 8000
+HEALTHCHECK --interval=30s --timeout=5s --start-period=15s CMD ["/app/.venv/bin/python", "-c", "import urllib.request; urllib.request.urlopen('http://127.0.0.1:8000/healthz', timeout=3)"]
+CMD ["/app/.venv/bin/python", "telegram_knowledge.py", "serve", "--transport", "streamable-http", "--host", "0.0.0.0", "--port", "8000"]

telegram_dev-0.4.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Telegram Dev contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

telegram_dev-0.4.0/MANIFEST.in

@@ -0,0 +1,12 @@
+include README.ru.md CHANGELOG.md AGENTS.md server.json uv.lock .mcp.json
+include Dockerfile .dockerignore
+recursive-include docs *.md
+recursive-include deploy *.yml Caddyfile .env.example .gitkeep
+recursive-include assets *.svg
+recursive-include scripts *.py
+recursive-include skills *.md *.yaml
+recursive-include tests *.py *.json
+recursive-include .claude-plugin *.json
+recursive-include .codex-plugin *.json
+recursive-include .cursor-plugin *.json
+recursive-include .agents *.json

telegram_dev-0.4.0/NOTICE

@@ -0,0 +1,6 @@
+Telegram Dev is an independent community project, not an official Telegram product.
+The MIT license applies to this project's original code and authored instructions.
+Retrieved Telegram documentation, third-party source code, names and trademarks
+retain their original ownership and applicable terms. The public source package
+does not redistribute the previously downloaded documentation database. Each
+installation retrieves public sources directly and retains source URLs.

telegram_dev-0.4.0/PKG-INFO

@@ -0,0 +1,190 @@
+Metadata-Version: 2.4
+Name: telegram-dev
+Version: 0.4.0
+Summary: Source-grounded Telegram development skills and documentation MCP
+License-Expression: MIT
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+License-File: NOTICE
+Requires-Dist: mcp<2,>=1.30
+Requires-Dist: httpx<1,>=0.28
+Requires-Dist: beautifulsoup4<5,>=4.13
+Requires-Dist: markdownify<2,>=1
+Requires-Dist: platformdirs<5,>=4
+Requires-Dist: tomlkit<1,>=0.13
+Dynamic: license-file
+
+# Telegram Dev
+
+[![Tests](https://github.com/Kay0k1/telegram-dev/actions/workflows/tests.yml/badge.svg)](https://github.com/Kay0k1/telegram-dev/actions/workflows/tests.yml)
+[![PyPI](https://img.shields.io/pypi/v/telegram-dev)](https://pypi.org/project/telegram-dev/)
+[![Docs monitor](https://github.com/Kay0k1/telegram-dev/actions/workflows/documentation.yml/badge.svg)](https://github.com/Kay0k1/telegram-dev/tree/docs-status)
+[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](LICENSE)
+
+**Current official Telegram documentation for Claude Code, Codex and Cursor.**
+
+Telegram Dev is an MCP server plus an agent skill. The server fetches, indexes and searches the official docs (Bot API, Mini Apps, MTProto, TDLib, changelogs) and keeps them fresh. The skill teaches the agent to pick the right API, check eligibility and library support, and cite what it read.
+
+[Русская версия](README.ru.md)
+
+<!-- mcp-name: io.github.Kay0k1/telegram-dev -->
+
+## Why
+
+Telegram ships a new Bot API version every month or two. A model's knowledge of it stops at its training cutoff, so agents confidently write code against fields that changed or never existed. They also mix up the Bot API, MTProto and TDLib, which have very different capabilities.
+
+With Telegram Dev the agent reads the current page before it writes code. A real Codex CLI run in a fresh project after `uvx telegram-dev install --agent codex` (tool calls trimmed):
+
+```text
+> Use the telegram-dev skill. In a python-telegram-bot project, I want the inline
+  'Delete' button to be red and show a custom emoji. Which Bot API fields do this,
+  what are the requirements, and what does the request JSON look like?
+
+  telegram_corpus_status {}
+  search_telegram_docs {"query": "style icon_custom_emoji_id", "area": "releases"}
+  search_telegram_docs {"query": "InlineKeyboardButton icon_custom_emoji_id style", "area": "bot-api"}
+  get_telegram_document {"url": "https://core.telegram.org/bots/api", "offset": 167594, "length": 10500}
+  get_telegram_document {"url": "https://core.telegram.org/bots/api-changelog", "offset": 39089, "length": 6000}
+
+Use these InlineKeyboardButton fields:
+- style: "danger" makes the button red.
+- icon_custom_emoji_id is a custom emoji ID shown before "Delete".
+- callback_data is your action identifier, 1-64 bytes.
+
+The custom emoji requires either a bot that bought additional usernames on Fragment,
+or a Premium bot owner with the message sent by the bot to a private chat, group or
+supergroup. PTB 22.7+ supports both fields. Older Telegram clients show the button
+unstyled. Source: https://core.telegram.org/bots/api#inlinekeyboardbutton
+
+{"chat_id": 123456789, "text": "Choose an action:",
+ "reply_markup": {"inline_keyboard": [[{"text": "Delete", "callback_data": "delete:42",
+   "style": "danger", "icon_custom_emoji_id": "YOUR_CUSTOM_EMOJI_ID"}]]}}
+```
+
+## Install
+
+You need [uv](https://docs.astral.sh/uv/getting-started/installation/). No bot token, Telegram account or API key is needed: the server only reads public documentation.
+
+### MCP server and skill, one command
+
+Run this in your project directory:
+
+```sh
+uvx telegram-dev install --agent claude    # or: codex, cursor
+```
+
+| `--agent` | MCP server is added to | Skill is copied to |
+| --- | --- | --- |
+| `claude` | `.mcp.json` | `.claude/skills/telegram-dev` |
+| `codex` | `.codex/config.toml` | `.agents/skills/telegram-dev` |
+| `cursor` | `.cursor/mcp.json` | `.cursor/skills/telegram-dev` |
+
+The installer keeps your other settings, backs up the files it changes and never overwrites an existing Telegram Dev setup. The server is pinned to the installed version, so nothing has to stay on disk besides the uv cache. Open a new agent session afterwards and approve the project MCP server when asked. Codex loads project settings only after you trust the project directory.
+
+To upgrade later: `uvx telegram-dev@latest install --agent claude --update`.
+
+### Claude Code plugin
+
+```text
+/plugin marketplace add Kay0k1/telegram-dev
+/plugin install telegram-dev@telegram-dev-tools
+```
+
+This adds the skill and the MCP server for all your projects. Use either the plugin or the installer, not both.
+
+### MCP server only
+
+```sh
+claude mcp add --scope user telegram-knowledge -- uvx telegram-dev serve
+```
+
+```sh
+codex mcp add telegram-knowledge -- uvx telegram-dev serve
+```
+
+Cursor: [![Add to Cursor](https://cursor.com/deeplink/mcp-install-dark.svg)](https://cursor.com/en/install-mcp?name=telegram-knowledge&config=eyJjb21tYW5kIjoidXZ4IiwiYXJncyI6WyJ0ZWxlZ3JhbS1kZXYiLCJzZXJ2ZSJdfQ%3D%3D)
+
+Any other MCP client:
+
+```json
+{
+  "mcpServers": {
+    "telegram-knowledge": { "command": "uvx", "args": ["telegram-dev", "serve"] }
+  }
+}
+```
+
+The tools work without the skill, but the skill is what makes an agent use them consistently.
+
+## Tools
+
+| Tool | What it does |
+| --- | --- |
+| `search_telegram_docs` | Full-text search over indexed sections, optionally limited to one area: `bot-api`, `mini-apps`, `telegram-api`, `tdlib`, `releases` and others |
+| `get_telegram_document` | Reads an official page in pages of up to 40,000 characters; fetches it if it is missing or older than 6 hours |
+| `telegram_corpus_status` | What is indexed, how fresh it is and which sources failed |
+| `telegram_document_history` | Revisions of a page captured by this installation |
+| `telegram_sources` | The 52 official entry points, grouped by API area |
+
+The cache starts empty. Pages are fetched the first time the agent reads them and indexed right away. To pre-fetch everything reachable from the configured sources:
+
+```sh
+uvx telegram-dev sync --max-pages 0
+uvx telegram-dev search "sendVideoNote"
+uvx telegram-dev status
+```
+
+## What the skill covers
+
+| Area | What the agent checks |
+| --- | --- |
+| Bot API | Messages, keyboards, updates, webhooks, files, permissions |
+| Formatting and emoji | Entities, UTF-16 offsets, custom emoji and who may use them |
+| Media and stickers | Voice messages, video notes, sticker sets, file limits |
+| Mini Apps | JS bridge, launch parameters, themes, server-side `initData` validation |
+| MTProto and TDLib | User vs bot authorization, schema and layers, TDLib versions |
+| Business and payments | Business connections, Stars, subscriptions, gifts, paid media |
+| Groups and channels | Admin rights, forums and topics, moderation |
+| Releases | Bot API changelog, API layers, TDLib changelog, official announcements |
+
+The skill lives in [skills/telegram-dev](skills/telegram-dev/SKILL.md), with one reference file per area.
+
+## How fresh the docs are
+
+- Reading a page older than 6 hours re-fetches it. Search re-fetches up to six stale matching pages.
+- While the server runs, a background cycle checks up to 120 pages every 6 hours: entry points, newly found links, oldest pages.
+- If Telegram's site is unreachable, the cached text is kept and marked stale with the error, so the agent knows it is reading an old copy.
+- A daily GitHub Action checks all 52 official sources and publishes hashes and errors on the [`docs-status`](https://github.com/Kay0k1/telegram-dev/tree/docs-status) branch.
+
+Settings such as the cache path (`TELEGRAM_KNOWLEDGE_DB`) and refresh intervals are in [docs/runtime.md](docs/runtime.md).
+
+## Self-hosting
+
+The server also runs over Streamable HTTP, so a team can share one cache. A Dockerfile and a Caddy setup with HTTPS are included: [docs/deployment.md](docs/deployment.md).
+
+```sh
+uvx telegram-dev serve --transport streamable-http --port 8000
+```
+
+## Limits
+
+- Search is local full-text search (SQLite FTS5), not semantic search. Exact method names and English terms work best. A small set of Russian aliases is built in.
+- Coverage is what can be reached from the 52 official entry points. Page history starts when your installation first fetched the page.
+- The server does not log in to Telegram, send messages or touch chats. It only reads public pages.
+- The skill improves how agents work. It does not guarantee a correct answer: check the code against Telegram before shipping.
+
+## Development
+
+```sh
+git clone https://github.com/Kay0k1/telegram-dev && cd telegram-dev
+uv sync --frozen
+uv run --frozen python -m unittest discover -s tests -v
+uv run --frozen telegram-dev install --agent claude --project /path/to/test-project
+```
+
+CI runs the tests on Linux, macOS and Windows and checks the Docker image. [docs/validation.md](docs/validation.md) lists what has been verified by hand and what has not. Issues and pull requests are welcome; [tests/behavioral-cases.json](tests/behavioral-cases.json) has agent scenarios that still need runs in each client.
+
+## License
+
+[MIT](LICENSE) for the code and the skill. Fetched Telegram documentation remains Telegram's; the package does not bundle it ([NOTICE](NOTICE)). This is an independent project, not affiliated with Telegram.

telegram_dev-0.4.0/README.md

@@ -0,0 +1,173 @@
+# Telegram Dev
+
+[![Tests](https://github.com/Kay0k1/telegram-dev/actions/workflows/tests.yml/badge.svg)](https://github.com/Kay0k1/telegram-dev/actions/workflows/tests.yml)
+[![PyPI](https://img.shields.io/pypi/v/telegram-dev)](https://pypi.org/project/telegram-dev/)
+[![Docs monitor](https://github.com/Kay0k1/telegram-dev/actions/workflows/documentation.yml/badge.svg)](https://github.com/Kay0k1/telegram-dev/tree/docs-status)
+[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](LICENSE)
+
+**Current official Telegram documentation for Claude Code, Codex and Cursor.**
+
+Telegram Dev is an MCP server plus an agent skill. The server fetches, indexes and searches the official docs (Bot API, Mini Apps, MTProto, TDLib, changelogs) and keeps them fresh. The skill teaches the agent to pick the right API, check eligibility and library support, and cite what it read.
+
+[Русская версия](README.ru.md)
+
+<!-- mcp-name: io.github.Kay0k1/telegram-dev -->
+
+## Why
+
+Telegram ships a new Bot API version every month or two. A model's knowledge of it stops at its training cutoff, so agents confidently write code against fields that changed or never existed. They also mix up the Bot API, MTProto and TDLib, which have very different capabilities.
+
+With Telegram Dev the agent reads the current page before it writes code. A real Codex CLI run in a fresh project after `uvx telegram-dev install --agent codex` (tool calls trimmed):
+
+```text
+> Use the telegram-dev skill. In a python-telegram-bot project, I want the inline
+  'Delete' button to be red and show a custom emoji. Which Bot API fields do this,
+  what are the requirements, and what does the request JSON look like?
+
+  telegram_corpus_status {}
+  search_telegram_docs {"query": "style icon_custom_emoji_id", "area": "releases"}
+  search_telegram_docs {"query": "InlineKeyboardButton icon_custom_emoji_id style", "area": "bot-api"}
+  get_telegram_document {"url": "https://core.telegram.org/bots/api", "offset": 167594, "length": 10500}
+  get_telegram_document {"url": "https://core.telegram.org/bots/api-changelog", "offset": 39089, "length": 6000}
+
+Use these InlineKeyboardButton fields:
+- style: "danger" makes the button red.
+- icon_custom_emoji_id is a custom emoji ID shown before "Delete".
+- callback_data is your action identifier, 1-64 bytes.
+
+The custom emoji requires either a bot that bought additional usernames on Fragment,
+or a Premium bot owner with the message sent by the bot to a private chat, group or
+supergroup. PTB 22.7+ supports both fields. Older Telegram clients show the button
+unstyled. Source: https://core.telegram.org/bots/api#inlinekeyboardbutton
+
+{"chat_id": 123456789, "text": "Choose an action:",
+ "reply_markup": {"inline_keyboard": [[{"text": "Delete", "callback_data": "delete:42",
+   "style": "danger", "icon_custom_emoji_id": "YOUR_CUSTOM_EMOJI_ID"}]]}}
+```
+
+## Install
+
+You need [uv](https://docs.astral.sh/uv/getting-started/installation/). No bot token, Telegram account or API key is needed: the server only reads public documentation.
+
+### MCP server and skill, one command
+
+Run this in your project directory:
+
+```sh
+uvx telegram-dev install --agent claude    # or: codex, cursor
+```
+
+| `--agent` | MCP server is added to | Skill is copied to |
+| --- | --- | --- |
+| `claude` | `.mcp.json` | `.claude/skills/telegram-dev` |
+| `codex` | `.codex/config.toml` | `.agents/skills/telegram-dev` |
+| `cursor` | `.cursor/mcp.json` | `.cursor/skills/telegram-dev` |
+
+The installer keeps your other settings, backs up the files it changes and never overwrites an existing Telegram Dev setup. The server is pinned to the installed version, so nothing has to stay on disk besides the uv cache. Open a new agent session afterwards and approve the project MCP server when asked. Codex loads project settings only after you trust the project directory.
+
+To upgrade later: `uvx telegram-dev@latest install --agent claude --update`.
+
+### Claude Code plugin
+
+```text
+/plugin marketplace add Kay0k1/telegram-dev
+/plugin install telegram-dev@telegram-dev-tools
+```
+
+This adds the skill and the MCP server for all your projects. Use either the plugin or the installer, not both.
+
+### MCP server only
+
+```sh
+claude mcp add --scope user telegram-knowledge -- uvx telegram-dev serve
+```
+
+```sh
+codex mcp add telegram-knowledge -- uvx telegram-dev serve
+```
+
+Cursor: [![Add to Cursor](https://cursor.com/deeplink/mcp-install-dark.svg)](https://cursor.com/en/install-mcp?name=telegram-knowledge&config=eyJjb21tYW5kIjoidXZ4IiwiYXJncyI6WyJ0ZWxlZ3JhbS1kZXYiLCJzZXJ2ZSJdfQ%3D%3D)
+
+Any other MCP client:
+
+```json
+{
+  "mcpServers": {
+    "telegram-knowledge": { "command": "uvx", "args": ["telegram-dev", "serve"] }
+  }
+}
+```
+
+The tools work without the skill, but the skill is what makes an agent use them consistently.
+
+## Tools
+
+| Tool | What it does |
+| --- | --- |
+| `search_telegram_docs` | Full-text search over indexed sections, optionally limited to one area: `bot-api`, `mini-apps`, `telegram-api`, `tdlib`, `releases` and others |
+| `get_telegram_document` | Reads an official page in pages of up to 40,000 characters; fetches it if it is missing or older than 6 hours |
+| `telegram_corpus_status` | What is indexed, how fresh it is and which sources failed |
+| `telegram_document_history` | Revisions of a page captured by this installation |
+| `telegram_sources` | The 52 official entry points, grouped by API area |
+
+The cache starts empty. Pages are fetched the first time the agent reads them and indexed right away. To pre-fetch everything reachable from the configured sources:
+
+```sh
+uvx telegram-dev sync --max-pages 0
+uvx telegram-dev search "sendVideoNote"
+uvx telegram-dev status
+```
+
+## What the skill covers
+
+| Area | What the agent checks |
+| --- | --- |
+| Bot API | Messages, keyboards, updates, webhooks, files, permissions |
+| Formatting and emoji | Entities, UTF-16 offsets, custom emoji and who may use them |
+| Media and stickers | Voice messages, video notes, sticker sets, file limits |
+| Mini Apps | JS bridge, launch parameters, themes, server-side `initData` validation |
+| MTProto and TDLib | User vs bot authorization, schema and layers, TDLib versions |
+| Business and payments | Business connections, Stars, subscriptions, gifts, paid media |
+| Groups and channels | Admin rights, forums and topics, moderation |
+| Releases | Bot API changelog, API layers, TDLib changelog, official announcements |
+
+The skill lives in [skills/telegram-dev](skills/telegram-dev/SKILL.md), with one reference file per area.
+
+## How fresh the docs are
+
+- Reading a page older than 6 hours re-fetches it. Search re-fetches up to six stale matching pages.
+- While the server runs, a background cycle checks up to 120 pages every 6 hours: entry points, newly found links, oldest pages.
+- If Telegram's site is unreachable, the cached text is kept and marked stale with the error, so the agent knows it is reading an old copy.
+- A daily GitHub Action checks all 52 official sources and publishes hashes and errors on the [`docs-status`](https://github.com/Kay0k1/telegram-dev/tree/docs-status) branch.
+
+Settings such as the cache path (`TELEGRAM_KNOWLEDGE_DB`) and refresh intervals are in [docs/runtime.md](docs/runtime.md).
+
+## Self-hosting
+
+The server also runs over Streamable HTTP, so a team can share one cache. A Dockerfile and a Caddy setup with HTTPS are included: [docs/deployment.md](docs/deployment.md).
+
+```sh
+uvx telegram-dev serve --transport streamable-http --port 8000
+```
+
+## Limits
+
+- Search is local full-text search (SQLite FTS5), not semantic search. Exact method names and English terms work best. A small set of Russian aliases is built in.
+- Coverage is what can be reached from the 52 official entry points. Page history starts when your installation first fetched the page.
+- The server does not log in to Telegram, send messages or touch chats. It only reads public pages.
+- The skill improves how agents work. It does not guarantee a correct answer: check the code against Telegram before shipping.
+
+## Development
+
+```sh
+git clone https://github.com/Kay0k1/telegram-dev && cd telegram-dev
+uv sync --frozen
+uv run --frozen python -m unittest discover -s tests -v
+uv run --frozen telegram-dev install --agent claude --project /path/to/test-project
+```
+
+CI runs the tests on Linux, macOS and Windows and checks the Docker image. [docs/validation.md](docs/validation.md) lists what has been verified by hand and what has not. Issues and pull requests are welcome; [tests/behavioral-cases.json](tests/behavioral-cases.json) has agent scenarios that still need runs in each client.
+
+## License
+
+[MIT](LICENSE) for the code and the skill. Fetched Telegram documentation remains Telegram's; the package does not bundle it ([NOTICE](NOTICE)). This is an independent project, not affiliated with Telegram.