Skip to main content

Telegram Bot API Docs MCP

FastMCP server that gives AI clients access to the current Telegram Bot API documentation. The server scrapes the official docs on startup, validates the method/type graph, and serves the result through MCP tools and JSON resources.

Run

Run the published package over stdio, which is the usual transport for local AI client bindings:

uvx telegram-bot-api-docs-mcp

Or run as an HTTP MCP server:

uvx telegram-bot-api-docs-mcp --transport http --host 127.0.0.1 --port 8080

Startup requires internet access because the server fetches https://core.telegram.org/bots/api every time it starts.

For local development from a checkout, use uv run python main.py with the same arguments.

Codex

This repo includes a project-scoped Codex config at .codex/config.toml:

[mcp_servers.telegram_bot_api_docs]
command = "uv"
args = ["run", "python", "main.py"]
cwd = ".."
enabled = true
startup_timeout_sec = 60
tool_timeout_sec = 120

Start a new Codex session from this trusted repo and run /mcp to confirm that telegram_bot_api_docs is connected.

Tools

  • get_bot_api_overview: version, release date, changelog URL, and counts.
  • list_methods / list_types: paginated method/type discovery with optional search.
  • get_method / get_type: full docs for a method or type.
  • get_field: docs for a specific method parameter or type field.
  • search_bot_api: search names, descriptions, fields, return types, and relationships.
  • get_related_types: subtype and usage graph for a type.
  • dump_bot_api_spec: raw full spec or a single section.

Resources

  • telegram-bot-api://overview
  • telegram-bot-api://methods
  • telegram-bot-api://types
  • telegram-bot-api://spec

Scraper

scrape.py contains the parser and schema validation used by the MCP server. Running it directly still writes api.json and api.min.json, but those files are ignored because the MCP server serves freshly scraped data.

Metadata

Release files for telegram-bot-api-docs-mcp 0.1.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for telegram-bot-api-docs-mcp 0.1.0
File Size Uploaded Provenance Actions
telegram_bot_api_docs_mcp-0.1.0.tar.gz 10.9 kB Without provenance Details for telegram_bot_api_docs_mcp-0.1.0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for telegram-bot-api-docs-mcp 0.1.0
File Interpreter ABI Platform Actions
telegram_bot_api_docs_mcp-0.1.0-py3-none-any.whl Python 3 none any Details for telegram_bot_api_docs_mcp-0.1.0-py3-none-any.whl

Total release size: 22.0 kB

Release files / telegram_bot_api_docs_mcp-0.1.0.tar.gz

Download URL telegram_bot_api_docs_mcp-0.1.0.tar.gz
Size 10.9 kB
Tags Source
SHA-256 checksum
How to use checksums
67bff8825e0df50637ce2dd3d74c1ded6f2796c6ab7e06d6b804538073b421bd
BLAKE2b-256 checksum
How to use checksums
6c1a561342251dc27ef15bb924ff12a4dad5e527b6982d97a7763370e503d449
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via uv/0.11.14 {"installer":{"name":"uv","version":"0.11.14","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"macOS","version":null,"id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

Release files / telegram_bot_api_docs_mcp-0.1.0-py3-none-any.whl

Download URL telegram_bot_api_docs_mcp-0.1.0-py3-none-any.whl
Size 11.1 kB
Tags Python 3
SHA-256 checksum
How to use checksums
f80dbca4aac5b38759836955562daeaf8fa0470386267d2821ed264de9ce015c
BLAKE2b-256 checksum
How to use checksums
e4a4711894bf84065eca7e0d1e31718a48964ea8c5a077c94774cae0560d3036
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via uv/0.11.14 {"installer":{"name":"uv","version":"0.11.14","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"macOS","version":null,"id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

Security for telegram-bot-api-docs-mcp 0.1.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

0.1.0 This release

2 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page