README Documentation
Torrent Search MCP Server & API
This repository provides a Python API and an MCP (Model Context Protocol) server to find torrents programmatically on ThePirateBay, Nyaa, YggTorrent (now ygg.gratis) and La Cale. It allows for easy integration into other applications or services.
Quickstart
Table of Contents
Features
- API wrapper for ThePirateBay, Nyaa, YggTorrent (now ygg.gratis) and La Cale.
- MCP server interface for standardized communication (stdio, sse, streamable-http)
- FastAPI server interface for alternative HTTP access (e.g., for direct API calls or testing)
- Tools:
- Search for torrents across all available sources
- Get magnet link or torrent file for a specific torrent by id
Setup
Prerequisites
- Python 3.10+ (required for PyPI install).
uv(for local development)- Docker and Docker Compose (for Docker setup)
- Passkey for LaCale (Optional). Create your apikey on https://la-cale.space/settings/api-keys
Configuration (Optional)
This application requires credentials if you want to interact with La Cale.
- La Cale: Find your API key on the La Cale website.
- Set Environment Variables: The application reads configuration from environment variables. The recommended way to set them is by creating a
.envfile in your project's root directory. The application will load it automatically. See.env.examplefor all available options.
Installation
Choose one of the following installation methods.
Install from PyPI (Recommended)
This method is best for using the package as a library or running the server without modifying the code.
- Install the package from PyPI:
pip install torrent-search-mcp
crawl4ai-setup # For crawl4ai/playwright
playwright install --with-deps chromium # If previous command fails
- Create a
.envfile in the directory where you'll run the application and add your credentials (optional):
LA_CALE_API_KEY=your_api_key_here
- Run the MCP server (default: stdio):
python -m torrent_search
For Local Development
This method is for contributors who want to modify the source code.
Using uv:
- Clone the repository:
git clone https://github.com/philogicae/torrent-search-mcp.git
cd torrent-search-mcp
- Install dependencies using
uv:
uv sync --locked
uvx playwright install --with-deps chromium
- Create your configuration file by copying the example and add your credentials (optional):
cp .env.example .env
- Run the MCP server (default: stdio):
uv run -m torrent_search
For Docker
This method uses Docker to run the server in a container.
compose.yaml is configured to bypass DNS issues (using quad9 DNS).
- Clone the repository (if you haven't already):
git clone https://github.com/philogicae/torrent-search-mcp.git
cd torrent-search-mcp
- Create your configuration file by copying the example and modify it (optional):
cp .env.example .env
- Build and run the container using Docker Compose (default port: 8000):
docker compose up --build -d
- Access container logs:
docker logs torrent-search-mcp -f
Usage
As Python Wrapper
from torrent_search import torrent_search_api
results = torrent_search_api.search_torrents('...')
for torrent in results:
print(f"{torrent.filename} | {torrent.size} | {torrent.seeders} SE | {torrent.leechers} LE | {torrent.date} | {torrent.source}")
As MCP Server
from torrent_search import torrent_search_mcp
torrent_search_mcp.run(transport="sse")
As FastAPI Server
This project also includes a FastAPI server as an alternative way to interact with the library via a standard HTTP API. This can be useful for direct API calls, integration with other web services, or for testing purposes.
Running the FastAPI Server:
# With Python
python -m torrent_search --mode fastapi
# With uv
uv run -m torrent_search --mode fastapi
--host <host>: Default:0.0.0.0.--port <port>: Default:8000.--reload: Enables auto-reloading when code changes (useful for development).--workers <workers>: Default:1.
The FastAPI server will then be accessible at http://<host>:<port>
Available Endpoints: The FastAPI server exposes similar functionalities to the MCP server. Key endpoints include:
/: A simple health check endpoint. Returns{"status": "ok"}./torrent/search: Search for torrents (POST request withqueryand optionalmax_itemsparameters)./torrent/{torrent_id}: Get magnet link or torrent file for a specific torrent by id./docs: Interactive API documentation (Swagger UI)./redoc: Alternative API documentation (ReDoc).
Environment variables are configured the same way as for the MCP server (via an .env file in the project root).
Via MCP Clients
Usable with any MCP-compatible client. Available tools:
search_torrents: Search for torrents across all available sources (ThePirateBay, Nyaa, La Cale).get_torrent: Get the magnet link or torrent file for a specific torrent by id.
Available resources:
data://torrent_sources: Get the list of available torrent sources.
Example with Windsurf
Configuration:
{
"mcpServers": {
...
# with stdio (only requires uv)
"torrent-search-mcp": {
"command": "uvx",
"args": [ "torrent-search-mcp" ]
},
# with sse transport (requires installation)
"torrent-search-mcp": {
"serverUrl": "http://127.0.0.1:8000/sse"
},
# with streamable-http transport (requires installation)
"torrent-search-mcp": {
"serverUrl": "http://127.0.0.1:8000/mcp" # not yet supported by every client
},
...
}
}
Changelog
See CHANGELOG.md for a history of changes to this project.
Contributing
Contributions are welcome! Please open an issue or submit a pull request.
License
This project is licensed under the MIT License - see the LICENSE file for details.