🚀 MCP *arr Server
MCP *arr Server 是一款適用於 *arr 媒體管理套件(包括 Sonarr、Radarr、Lidarr、Readarr 和 Prowlarr)的服務器。它提供了統一的媒體管理接口,支持自然語言查詢、跨服務搜索等功能,能幫助用戶更高效地管理媒體資源。
🚀 快速開始
MCP *arr Server 為 *arr 媒體管理套件(如 Sonarr、Radarr、Lidarr、Readarr 和 Prowlarr)提供了 MCP 服務器支持。你可以通過以下步驟快速開始使用:
- 確保滿足 先決條件。
- 按照 安裝指南 進行安裝。
- 完成 配置 步驟。
- 參考 使用示例 進行操作。
✨ 主要特性
- 統一媒體管理:通過一個界面控制所有 *arr 應用程序。
- 自然語言查詢:使用自然英語詢問你的媒體庫信息。
- 跨服務搜索:同時在電視、電影、音樂和書籍中查找內容。
- 下載監控:檢查所有服務的隊列狀態和進度。
- 日曆集成:查看所有媒體類型的即將發佈內容。
- 配置審查:獲取由 AI 提供的優化設置建議。
- 靈活配置:僅啟用你使用的服務。
各服務功能詳情
| 類別 |
功能 |
| Sonarr (電視) |
列出劇集、查看劇集信息、搜索節目、觸發下載、檢查隊列、查看日曆、審查設置 |
| Radarr (電影) |
列出電影、搜索影片、觸發下載、檢查隊列、查看發佈信息、審查設置 |
| Lidarr (音樂) |
列出藝術家、查看專輯、搜索音樂家、觸發下載、檢查隊列、查看日曆、審查設置 |
| Readarr (書籍) |
列出作者、查看書籍、搜索作家、觸發下載、檢查隊列、查看日曆、審查設置 |
| Prowlarr (索引器) |
列出索引器、在所有跟蹤器中搜索、測試健康狀況、查看統計信息 |
| 跨服務 |
狀態檢查、在所有配置的服務中進行統一搜索 |
| 配置 |
質量配置文件、下載客戶端、命名約定、健康檢查、存儲信息 |
| TRaSH 指南 |
參考質量配置文件、自定義格式、命名約定,並與建議進行比較 |
📦 安裝指南
使用 npm(推薦)
npx mcp-arr-server
從源代碼安裝
git clone https://github.com/aplaceforallmystuff/mcp-arr.git
cd mcp-arr
npm install
npm run build
🔧 配置
獲取 API 密鑰
每個 *arr 應用程序在“設置 > 常規 > 安全”中都有一個 API 密鑰。獲取步驟如下:
- 打開你的 *arr 應用程序的 Web 界面。
- 轉到“設置”>“常規”。
- 在安全部分找到“API 密鑰”。
- 複製 API 密鑰以用於配置。
針對 Claude Desktop 的配置
將以下內容添加到你的 Claude Desktop 配置文件中:
macOS:~/Library/Application Support/Claude/claude_desktop_config.json
Windows:%APPDATA%\Claude\claude_desktop_config.json
{
"mcpServers": {
"arr": {
"command": "npx",
"args": ["-y", "mcp-arr-server"],
"env": {
"SONARR_URL": "http://localhost:8989",
"SONARR_API_KEY": "your-sonarr-api-key",
"RADARR_URL": "http://localhost:7878",
"RADARR_API_KEY": "your-radarr-api-key",
"LIDARR_URL": "http://localhost:8686",
"LIDARR_API_KEY": "your-lidarr-api-key",
"READARR_URL": "http://localhost:8787",
"READARR_API_KEY": "your-readarr-api-key",
"PROWLARR_URL": "http://localhost:9696",
"PROWLARR_API_KEY": "your-prowlarr-api-key"
}
}
}
}
針對 Claude Code 的配置
將以下內容添加到 ~/.claude.json 文件中:
{
"mcpServers": {
"arr": {
"command": "npx",
"args": ["-y", "mcp-arr-server"],
"env": {
"SONARR_URL": "http://localhost:8989",
"SONARR_API_KEY": "your-sonarr-api-key",
"RADARR_URL": "http://localhost:7878",
"RADARR_API_KEY": "your-radarr-api-key"
}
}
}
}
注意:僅配置你正在運行的服務。服務器會根據你提供的環境變量自動檢測可用的服務。
💻 使用示例
基礎用法
以下是一些常見的使用示例:
媒體庫管理
- "Show me all my TV series"(顯示我所有的電視劇)
- "What movies do I have in Radarr?"(我在 Radarr 中有哪些電影?)
- "List all artists in my music library"(列出我音樂庫中的所有藝術家)
- "How many books do I have by Stephen King?"(我有多少本斯蒂芬·金的書?)
內容搜索
- "Search for Breaking Bad on Sonarr"(在 Sonarr 中搜索《絕命毒師》)
- "Find the movie Inception"(查找電影《盜夢空間》)
- "Search for Taylor Swift albums"(搜索泰勒·斯威夫特的專輯)
- "Look up books by Brandon Sanderson"(查找布蘭登·桑德森的書籍)
下載隊列
- "What's downloading right now?"(現在正在下載什麼?)
- "Check the Sonarr queue"(檢查 Sonarr 隊列)
- "Show Radarr download progress"(顯示 Radarr 的下載進度)
即將發佈內容
- "What TV episodes are coming this week?"(本週有哪些電視劇集即將發佈?)
- "Show upcoming movie releases"(顯示即將上映的電影)
- "Any new albums coming out this month?"(本月有新專輯發佈嗎?)
- "Show me upcoming book releases"(顯示即將發佈的書籍)
內容下載
- "What episodes of Severance am I missing?"(我錯過了《人生切割術》的哪些劇集?)
- "Download the missing episodes for that show"(下載該電視劇缺失的劇集)
- "Search for this specific movie"(搜索這部特定的電影)
- "Grab that Japanese Breakfast album"(獲取那張 Japanese Breakfast 的專輯)
- "Download all missing books by Brandon Sanderson"(下載布蘭登·桑德森所有缺失的書籍)
索引器管理
- "Are my indexers healthy?"(我的索引器健康嗎?)
- "How are my indexers performing?"(我的索引器表現如何?)
- "Test all my Prowlarr indexers"(測試我所有的 Prowlarr 索引器)
配置審查(新增)
- "Review my Sonarr setup and suggest improvements"(審查我的 Sonarr 設置並提出改進建議)
- "Show me my quality profiles in Radarr"(顯示我在 Radarr 中的質量配置文件)
- "Are there any health issues with my Lidarr?"(我的 Lidarr 有健康問題嗎?)
- "What naming convention am I using for TV shows?"(我對電視劇使用的命名約定是什麼?)
- "Help me understand my quality profiles - why am I not getting 4K?"(幫助我理解我的質量配置文件 - 為什麼我沒有獲得 4K 內容?)
- "Check my download client configuration"(檢查我的下載客戶端配置)
- "How much free space do I have on my root folders?"(我的根文件夾有多少可用空間?)
跨服務操作
- "Check status of all my *arr services"(檢查我所有 *arr 服務的狀態)
- "Search for 'The Office' across all services"(在所有服務中搜索《辦公室》)
🔧 技術細節
可用工具
通用工具
| 工具 |
描述 |
arr_status |
獲取所有配置的 *arr 服務的連接狀態 |
arr_search_all |
同時在所有配置的服務中進行搜索 |
Sonarr 工具(電視)
| 工具 |
描述 |
sonarr_get_series |
列出你媒體庫中的所有電視劇 |
sonarr_search |
搜索要添加的電視劇 |
sonarr_get_queue |
查看當前下載隊列 |
sonarr_get_calendar |
查看即將發佈的劇集 |
sonarr_get_episodes |
列出某部電視劇的劇集(顯示缺失和可用的劇集) |
sonarr_search_missing |
觸發搜索某部電視劇的所有缺失劇集 |
sonarr_search_episode |
觸發搜索特定的劇集 |
Radarr 工具(電影)
| 工具 |
描述 |
radarr_get_movies |
列出你媒體庫中的所有電影 |
radarr_search |
搜索要添加的電影 |
radarr_get_queue |
查看當前下載隊列 |
radarr_get_calendar |
查看即將發佈的電影 |
radarr_search_movie |
觸發搜索並下載你媒體庫中的某部電影 |
Lidarr 工具(音樂)
| 工具 |
描述 |
lidarr_get_artists |
列出你媒體庫中的所有藝術家 |
lidarr_search |
搜索要添加的藝術家 |
lidarr_get_queue |
查看當前下載隊列 |
lidarr_get_albums |
列出某藝術家的專輯(顯示缺失和可用的專輯) |
lidarr_search_album |
觸發搜索特定的專輯 |
lidarr_search_missing |
觸發搜索某藝術家的所有缺失專輯 |
lidarr_get_calendar |
查看即將發佈的專輯 |
Readarr 工具(書籍)
| 工具 |
描述 |
readarr_get_authors |
列出你媒體庫中的所有作者 |
readarr_search |
搜索要添加的作者 |
readarr_get_queue |
查看當前下載隊列 |
readarr_get_books |
列出某作者的書籍(顯示缺失和可用的書籍) |
readarr_search_book |
觸發搜索特定的書籍 |
readarr_search_missing |
觸發搜索某作者的所有缺失書籍 |
readarr_get_calendar |
查看即將發佈的書籍 |
Prowlarr 工具(索引器)
| 工具 |
描述 |
prowlarr_get_indexers |
列出所有配置的索引器 |
prowlarr_search |
在所有索引器中進行搜索 |
prowlarr_test_indexers |
測試所有索引器並返回健康狀態 |
prowlarr_get_stats |
獲取索引器統計信息(查詢、抓取、失敗情況) |
配置審查工具
這些工具適用於 Sonarr、Radarr、Lidarr 和 Readarr。將 {service} 替換為服務名稱(例如,sonarr_get_quality_profiles)。
| 工具 |
描述 |
{service}_get_quality_profiles |
獲取詳細的質量配置文件信息,包括允許的質量和自定義格式分數 |
{service}_get_health |
獲取應用程序檢測到的健康檢查警告和問題 |
{service}_get_root_folders |
獲取存儲路徑、可用空間和可訪問性狀態 |
{service}_get_download_clients |
獲取下載客戶端配置和設置 |
{service}_get_naming |
獲取文件和文件夾的命名約定 |
{service}_get_tags |
獲取用於內容組織的標籤定義 |
{service}_review_setup |
獲取全面的配置信息,以便進行 AI 輔助的設置分析 |
{service}_review_setup 工具可以一次性返回所有配置信息,從而支持通過自然語言對話來優化你的設置。Claude 可以分析你的質量配置文件、提出改進建議、解釋為什麼某些內容無法獲取,並幫助配置複雜的設置,如自定義格式。
⚠️ 重要提示
配置審查工具僅提供對你 *arr 設置的 只讀 訪問權限。任何對配置的更改都必須直接在 *arr 應用程序界面中進行。AI 提供的建議僅為參考 - 在進行重大更改之前,請務必備份你的配置。維護者不對因遵循 AI 生成的建議而可能出現的任何配置更改、數據丟失或其他問題負責。
TRaSH 指南工具
你可以通過 Claude 直接訪問 TRaSH 指南 中社區整理的質量配置文件、自定義格式和命名約定。這些工具無需 *arr 配置 - 它們從 TRaSH 指南的 GitHub 存儲庫中獲取參考數據。
| 工具 |
描述 |
trash_list_profiles |
列出 Radarr 或 Sonarr 可用的 TRaSH 質量配置文件 |
trash_get_profile |
獲取包含自定義格式、分數和質量設置的詳細配置文件 |
trash_list_custom_formats |
列出自定義格式,可選擇按類別過濾(如 hdr、音頻、分辨率等) |
trash_get_naming |
獲取 Plex、Emby、Jellyfin 或標準的推薦命名約定 |
trash_get_quality_sizes |
獲取每個質量級別推薦的最小/最大/首選大小 |
trash_compare_profile |
將你的配置文件與 TRaSH 建議進行比較(需要配置 *arr) |
trash_compare_naming |
將你的命名配置與 TRaSH 建議進行比較(需要配置 *arr) |
示例用法:
- "What quality profiles does TRaSH recommend for 4K movies?"(TRaSH 為 4K 電影推薦哪些質量配置文件?)
- "Show me the remux-web-1080p profile details"(顯示 remux-web-1080p 配置文件的詳細信息)
- "Compare my Radarr profile 4 against the TRaSH uhd-bluray-web profile"(將我的 Radarr 配置文件 4 與 TRaSH 的 uhd-bluray-web 配置文件進行比較)
- "What naming convention should I use for Plex?"(我應該為 Plex 使用什麼命名約定?)
- "List HDR-related custom formats for Radarr"(列出 Radarr 中與 HDR 相關的自定義格式)
數據會緩存 1 小時,以減少對 GitHub API 的調用。
開發
npm run watch
npm run build
SONARR_URL="http://localhost:8989" SONARR_API_KEY="your-key" node dist/index.js
故障排除
"No *arr services configured"
確保你至少設置了一對 URL 和 API_KEY 環境變量:
SONARR_URL="http://localhost:8989"
SONARR_API_KEY="your-api-key"
"API error: 401 Unauthorized"
API 密鑰不正確。請在你的 *arr 應用程序的“設置 > 常規 > 安全”中驗證。
"fetch failed" or "ECONNREFUSED"
*arr 應用程序未運行或 URL 不正確。請驗證:
- 應用程序正在運行。
- URL 和端口正確。
- 沒有防火牆阻止連接。
"Sonarr/Radarr/etc not configured"
你嘗試使用未配置的服務的工具。請添加相應的 URL 和 API_KEY 環境變量。
🤝 貢獻
歡迎貢獻代碼!請參閱 CONTRIBUTING.md 瞭解貢獻指南。
📄 許可證
本項目採用 MIT 許可證 - 詳情請參閱 LICENSE。
🔗 鏈接