{"_id":"@mseep/mcp-communicator-telegram","name":"@mseep/mcp-communicator-telegram","dist-tags":{"latest":"0.2.1"},"versions":{"0.2.1":{"name":"@mseep/mcp-communicator-telegram","version":"0.2.1","description":"MCP server for communicating with users through Telegram bots","main":"build/index.js","type":"commonjs","bin":{"mcptelegram":"build/index.js","mcptelegram-chatid":"build/get-chat-id.js"},"repository":{"type":"git","url":"git+https://github.com/qpd-v/mcp-communicator-telegram.git"},"bugs":{"url":"https://github.com/qpd-v/mcp-communicator-telegram/issues"},"homepage":"https://github.com/qpd-v/mcp-communicator-telegram#readme","scripts":{"build":"tsc","start":"node build/index.js","dev":"tsc && node build/index.js","watch":"tsc -w","clean":"rimraf build","test":"echo \"Error: no test specified\" && exit 1"},"keywords":["mcp","model-context-protocol","telegram","bot","communication","chat","messaging","ai","claude","mseep","mcp-server"],"author":{"name":"qpd-v"},"license":"ISC","dependencies":{"archiver":"^7.0.1","dotenv":"^16.3.1","ignore":"^7.0.3","node-telegram-bot-api":"^0.64.0"},"devDependencies":{"@types/archiver":"^6.0.3","@types/node":"^20.10.5","@types/node-telegram-bot-api":"^0.64.1","rimraf":"^5.0.5","typescript":"^5.3.3"},"publisher":"mseep","_id":"@mseep/mcp-communicator-telegram@0.2.1","gitHead":"0c90dc657ed20fc314bf1d538fae6599da2192b0","_nodeVersion":"18.20.8","_npmVersion":"10.8.2","dist":{"integrity":"sha512-MxeJ56GUXb/3/sEvruTpmooCRbucuwZ6sKBWH2AG7EmSCotvFX9wFnq5GfZL4cDHhGg268U26CWLcoxjezudCw==","shasum":"acf7cc45eeda44d0f70b775097d6451874209fa7","tarball":"https://registry.npmjs.org/@mseep/mcp-communicator-telegram/-/mcp-communicator-telegram-0.2.1.tgz","fileCount":5,"unpackedSize":30368,"signatures":[{"keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U","sig":"MEUCIQCmd9INq5PzGv67QoCrlXTCyN8gl9R2bzeQTcnHvwCHiwIgLVZycKQkxXwmmnac8VSr4/nhcgg4vcOlWbe+P998QEc="}]},"_npmUser":{"name":"skydeckai","email":"support@skydeck.ai"},"directories":{},"maintainers":[{"name":"skydeckai","email":"support@skydeck.ai"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages-npm-production","tmp":"tmp/mcp-communicator-telegram_0.2.1_1744790274694_0.7085613065749798"},"_hasShrinkwrap":false}},"time":{"created":"2025-04-16T07:57:54.623Z","0.2.1":"2025-04-16T07:57:54.881Z","modified":"2025-04-16T07:57:55.162Z"},"maintainers":[{"name":"skydeckai","email":"support@skydeck.ai"}],"description":"MCP server for communicating with users through Telegram bots","homepage":"https://github.com/qpd-v/mcp-communicator-telegram#readme","keywords":["mcp","model-context-protocol","telegram","bot","communication","chat","messaging","ai","claude","mseep","mcp-server"],"repository":{"type":"git","url":"git+https://github.com/qpd-v/mcp-communicator-telegram.git"},"author":{"name":"qpd-v"},"bugs":{"url":"https://github.com/qpd-v/mcp-communicator-telegram/issues"},"license":"ISC","readme":"# MCP Communicator (Telegram)\n\nAn MCP server that enables communication with users through Telegram. This server provides tools to interact with users via a Telegram bot, including asking questions, sending notifications, sharing files, and creating project archives.\n\n## Installation\n\n### Via npm (global)\n\n```bash\nnpm install -g mcp-communicator-telegram\n```\n\n### Via npx (on-demand)\n\n```bash\nnpx mcptelegram\n```\n\nTo get your Telegram chat ID:\n```bash\nnpx mcptelegram-chatid\n```\n\n## Features\n\n- Ask questions to users through Telegram\n- Send notifications to users (no response required)\n- Send files to users via Telegram\n- Create and send project zip files (respecting .gitignore)\n- Receive responses asynchronously (waits indefinitely for response)\n- Support for reply-based message tracking\n- Secure chat ID validation\n- Error handling and logging\n\n## Prerequisites\n\n- Node.js (v14 or higher)\n- A Telegram bot token (obtained from [@BotFather](https://t.me/botfather))\n- Your Telegram chat ID (can be obtained using the included utility)\n\n## Installation\n\n1. Clone the repository:\n```bash\ngit clone https://github.com/qpd-v/mcp-communicator-telegram.git\ncd mcp-communicator-telegram\n```\n\n2. Install dependencies:\n```bash\nnpm install\n```\n\n3. Create a Telegram bot:\n   - Open Telegram and search for [@BotFather](https://t.me/botfather)\n   - Send `/newbot` and follow the instructions\n   - Save the bot token you receive\n\n4. Get your chat ID:\n   - Copy `.env.example` to `.env`\n   - Add your bot token to the `.env` file:\n     ```\n     TELEGRAM_TOKEN=your_bot_token_here\n     ```\n   - Run the chat ID utility:\n     ```bash\n     npm run build\n     node build/get-chat-id.js\n     ```\n   - Send any message to your bot\n   - Copy the chat ID that appears in the console\n   - Add the chat ID to your `.env` file:\n     ```\n     TELEGRAM_TOKEN=your_bot_token_here\n     CHAT_ID=your_chat_id_here\n     ```\n\n## Configuration\n\nAdd the server to your MCP settings file (usually located at `%APPDATA%\\Code\\User\\globalStorage\\rooveterinaryinc.roo-cline\\settings\\cline_mcp_settings.json` on Windows):\n\n```json\n{\n  \"mcpServers\": {\n    \"mcp-communicator-telegram\": {\n      \"command\": \"node\",\n      \"args\": [\"path/to/mcp-communicator-telegram/build/index.js\"],\n      \"env\": {\n        \"TELEGRAM_TOKEN\": \"your_bot_token_here\",\n        \"CHAT_ID\": \"your_chat_id_here\"\n      }\n    }\n  }\n}\n```\n\n## Available Tools\n\n### ask_user\n\nAsks a question to the user via Telegram and waits for their response.\n\nInput Schema:\n```json\n{\n  \"type\": \"object\",\n  \"properties\": {\n    \"question\": {\n      \"type\": \"string\",\n      \"description\": \"The question to ask the user\"\n    }\n  },\n  \"required\": [\"question\"]\n}\n```\n\nExample usage:\n```typescript\nconst response = await use_mcp_tool({\n  server_name: \"mcp-communicator-telegram\",\n  tool_name: \"ask_user\",\n  arguments: {\n    question: \"What is your favorite color?\"\n  }\n});\n```\n\n### notify_user\n\nSends a notification message to the user via Telegram (no response required).\n\nInput Schema:\n```json\n{\n  \"type\": \"object\",\n  \"properties\": {\n    \"message\": {\n      \"type\": \"string\",\n      \"description\": \"The message to send to the user\"\n    }\n  },\n  \"required\": [\"message\"]\n}\n```\n\nExample usage:\n```typescript\nawait use_mcp_tool({\n  server_name: \"mcp-communicator-telegram\",\n  tool_name: \"notify_user\",\n  arguments: {\n    message: \"Task completed successfully!\"\n  }\n});\n```\n\n### send_file\n\nSends a file to the user via Telegram.\n\nInput Schema:\n```json\n{\n  \"type\": \"object\",\n  \"properties\": {\n    \"filePath\": {\n      \"type\": \"string\",\n      \"description\": \"The path to the file to send\"\n    }\n  },\n  \"required\": [\"filePath\"]\n}\n```\n\nExample usage:\n```typescript\nawait use_mcp_tool({\n  server_name: \"mcp-communicator-telegram\",\n  tool_name: \"send_file\",\n  arguments: {\n    filePath: \"path/to/file.txt\"\n  }\n});\n```\n\n### zip_project\n\nCreates a zip file of a project directory (respecting .gitignore patterns) and sends it to the user via Telegram.\n\nInput Schema:\n```json\n{\n  \"type\": \"object\",\n  \"properties\": {\n    \"directory\": {\n      \"type\": \"string\",\n      \"description\": \"Directory to zip (defaults to current working directory)\"\n    }\n  },\n  \"required\": []\n}\n```\n\nExample usage with default directory (current working directory):\n```typescript\nawait use_mcp_tool({\n  server_name: \"mcp-communicator-telegram\",\n  tool_name: \"zip_project\",\n  arguments: {}\n});\n```\n\nExample usage with specific directory:\n```typescript\nawait use_mcp_tool({\n  server_name: \"mcp-communicator-telegram\",\n  tool_name: \"zip_project\",\n  arguments: {\n    directory: \"/path/to/your/project\"\n  }\n});\n```\n\nFeatures:\n- Creates a zip file named `[project-name]-project.zip` based on the directory name\n- Can zip any specified directory or the current working directory\n- Respects .gitignore patterns\n- Maintains correct file paths in the archive\n- Automatically cleans up the zip file after sending\n- Handles files up to 2GB in size\n\n## Development\n\nBuild the project:\n```bash\nnpm run build\n```\n\nRun in development mode:\n```bash\nnpm run dev\n```\n\nWatch for changes:\n```bash\nnpm run watch\n```\n\nClean build directory:\n```bash\nnpm run clean\n```\n\n## Security\n\n- The server only responds to messages from the configured chat ID\n- Environment variables are used for sensitive configuration\n- Message IDs are used to track question/answer pairs\n- The bot ignores messages without proper context\n\n## License\n\nISC\n\n## Author\n\nqpd-v\n\n## Version\n\n0.2.1  # Major version bump for new features: notify_user, send_file, and zip_project tools","readmeFilename":"README.md","_rev":"1-fa32b09cc5dccb38f5575b9182287604"}