mikl/telegram-mcp
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

docs: Update Python command naming to maintain consistency

Browse source
This commit is contained in:
anonim 2025-04-18 15:02:56 +03:00
parent 492dd15b42
commit 3faa4a006e
1 changed files with 11 additions and 23 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

34
README.md
View file

@ -145,7 +145,7 @@ cd telegram-mcp
### 2. Create a Virtual Environment ### 2. Create a Virtual Environment
```bash ```bash
python -m venv .venv python3 -m venv .venv
source .venv/bin/activate # On Windows: .venv\Scripts\activate source .venv/bin/activate # On Windows: .venv\Scripts\activate
pip install -r requirements.txt pip install -r requirements.txt
``` ```
@ -153,7 +153,7 @@ pip install -r requirements.txt
### 3. Generate a Session String ### 3. Generate a Session String
```bash ```bash
python session_string_generator.py python3 session_string_generator.py
``` ```
Follow the prompts to authenticate and update your `.env` file. Follow the prompts to authenticate and update your `.env` file.
@ -173,37 +173,25 @@ Get your API credentials at [my.telegram.org/apps](https://my.telegram.org/apps)
## ⚙️ Configuration for Claude & Cursor ## ⚙️ Configuration for Claude & Cursor
### Claude Desktop ### MCP Configuration
Edit your Claude config (e.g. `~/Library/Application Support/Claude/claude_desktop_config.json`): Edit your Claude desktop config (e.g. `~/Library/Application Support/Claude/claude_desktop_config.json`) or Cursor config (`~/.cursor/mcp.json`):
```json ```json
{ {
"mcpServers": { "mcpServers": {
"telegram-mcp": { "telegram-mcp": {
"command": "/full/path/to/.venv/bin/python", "command": "uv",
"args": ["main.py"], "args": [
"cwd": "/full/path/to/telegram-mcp-server" "--directory",
"/full/path/to/telegram-mcp-server",
"run",
"main.py"
]
} }
} }
} }
``` ```
### Cursor
Edit `~/.cursor/mcp.json`:
```json
{
"mcpServers": {
"telegram-mcp": {
"command": "/full/path/to/.venv/bin/python",
"args": ["main.py"],
"cwd": "/full/path/to/telegram-mcp-server"
}
}
}
```
## 📝 Tool Examples with Code & Output ## 📝 Tool Examples with Code & Output
Below are examples of the most commonly used tools with their implementation and sample output. Below are examples of the most commonly used tools with their implementation and sample output.