Read-only diagnostic MCP server for the arr media stack
Project description
Oraclarr
Ask your media stack what's going on, in plain language.
A locally-run, read-only MCP server that lets an LLM client (Claude Code, Claude Desktop) diagnose a self-hosted *arr media stack.
What it does
Oraclarr gives a language model one place to answer the operational "why" questions that normally mean tabbing through six web UIs. It aggregates across your services and returns a single, structured answer without changing anything (it is strictly read-only in this phase).
Covered now: Sonarr, Radarr, Prowlarr, qBittorrent, Tdarr, and Profilarr — including multiple instances of the same type (e.g. a separate anime or 4K Sonarr/Radarr). Every tool fans out across all the instances you define and reports each one separately.
In practice
Once registered, you just ask your MCP client. Oraclarr picks the right tool and answers:
| You ask… | Oraclarr runs | …and tells you |
|---|---|---|
| "Is anything in my stack down?" | stack_health |
which services are unreachable, unhealthy, or low on disk |
| "Why hasn't the new episode of X downloaded yet?" | diagnose |
where X is in the wanted → grab → download → import pipeline |
| "Why did a sub-only release get grabbed when I only allow English dubs?" | explain_decision |
the release that was grabbed, its custom-format score, and the language formats that matched |
| "Why does Profilarr keep upgrading stuff that already looks fine?" | explain_decision + get_quality_config |
the profile cutoff/upgrade thresholds vs. the current file's score |
| "What's stuck downloading right now?" | get_queues |
unified queue with progress, ETA, and stall flags |
Tools
All read-only and outcome-oriented (not one-per-endpoint, which keeps the model accurate):
| Tool | Answers |
|---|---|
stack_health |
Is anything down / unhealthy / low on disk? |
get_queues |
Unified active downloads (arr queue ↔ qBittorrent), stalls |
diagnose |
Where is X in the pipeline / why isn't it here yet? |
explain_decision |
Why was X grabbed or being upgraded? (profile, custom formats, grab history) |
get_quality_config |
Quality profiles, custom formats, release profiles, Profilarr sync state |
get_history |
Recent grabs / imports / failures |
get_wanted |
What's missing / cutoff-unmet? |
search_media |
Do I have X, what's its status? |
get_indexers |
Which indexers are failing? |
get_transcodes |
What's transcoding / stuck? |
Install
There are two ways to run Oraclarr — pick one, you don't need both:
- 🐳 Docker (recommended) — a small always-on container that lives next to your arr stack. Best for homelabs; works great with Portainer, Dockge, Unraid, etc.
- 🐍 Python (uv) — run it directly on your machine with no container. Best for local development, or if you simply don't use Docker.
Both options need the same two files. Make them from the templates in this repo —
config.example.yaml (your service URLs) and
.env.example (your API keys / passwords):
- If you cloned the repo:
cp config.example.yaml config.yamlandcp .env.example .env, then edit them. - If you're pasting into Dockge/Portainer: open those two example files above,
copy their contents into a
config.yamland a.envin your stack folder, and fill in your details.
See Configuration below for exactly what goes in config.yaml.
Your config.yaml and .env are never committed — your URLs and secrets stay on
your machine. Now follow one of the two options below.
Option A — Docker (recommended)
Oraclarr runs as a long-running container that serves MCP over HTTP at
http://<host>:7979/mcp. You need three things in one folder: your config.yaml,
your .env, and a docker-compose.yml.
Using a stack manager (Dockge, Portainer, etc.): create a new stack, paste the
compose below into the editor, and put your config.yaml and .env in the same
stack folder. Hit deploy.
Using the command line:
cp docker-compose.example.yml docker-compose.yml
docker compose up -d
Either way, this is the compose file — copy/paste it as-is:
services:
oraclarr:
image: ghcr.io/bdog720/oraclarr-mcp:latest
container_name: oraclarr
restart: unless-stopped
ports:
- "7979:7979" # left side is the host port — change it if 7979 is taken
volumes:
- ./config.yaml:/config/config.yaml:ro
environment:
SONARR_KEY: ${SONARR_KEY}
SONARR_ANIME_KEY: ${SONARR_ANIME_KEY}
RADARR_KEY: ${RADARR_KEY}
PROWLARR_KEY: ${PROWLARR_KEY}
QBIT_USER: ${QBIT_USER}
QBIT_PASS: ${QBIT_PASS}
PROFILARR_KEY: ${PROFILARR_KEY}
The keys on the right (${SONARR_KEY} …) are read from your .env file. Then
connect Claude Desktop.
Option B — Python (uv)
Run Oraclarr directly, no Docker. Requires Python 3.12+ and
uv.
From PyPI (no clone needed): the package is published as
oraclarr-mcp. Point ORACLARR_CONFIG
at your config.yaml and run it with uvx:
ORACLARR_CONFIG=config.yaml uvx oraclarr-mcp
From a clone (for development):
uv sync
ORACLARR_CONFIG=config.yaml uv run python -m oraclarr_mcp
This speaks MCP over stdio — the client launches the process for you, so you register it in your client's config rather than connecting to a URL:
"oraclarr": {
"command": "uvx",
"args": ["oraclarr-mcp"],
"env": { "ORACLARR_CONFIG": "/absolute/path/to/config.yaml" }
}
(From a clone instead of PyPI, use "command": "uv", "args": ["run", "python", "-m", "oraclarr_mcp"], and add "cwd" pointing at the repo.)
Connect Claude Desktop
(For Option A / Docker. Option B registers itself with the JSON snippet above.)
Use the mcp-remote bridge in claude_desktop_config.json. It runs locally as
a Claude Desktop "local MCP server", so it can reach the container on your LAN
(requires Node.js / npx):
{
"mcpServers": {
"oraclarr": {
"command": "npx",
"args": ["-y", "mcp-remote", "http://<host>:7979/mcp"]
}
}
}
Replace <host> with the IP or hostname of the machine running the container.
Why not the native "Add custom connector"? Custom connectors connect to your server from Anthropic's cloud, not from your machine — so the URL must be a publicly reachable HTTPS endpoint (a
http://LAN/localhost URL is rejected). Pointing it at a homelab box means exposing this unauthenticated read-only service to the internet, which we don't recommend until authentication lands (a later phase). If you want it anyway, put a reverse proxy (Caddy/nginx) or tunnel (Cloudflare Tunnel, Tailscale Funnel) with TLS in front and add your own auth.
Security: the service is unauthenticated read-only MCP. Deploy on a trusted LAN only and do not expose port 7979 to the internet. Authentication is a later phase.
Transport settings (Docker only)
These apply to the Docker container only. The image already sets sensible defaults, so you normally don't touch them — the table is here for reference. The Python path (Option B) always uses stdio and ignores these entirely.
| Variable | Default | What it does |
|---|---|---|
ORACLARR_TRANSPORT |
http |
How clients reach the server. http = long-running service (Docker). stdio = the client launches the process (the Python path). You don't normally set this by hand — your install method picks it. |
ORACLARR_HTTP_HOST |
0.0.0.0 |
Which network interface to listen on. 0.0.0.0 means "reachable on your LAN" — leave as-is for Docker. |
ORACLARR_HTTP_PORT |
7979 |
Port inside the container. To change the port you reach it on, edit the ports: line in the compose instead. |
ORACLARR_CONFIG |
/config/config.yaml |
Where the container reads config.yaml. Leave as-is. |
Configuration
Instances are named in config.yaml; type selects the client, so any number of instances of any type (e.g. two Sonarrs) just work. Secrets are referenced as ${ENV_VAR} and pulled from .env:
server:
allow_writes: false # read-only; writes are a future phase
toolsets: [media, downloads, transcode]
defaults:
timeout_seconds: 10
instances:
sonarr: { type: sonarr, url: http://host:8989, api_key: ${SONARR_KEY} }
sonarr-anime: { type: sonarr, url: http://host:8990, api_key: ${SONARR_ANIME_KEY} }
radarr: { type: radarr, url: http://host:7878, api_key: ${RADARR_KEY} }
prowlarr: { type: prowlarr, url: http://host:9696, api_key: ${PROWLARR_KEY} }
qbit: { type: qbittorrent, url: http://host:8080, username: ${QBIT_USER}, password: ${QBIT_PASS} }
tdarr: { type: tdarr, url: http://host:8265 }
profilarr: { type: profilarr, url: http://host:6868, api_key: ${PROFILARR_KEY} }
Roadmap
Oraclarr is built in phases. v1 is deliberately read-only; write capability arrives behind explicit safety gates. The architecture (typed clients + outcome tools + config-selectable toolsets) is designed to extend to other self-hosted suites beyond *arr, too.
- ✅ Phase 1: read-only diagnostics. Sonarr, Radarr, Prowlarr, qBittorrent, Tdarr, Profilarr.
- 🔜 Phase 2: more services, still read-only. Jellyfin, Seerr, Gluetun, TrueNAS, Cleanuparr, ntfy. The architecture also opens up to non-*arr stacks.
- 🔭 Phase 3: safe write actions. Trigger search, retry, refresh/rescan, approve requests, gated behind
allow_writeswith dry-run previews and an audit log. - 🔭 Phase 4: destructive actions. Delete media, blocklist, stack control, behind an explicit confirmation and allowlist.
Have a service you'd like covered? Open an issue.
💬 Feedback & Issues
Found a bug or have a feature request? We'd love to hear about it. Please open an issue here on GitHub.
🤝 Contributing
We welcome contributions! Issues and PRs welcome — the codebase is TDD throughout:
uv run pytest # tests (respx-mocked, no live services needed)
uv run ruff check . # lint
Adding a service follows a small recipe (new client → register by type → extend a tool → write the test). See the project layout under src/oraclarr_mcp/.
📄 License
This project is licensed under the Apache License 2.0. See the LICENSE file for details.
💖 Support the Project
If you find Oraclarr useful and it saves you from tabbing through six web UIs to work out why something didn't download, consider buying me a coffee to support future development!
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file oraclarr_mcp-1.0.0.tar.gz.
File metadata
- Download URL: oraclarr_mcp-1.0.0.tar.gz
- Upload date:
- Size: 70.9 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
9a3e88040f88f8a1dc76f35b3816651f2ce40087e1c9c3f27ebc904b2c9e807d
|
|
| MD5 |
93836b65dc17c0ab64d659b6362eca1a
|
|
| BLAKE2b-256 |
2f8039aaf2342b6d11d81a3a4f707af9fae29b206bbaa09b5d9e3cbcf967f02a
|
Provenance
The following attestation bundles were made for oraclarr_mcp-1.0.0.tar.gz:
Publisher:
publish-pypi.yml on bdog720/oraclarr
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
oraclarr_mcp-1.0.0.tar.gz -
Subject digest:
9a3e88040f88f8a1dc76f35b3816651f2ce40087e1c9c3f27ebc904b2c9e807d - Sigstore transparency entry: 1802836273
- Sigstore integration time:
-
Permalink:
bdog720/oraclarr@5d2a445520d8735e3594436bf066cdee2e88099a -
Branch / Tag:
refs/tags/v1.0.0 - Owner: https://github.com/bdog720
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish-pypi.yml@5d2a445520d8735e3594436bf066cdee2e88099a -
Trigger Event:
push
-
Statement type:
File details
Details for the file oraclarr_mcp-1.0.0-py3-none-any.whl.
File metadata
- Download URL: oraclarr_mcp-1.0.0-py3-none-any.whl
- Upload date:
- Size: 25.9 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
522ca70cab0d100a4e11f16d6509e65f413316ec490542a29058d2d0a3e2f411
|
|
| MD5 |
26a831f35b6eb6a4437c13f5e25dde1a
|
|
| BLAKE2b-256 |
dd06cc2fe7d73beaafb86ba069319f80a557a1d2cb1dd4f08a5dda0800a9282e
|
Provenance
The following attestation bundles were made for oraclarr_mcp-1.0.0-py3-none-any.whl:
Publisher:
publish-pypi.yml on bdog720/oraclarr
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
oraclarr_mcp-1.0.0-py3-none-any.whl -
Subject digest:
522ca70cab0d100a4e11f16d6509e65f413316ec490542a29058d2d0a3e2f411 - Sigstore transparency entry: 1802836490
- Sigstore integration time:
-
Permalink:
bdog720/oraclarr@5d2a445520d8735e3594436bf066cdee2e88099a -
Branch / Tag:
refs/tags/v1.0.0 - Owner: https://github.com/bdog720
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish-pypi.yml@5d2a445520d8735e3594436bf066cdee2e88099a -
Trigger Event:
push
-
Statement type: