Skip to main content
Glama
amphineko

prowlarr-mcp

by amphineko

prowlarr-mcp

An MCP server for Prowlarr.

Setup

cd prowlarr-mcp
uv sync
cp .env.example .env

Set PROWLARR_API_KEY in .env. The API key is available in Prowlarr under Settings → General → Security.

Configuration:

Variable

Default

Description

PROWLARR_URL

http://localhost:9696

Prowlarr base URL, including any URL base path

PROWLARR_API_KEY

required

Prowlarr API key

PROWLARR_TIMEOUT_SECONDS

60

HTTP timeout, greater than 0 and at most 300 seconds

PROWLARR_MAX_RESULTS

100

Hard upper bound accepted by limit

Related MCP server: qBittorrent MCP Server

Run

uv run prowlarr-mcp

The container image also runs the MCP server over stdio:

docker run --rm -i \
  -e PROWLARR_URL=http://prowlarr.example:9696 \
  -e PROWLARR_API_KEY \
  ghcr.io/amphineko/prowlarr-mcp:latest

Keep stdin attached with -i; the server does not expose a network port.

Example Codex/OpenCode-style stdio configuration:

{
  "command": "uv",
  "args": [
    "--directory",
    "/path/to/prowlarr-mcp",
    "run",
    "prowlarr-mcp"
  ]
}

Tools

list_indexers lists configured indexers and their safe, search-relevant capabilities. It omits disabled indexers by default; pass enabled_only=false to include them. Each result includes supported search types and category IDs, without provider configuration fields or credentials.

list_categories returns Prowlarr's hierarchical search category taxonomy. Use these category IDs with search_releases. Category ID 0 is valid in Prowlarr's taxonomy and is accepted by the search tool.

list_download_clients lists configured download clients and omits disabled clients by default. It returns only submission-relevant fields and numeric category IDs; provider configuration, client category names, hosts, and credentials are excluded.

grab_release submits a release returned by search_releases to a configured download client. Pass the release's indexer_id and guid, plus an optional download_client_id from list_download_clients. Omitting the client ID lets Prowlarr select its configured default. Search results are cached by Prowlarr for about 30 minutes; search again if submission reports that the release has expired from the cache.

get_health returns Prowlarr's current health checks with their severity, message, source, and optional help URL. get_indexer_status returns failure and retry timing only for currently blocked indexers; resolve its numeric IDs with list_indexers.

search_releases accepts:

  • query: text query; an empty string requests recent releases.

  • search_type: search, tvsearch, movie, music, or book.

  • indexer_ids: optional Prowlarr indexer IDs.

  • categories: optional Newznab category IDs.

  • limit: number of results, default 20 and capped by configuration.

  • offset: non-negative result offset.

The response is intentionally smaller than Prowlarr's full ReleaseResource, but retains indexer_id and guid for a future download-submission workflow. Prowlarr may apply limit independently to several indexers, so the MCP server also enforces it on the combined response. truncated means that the MCP server discarded part of the response it received; it is not a has_more pagination indicator and cannot prove whether Prowlarr has additional results.

Error handling

For Prowlarr 4xx responses, the server reports bounded, sanitized details from recognized JSON error formats. It ignores stack traces, diagnostic content, trace IDs, URLs, filesystem paths, API keys, and unknown response shapes. Authentication errors, non-JSON bodies, and 5xx responses use generic messages with an HTTP status code.

Roadmap

  • v0.1: Search releases through configured Prowlarr indexers.

  • v0.2: Discover search and download capabilities, and submit a selected release to a configured download client.

  • v0.2.1: Inspect Prowlarr health and indexer status.

  • Inspect Prowlarr search history.

Testing with the MCP client

The repository includes a generic stdio client for launching the server and calling one tool:

uv run src/prowlarr_mcp/scripts/mcp_client.py \
  --command "uv run prowlarr-mcp" \
  --method "search_releases" \
  --arguments '{"query": "yani neko"}'

Use --cwd when the server command must run from a different directory, and --timeout to override the default 60-second tool-call timeout. The script prints structured tool output as JSON and exits non-zero for invalid input, connection failures, or MCP tool errors.

Development

uv run ruff format --check .
uv run ruff check .
uv run pyrefly check
uv run python -m unittest discover -s tests

Available Tools

1 tool
search_releasesA
Read-onlyIdempotent

Search enabled Prowlarr indexers for Torrent or Usenet releases.

An empty query requests recent releases. Omit indexer_ids and categories to search all enabled indexers and categories. Results preserve Prowlarr's ordering. The indexer_id and guid identify a release for a future download submission capability, which is not available in version 0.1.

ParametersJSON Schema
NameRequiredDescriptionDefault
limitNo
queryNo
offsetNo
categoriesNo
indexer_idsNo
search_typeNosearch

Output Schema

ParametersJSON Schema
NameRequiredDescription
limitYes
queryYes
offsetYes
releasesYes
returnedYes
truncatedYes
search_typeYes

TDQS

A4.5/5.0
Behavior4/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

The annotations already provide readOnlyHint, idempotentHint, and destructiveHint, so the safety profile is clear. The description adds meaningful behavioral context beyond annotations: results preserve Prowlarr ordering, empty queries mean recent releases, and indexer_id plus guid are not yet usable for downloads. It does not contradict the annotations.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is compact: three short sentences that front-load the main action and then add behavioral clarifications. The future-download-availability caveat is a small but relevant addition that prevents the agent from assuming a download capability that doesn't exist in this version. No sentence is wasted.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given the simple parameter set, no required parameters, a complete output schema, and safety annotations, this description covers everything needed to call the tool correctly. An agent can understand the search scope, the empty-query special case, filtering by indexers/categories, and the result-ordering guarantee.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

With 0% schema description coverage, the description compensates by explaining the key query semantics: empty query means recent releases, and omitted indexer_ids/categories search all enabled ones. It does not explicitly describe limit, offset, or search_type, but those are straightforward from the schema defaults and the enum values. This is strong semantic coverage despite a few remaining gaps.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The first sentence states a specific action ('Search'), a specific resource ('enabled Prowlarr indexers'), and the result domain ('Torrent or Usenet releases'). The empty-query and omit-filter explanations further clarify the scope. Although there are no sibling tools to differentiate from, the purpose is unambiguous and complete.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description clearly tells the agent when behaviors change: an empty query requests recent releases, and omitting indexer_ids and categories searches all enabled indexers and categories. There are no sibling tools to compare against, so the lack of alternatives guidance is acceptable; the exclusion of download submission capability is also useful context.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Tool Schema Changelog

Recent tool additions, removals, and schema changes observed during successful MCP inspections.

  1. 1 tool updatev0.1.0
    • First observedsearch_releases

TDQS

A4.4/5.0

Scored across 1 tool

Disambiguation5/5

There is only one tool, so there is no possibility of confusing it with another. Its purpose is clearly focused on searching releases, making misselection unnecessary.

Naming Consistency5/5

search_releases follows a clean verb_noun naming convention. With a single tool there is no conflicting pattern, and the name accurately describes the operation.

Tool Count4/5

A single tool is slightly thin for a server named Prowlarr, but it is appropriate for the currently advertised search-only capability. The missing functionality is explicitly reserved for a future version, so the count is reasonable, not excessive.

Completeness3/5

The search tool offers robust coverage for querying, filtering by categories or indexer_ids, and fetching recent releases. However, there is no way to discover available indexer_ids or continue from a search result to download submission, and the description explicitly notes that capability is unavailable, leaving a meaningful workflow gap.

Maintenance

ActivityMaintained
ResponsivenessNo issues

Related MCP Connectors

Related MCP Servers

  • A
    license
    A
    quality
    A
    maintenance
    Enables privacy-respecting web searches through SearXNG metasearch engine with customizable parameters like language, time range, categories, and engines. Supports safe search levels, pagination control, and basic authentication for secure search operations.
    1
    2
    MIT
  • F
    license
    A
    quality
    D
    maintenance
    Enables interaction with qBittorrent through its Web API to search for torrents using search plugins and manage downloads. Supports torrent searching, downloading via URLs/magnet links, and torrent management operations like pause, resume, and delete.
    7
    3
    -
  • A
    license
    Not graded
    quality
    Not graded
    maintenance
    Enables privacy-focused web searches through the Presearch API and web content scraping. Supports multi-language search, configurable safe search, result caching, and multiple export formats (JSON, CSV, Markdown).
    4
    -