fix: correct README inconsistencies and add TORRENTCLAW_ALLOW_PRIVATE

- Rename get_torrent_download_url → get_torrent_url in README tools table
- Add TORRENTCLAW_ALLOW_PRIVATE env var to bypass SSRF checks for
  self-hosted setups (localhost, private IPs)
- Update self-hosted config example with TORRENTCLAW_ALLOW_PRIVATE=true
- Add Prompts section to README
- Add 3 tests for ALLOW_PRIVATE behavior (88 tests total)
This commit is contained in:
Deivid Soto 2026-02-09 17:46:24 +01:00
parent d471c9b695
commit e011c0f63e
3 changed files with 52 additions and 8 deletions

View file

@ -19,7 +19,7 @@ No API key required.
| `get_recent` | Get recently added content |
| `get_watch_providers` | Streaming availability by country (Netflix, Disney+, etc.) |
| `get_credits` | Cast and director for a title |
| `get_torrent_download_url` | Get .torrent file download URL from info hash |
| `get_torrent_url` | Get .torrent file download URL from info hash |
## Resources
@ -27,6 +27,15 @@ No API key required.
|-----|-------------|
| `torrentclaw://stats` | Catalog statistics (content/torrent counts by source) |
## Prompts
| Prompt | Description |
|--------|-------------|
| `search_movie` | Search for a movie by title and get torrents + streaming |
| `search_show` | Search for a TV show by title and get torrents |
| `whats_new` | Discover recently added movies and TV shows |
| `where_to_watch` | Find where to stream, rent, or buy a title |
## Configuration
### Claude Desktop
@ -70,7 +79,8 @@ Point to your own TorrentClaw instance:
"command": "npx",
"args": ["-y", "torrentclaw-mcp"],
"env": {
"TORRENTCLAW_API_URL": "http://localhost:3030"
"TORRENTCLAW_API_URL": "http://localhost:3030",
"TORRENTCLAW_ALLOW_PRIVATE": "true"
}
}
}
@ -82,6 +92,7 @@ Point to your own TorrentClaw instance:
| Variable | Default | Description |
|----------|---------|-------------|
| `TORRENTCLAW_API_URL` | `https://torrentclaw.com` | Base URL of the TorrentClaw API |
| `TORRENTCLAW_ALLOW_PRIVATE` | `false` | Set to `true` to allow private/localhost URLs (for self-hosted setups) |
## Development