Skip to main content

A Telegram bot that implements Agent Client Protocol to interact with AI agents

Project description

Telegram ACP bot

CI docs Changelog Ruff License

A Telegram bot that implements the Agent Client Protocol to interact with AI agents.

Project documentation: https://mgaitan.github.io/telegram-acp-bot/

Status

This project is in alpha and under heavy active development.

Development has included extensive use of gpt-5.3-codex.

Quick Start

Run directly without installing via uvx:

uvx --from git+https://github.com/mgaitan/telegram-acp-bot acp-bot --help

Run the bot with a real ACP agent:

TELEGRAM_BOT_TOKEN=123456:abc \
ACP_AGENT_COMMAND="npx @zed-industries/codex-acp" \
uvx --from git+https://github.com/mgaitan/telegram-acp-bot acp-bot

Current interaction capabilities:

  • /new [workspace], /resume [N|workspace], /session, /cancel, /stop, /clear, /restart [N [workspace]]
  • Interactive permission prompts with inline buttons (Always, This time, Deny)
  • Plain text prompts
  • Tool activity updates are sent as separate messages per ACP tool kind
  • Image and document attachments from Telegram messages
  • ACP file:// resources are sent as attachments when they resolve to files inside the active workspace
  • Agent markdown output (with fallback to plain text when Telegram rejects entities)

Message flow:

  • The bot sends activity blocks while the prompt is running.
  • Common labels are 💡 Thinking, ⚙️ Tool call, 📖 Reading, ✏️ Editing, and 🔎 Searching.
  • Permission prompts for risky actions are sent as independent messages with inline buttons.
  • The final answer is sent as a separate message after activity blocks.
  • If the final text is empty, no dummy "(no text response)" message is sent.

For development, /restart stops polling and relaunches the process. If ACP_RESTART_COMMAND (or --restart-command) is configured, that command is used (recommended when running with uv run ... and extra flags). Otherwise, it falls back to re-execing the current process (sys.executable + sys.argv).

Telegram Bot Token

Create your token with @BotFather:

  1. Open BotFather and run /newbot.
  2. Choose a bot name and username.
  3. Copy the token returned by BotFather.

Store the token in your local .env file (gitignored):

At least one allowlist entry is required (TELEGRAM_ALLOWED_USER_IDS or TELEGRAM_ALLOWED_USERNAMES).

TELEGRAM_BOT_TOKEN=123456:abc
TELEGRAM_ALLOWED_USER_IDS=123456789
# TELEGRAM_ALLOWED_USERNAMES=alice,@bob
ACP_AGENT_COMMAND="npx @zed-industries/codex-acp"
ACP_RESTART_COMMAND="uv run acp-bot --telegram-token <TOKEN> --agent-command \"npx @zed-industries/codex-acp\""
ACP_PERMISSION_MODE=ask
ACP_PERMISSION_EVENT_OUTPUT=stdout
ACP_STDIO_LIMIT=8388608

Agent Command

Set ACP_AGENT_COMMAND to the ACP-compatible agent command you want the bot to run.

Example:

ACP_AGENT_COMMAND="npx @zed-industries/codex-acp"

To install the tool permanently:

uv tool install --from git+https://github.com/mgaitan/telegram-acp-bot acp-bot

Development

  • Install dependencies with uv sync.
  • Then run uv run acp-bot
  • New dependency releases are delayed by one week via uv cooldown ([tool.uv].exclude-newer = "1 week"), with per-package overrides when required (for example, ty).
  • Run the QA bundle with ty:
uv run ty check

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

telegram_acp_bot-0.1.0.tar.gz (28.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

telegram_acp_bot-0.1.0-py3-none-any.whl (34.0 kB view details)

Uploaded Python 3

File details

Details for the file telegram_acp_bot-0.1.0.tar.gz.

File metadata

  • Download URL: telegram_acp_bot-0.1.0.tar.gz
  • Upload date:
  • Size: 28.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for telegram_acp_bot-0.1.0.tar.gz
Algorithm Hash digest
SHA256 c27cc13384ca591ac591aa35ddfbbfbfc7724770bf2a80c18a658aee54841c26
MD5 768d66f9dd6ab79d9d6a89c4f650e9af
BLAKE2b-256 f139964f1ad05c24694b7a7bd88065a4866df1425db02cd08db8f5a32b59583f

See more details on using hashes here.

Provenance

The following attestation bundles were made for telegram_acp_bot-0.1.0.tar.gz:

Publisher: cd.yml on mgaitan/telegram-acp-bot

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file telegram_acp_bot-0.1.0-py3-none-any.whl.

File metadata

File hashes

Hashes for telegram_acp_bot-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 92f9d1958136af8ae3fc047d085a728d954c9227772104cfb949693b6867d8c4
MD5 ef503ecbc6ebaf01b715e33336b63756
BLAKE2b-256 7000106c54a621e27ab00bc5be34a193566ec5682623e190f1e1defd0229e662

See more details on using hashes here.

Provenance

The following attestation bundles were made for telegram_acp_bot-0.1.0-py3-none-any.whl:

Publisher: cd.yml on mgaitan/telegram-acp-bot

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page