YTDL RMCP
What it does
yt-dlp search, download, metadata, delivery, and Plex workflows over MCP and CLI.
- Connects Runs on your computer
- Account or key No key needed
- Category Search & AI memory
Install
Pick the AI app you use, then copy the settings.
Passed 3/3 checks · Runs on your computer · ✓ Commands checked Nov 14, 2026
First: which AI do you use?
Pick your app and the steps appear below.
Works with Claude, with some setup first
Install Node.js on your computer first (one time) · Only the Claude desktop app (Windows or Mac), not the web or phone
Let AI install it
Copy this message into a Claude chat. The AI checks your computer, tells you which file it will change, and waits for your OK every time.
Please install the MCP server YTDL RMCP for Claude on this computer, in this order: 1) Check Node.js with node -v. If it is missing, tell me to install it from https://nodejs.org/en/download; do not install it yourself. 2) Use only this config (already checked by PopNx MCP): { "mcpServers": { "rytdl": { "command": "npx", "args": [ "-y", "@dinglebear/rytdl" ] } } } 3) Tell me the full path of the file you will change, or the command you will run, and wait for my OK. 4) No key is needed. 5) Do what we agreed, then check that the YTDL RMCP tools really show up.This message has no key in it. If a key is needed, the AI will ask you to paste it yourself into the file or the app’s field.
Install Node.js (if you don’t have it)
Already installed? Check first · Open Terminal, type this command and press Enter
node -v- A version number such as v26.13.1 = installed, skip this step
- "command not found" (on Windows: "is not recognized") = not installed yet, or installed but Terminal needs to be closed and reopened
How to open Terminal
Mac: press ⌘ + Space, type Terminal, press Enter
Windows: open Start, type Windows PowerShell, then Open
Not installed: Open the official download page, pick the LTS version and the click-through installer: .pkg on Mac · .msi on Windows. Double-click and follow it to the end. No curl command needed
Open the Node.js download page ↗
When it’s done, close Terminal, open it again and run the same command. You should see a version number:
node -vInstall once; it works for everything that needs Node.js
Open the Claude desktop app’s settings file
SettingsDeveloperEdit Config
Paste these settings and save the file
{ "mcpServers": { "rytdl": { "command": "npx", "args": [ "-y", "@dinglebear/rytdl" ] } } }Quit Claude and open it again
Try it
Use YTDL RMCP and tell me what you can do for me, then show me one thing✓ If Claude says it is using YTDL RMCP or shows a YTDL RMCP tool in the answer, you are connected
6 optional setting(s) (works without them)
The command above works without these. Add them only if you want to change something, following the maker’s description.
YTDLP_PLEX_URLOptional Plex server URL for playlist and Plex sync workflows.YTDLP_PLEX_TOKENOptional Plex token for playlist and Plex sync workflows.YTDLP_ACOUSTID_CLIENT_KEYOptional AcoustID client key for identification and auto-retagging workflows.YTDL_RMCP_BINARY_VERSIONOptional GitHub release tag override for the downloaded YTDL RMCP binary.YTDL_RMCP_RELEASE_BASE_URLOptional release download base URL override. · default https://github.com/dinglebear-ai/rytdl/releases/downloadRUST_LOGTracing filter for YTDL RMCP logs. · default info
Descriptions are as written by the maker.
Menu names checked against Anthropic’s help page on Nov 11, 2026 · your screen may differ slightly by app version
ChatGPT cannot connect YTDL RMCP yet
YTDL RMCP runs on your computer, but ChatGPT can only connect servers that run on the web
What you can do instead
A · Use an app that can connect YTDL RMCP
- Install Node.js on your computer first (one time) · Only the Claude desktop app (Windows or Mac), not the web or phone
- Install Node.js on your computer first (one time)
- Install Node.js on your computer first (one time)
- Install Node.js on your computer first (one time)
Works with Claude Code, with some setup first
Install Node.js on your computer first (one time)
Let AI install it
Copy this message into a Claude Code chat. The AI checks your computer, tells you which file it will change, and waits for your OK every time.
Please install the MCP server YTDL RMCP for Claude Code on this computer, in this order: 1) Check Node.js with node -v. If it is missing, tell me to install it from https://nodejs.org/en/download; do not install it yourself. 2) Use only this config (already checked by PopNx MCP): claude mcp add --scope user rytdl -- npx -y @dinglebear/rytdl 3) Tell me the full path of the file you will change, or the command you will run, and wait for my OK. 4) No key is needed. 5) Do what we agreed, then check that the YTDL RMCP tools really show up.This message has no key in it. If a key is needed, the AI will ask you to paste it yourself into the file or the app’s field.
Install Node.js (if you don’t have it)
Already installed? Check first · Open Terminal, type this command and press Enter
node -v- A version number such as v26.13.1 = installed, skip this step
- "command not found" (on Windows: "is not recognized") = not installed yet, or installed but Terminal needs to be closed and reopened
How to open Terminal
Mac: press ⌘ + Space, type Terminal, press Enter
Windows: open Start, type Windows PowerShell, then Open
Not installed: Open the official download page, pick the LTS version and the click-through installer: .pkg on Mac · .msi on Windows. Double-click and follow it to the end. No curl command needed
Open the Node.js download page ↗
When it’s done, close Terminal, open it again and run the same command. You should see a version number:
node -vInstall once; it works for everything that needs Node.js
Open Terminal
Mac: press Command+Space and type Terminal · Windows: open PowerShell
Paste this command and press Enter
claude mcp add --scope user rytdl -- npx -y @dinglebear/rytdlType /mcp in Claude Code
You should see YTDL RMCP listed as connected
Try it
Use YTDL RMCP and tell me what you can do for me, then show me one thing✓ If Claude Code says it is using YTDL RMCP or shows a YTDL RMCP tool in the answer, you are connected
6 optional setting(s) (works without them)
The command above works without these. Add them only if you want to change something, following the maker’s description.
YTDLP_PLEX_URLOptional Plex server URL for playlist and Plex sync workflows.YTDLP_PLEX_TOKENOptional Plex token for playlist and Plex sync workflows.YTDLP_ACOUSTID_CLIENT_KEYOptional AcoustID client key for identification and auto-retagging workflows.YTDL_RMCP_BINARY_VERSIONOptional GitHub release tag override for the downloaded YTDL RMCP binary.YTDL_RMCP_RELEASE_BASE_URLOptional release download base URL override. · default https://github.com/dinglebear-ai/rytdl/releases/downloadRUST_LOGTracing filter for YTDL RMCP logs. · default info
Descriptions are as written by the maker.
Menu names checked against Anthropic’s help page on Nov 11, 2026 · your screen may differ slightly by app version
Works with Cursor, with some setup first
Install Node.js on your computer first (one time)
Let AI install it
Copy this message into a Cursor chat. The AI checks your computer, tells you which file it will change, and waits for your OK every time.
Please install the MCP server YTDL RMCP for Cursor on this computer, in this order: 1) Check Node.js with node -v. If it is missing, tell me to install it from https://nodejs.org/en/download; do not install it yourself. 2) Use only this config (already checked by PopNx MCP): { "mcpServers": { "rytdl": { "command": "npx", "args": [ "-y", "@dinglebear/rytdl" ] } } } 3) Tell me the full path of the file you will change, or the command you will run, and wait for my OK. 4) No key is needed. 5) Do what we agreed, then check that the YTDL RMCP tools really show up.This message has no key in it. If a key is needed, the AI will ask you to paste it yourself into the file or the app’s field.
Install Node.js (if you don’t have it)
Already installed? Check first · Open Terminal, type this command and press Enter
node -v- A version number such as v26.13.1 = installed, skip this step
- "command not found" (on Windows: "is not recognized") = not installed yet, or installed but Terminal needs to be closed and reopened
How to open Terminal
Mac: press ⌘ + Space, type Terminal, press Enter
Windows: open Start, type Windows PowerShell, then Open
Not installed: Open the official download page, pick the LTS version and the click-through installer: .pkg on Mac · .msi on Windows. Double-click and follow it to the end. No curl command needed
Open the Node.js download page ↗
When it’s done, close Terminal, open it again and run the same command. You should see a version number:
node -vInstall once; it works for everything that needs Node.js
Open the AI chat in Cursor in Agent mode
Try it
Use YTDL RMCP and tell me what you can do for me, then show me one thing✓ If Cursor says it is using YTDL RMCP or shows a YTDL RMCP tool in the answer, you are connected
6 optional setting(s) (works without them)
The command above works without these. Add them only if you want to change something, following the maker’s description.
YTDLP_PLEX_URLOptional Plex server URL for playlist and Plex sync workflows.YTDLP_PLEX_TOKENOptional Plex token for playlist and Plex sync workflows.YTDLP_ACOUSTID_CLIENT_KEYOptional AcoustID client key for identification and auto-retagging workflows.YTDL_RMCP_BINARY_VERSIONOptional GitHub release tag override for the downloaded YTDL RMCP binary.YTDL_RMCP_RELEASE_BASE_URLOptional release download base URL override. · default https://github.com/dinglebear-ai/rytdl/releases/downloadRUST_LOGTracing filter for YTDL RMCP logs. · default info
Descriptions are as written by the maker.
Menu names checked against Cursor’s help page on Nov 11, 2026 · your screen may differ slightly by app version
Works with VS Code, with some setup first
Install Node.js on your computer first (one time)
Let AI install it
Copy this message into a VS Code chat. The AI checks your computer, tells you which file it will change, and waits for your OK every time.
Please install the MCP server YTDL RMCP for VS Code on this computer, in this order: 1) Check Node.js with node -v. If it is missing, tell me to install it from https://nodejs.org/en/download; do not install it yourself. 2) Use only this config (already checked by PopNx MCP): { "servers": { "rytdl": { "type": "stdio", "command": "npx", "args": [ "-y", "@dinglebear/rytdl" ] } } } 3) Tell me the full path of the file you will change, or the command you will run, and wait for my OK. 4) No key is needed. 5) Do what we agreed, then check that the YTDL RMCP tools really show up.This message has no key in it. If a key is needed, the AI will ask you to paste it yourself into the file or the app’s field.
Install Node.js (if you don’t have it)
Already installed? Check first · Open Terminal, type this command and press Enter
node -v- A version number such as v26.13.1 = installed, skip this step
- "command not found" (on Windows: "is not recognized") = not installed yet, or installed but Terminal needs to be closed and reopened
How to open Terminal
Mac: press ⌘ + Space, type Terminal, press Enter
Windows: open Start, type Windows PowerShell, then Open
Not installed: Open the official download page, pick the LTS version and the click-through installer: .pkg on Mac · .msi on Windows. Double-click and follow it to the end. No curl command needed
Open the Node.js download page ↗
When it’s done, close Terminal, open it again and run the same command. You should see a version number:
node -vInstall once; it works for everything that needs Node.js
Open the AI chat in VS Code in Agent mode
Try it
Use YTDL RMCP and tell me what you can do for me, then show me one thing✓ If VS Code says it is using YTDL RMCP or shows a YTDL RMCP tool in the answer, you are connected
6 optional setting(s) (works without them)
The command above works without these. Add them only if you want to change something, following the maker’s description.
YTDLP_PLEX_URLOptional Plex server URL for playlist and Plex sync workflows.YTDLP_PLEX_TOKENOptional Plex token for playlist and Plex sync workflows.YTDLP_ACOUSTID_CLIENT_KEYOptional AcoustID client key for identification and auto-retagging workflows.YTDL_RMCP_BINARY_VERSIONOptional GitHub release tag override for the downloaded YTDL RMCP binary.YTDL_RMCP_RELEASE_BASE_URLOptional release download base URL override. · default https://github.com/dinglebear-ai/rytdl/releases/downloadRUST_LOGTracing filter for YTDL RMCP logs. · default info
Descriptions are as written by the maker.
Menu names checked against VS Code’s help page on Nov 11, 2026 · your screen may differ slightly by app version
Other apps that use MCP, such as Windsurf, Zed or Gemini CLI, each add servers differently. See how in the app list.
JSON settings are under “For developers” below
For developers: Terminal commands and JSON settings
Installed on your computer
Claude Code
claude mcp add --scope user rytdl -- npx -y @dinglebear/rytdlClaude Desktop (claude_desktop_config.json)
{
"mcpServers": {
"rytdl": {
"command": "npx",
"args": [
"-y",
"@dinglebear/rytdl"
]
}
}
}Cursor (~/.cursor/mcp.json)
{
"mcpServers": {
"rytdl": {
"command": "npx",
"args": [
"-y",
"@dinglebear/rytdl"
]
}
}
}VS Code (mcp.json)
{
"servers": {
"rytdl": {
"type": "stdio",
"command": "npx",
"args": [
"-y",
"@dinglebear/rytdl"
]
}
}
}Values you fill in
YTDLP_PLEX_URLenvOptional Plex server URL for playlist and Plex sync workflows.YTDLP_PLEX_TOKENsecret envOptional Plex token for playlist and Plex sync workflows.YTDLP_ACOUSTID_CLIENT_KEYsecret envOptional AcoustID client key for identification and auto-retagging workflows.YTDL_RMCP_BINARY_VERSIONenvOptional GitHub release tag override for the downloaded YTDL RMCP binary.YTDL_RMCP_RELEASE_BASE_URLenvOptional release download base URL override.RUST_LOGenvTracing filter for YTDL RMCP logs.
Descriptions are as written by the maker.
These settings are generated from the maker’s registry entry. If the README says otherwise, follow the README.
At a glance
- Downloads per weeki
- 97/wk
- Verified domain
- ✓ dinglebear.ai
- Connection
- Runs on your computer
- Latest versioni
- 1.0.4
- Categoryi
- Search & AI memory
- Published to registryi
- Aug 5, 2026
- Code last changedi
- Oct 22, 2026
- Maker
- dinglebear-ai
- Packages
npm: @dinglebear/rytdl- Website
- rytdl.dinglebear.ai
- Registry status
- Active
Which apps can use it
Based on how this server connects and on each app’s own docs, checked Nov 10, 2026.
Run on your computer in
ClaudeGooseLM StudioMsty StudioCherry StudioCursorVS Code + GitHub CopilotVisual StudioWindsurf (Devin Desktop)ZedKiroClineContinueJetBrains AI AssistantClaude CodeCodex CLIGemini CLIOpenCodenodecodeWarpLibreChatRaycast
Related guides
What it can do
Runs on your computer; the tool list appears in your AI app after you install it.
Basic checksi
We check information anyone can see; we have not read the code. Checks that do not apply are left out of the count. · Checked Nov 15, 2026
- ✓ Pass
Maker matches the repo
The registry name was verified against the domain dinglebear.ai (the registry checks domain ownership)
- ✓ Pass
Still maintained
Code last changed 24 days ago
- ✓ Pass
Has a licence
Uses AGPL-3.0
- – Not applicable
Endpoint responds
This one runs on your computer; there is no internet endpoint
- – Not applicable
Sign-in with OAuth
Runs on your computer and uses local settings instead
- … Not checked yet
No hidden instructions in tool descriptions
Runs on your computer; we can only read tool lists from internet endpoints
Published vulnerabilities (OSV.dev)
Not checked yet
Makers: ask for a re-check or report wrong info
Discussion
Ask, share a tip or report that it does not work. Sorted by what people marked helpful.
No posts yet. Be the first to ask or share.
Posts here are written by users, not the PopNx team.
User reviews
No reviews yet
Compared with others in Search & AI memoryi
- More stars than 85% of the other 6148 servers in this category
- Published to the registry more recently than 25% of the other 6148 servers in this category
- Basic checks equal to or better than 100% of the other 6148 servers in this category
Compared with every active server in this category in the registry. Stars count only when the publisher owns the repo.
Common questions
Is YTDL RMCP safe?
It passed 3 of 3 applicable basic checks. We have not read the code. Before adding a key or token, see what access the server asks for and use a key with only the permissions you need.
What keys or codes does it need?
The registry does not list a required key, though some servers ask you to sign in on first use.
Does it run on my computer or in the cloud?
It runs on your computer. Your AI app starts it when needed, and data does not pass through the maker’s servers (unless it calls an online service itself).
Is it still maintained?
The GitHub repo last changed 24 days ago, and the latest version (1.0.4) reached the registry 3 months ago.
Which apps can use it?
Apps that support MCP, such as Claude Desktop, Claude Code, Cursor and VS Code. You also need Node.js on your computer.
What can I use instead?
In the same category: OpenSEO, Exa, Mockserver, Microsoft Learn MCP, Docs
Similar alternatives
Same category, other makers, commands already checked. Official ones first, then by stars.
Reading a card:↓ Downloads per weeki★ GitHub starsiThree pillars: reviews · checks · usageiUpdated = latest version published to the registryi
Exa
Connect AI agents to Exa for web search, content fetching, and multi-step research.
Mockserver
Mock, record/replay, verify and chaos-test any HTTP, REST, gRPC or LLM dependency over MCP.
Microsoft Learn MCP
Official Microsoft Learn MCP Server – real-time, trusted docs & code samples for AI and LLMs.
Docs
Search and read Empryo's documentation. Read-only, no auth, no local access.
- OpenSEO — Runs in the cloud, nothing to install · No key needed
- Exa — Runs in the cloud, nothing to install · No key needed · In Claude’s directory
- Mockserver — Installs on your computer · No key needed
- Microsoft Learn MCP — Runs in the cloud, nothing to install · No key needed · In Claude’s directory
- Docs — Runs in the cloud, nothing to install · No key needed
README from the maker
Open the README
Copied from the maker’s repo as written. PopNx MCP has not reviewed or endorsed it. HTML, images and scripts are removed. Links lead off this site.
ytdl-rmcp
yt-dlp search, download, metadata, delivery, and Plex workflows over MCP and CLI.
Written in Rust on the rmcp crate. yt-dlp and ffmpeg are auto-downloaded into a per-user cache on first run, so the host needs neither pre-installed — the one binary is the whole install.
30-second path: npx -y @dinglebear/rytdl setup -> configure a target path -> call youtube_search or youtube_probe; use youtube_download only after the destination and trust boundary are clear.
Status: production personal-media MCP server. Read-only search/probe/stats paths are safe; download, playlist, queue-drain, and tag-writing paths create or move state and are intended for trusted callers.
Not for: a generic web-downloader SaaS, a multi-tenant media ingestion boundary, a replacement for yt-dlp's upstream site handling, or an arbitrary filesystem writer for untrusted MCP callers.
Contents
- Naming
- Capabilities And Boundaries
- Install
- Quickstart
- Client Configuration
- Runtime Surfaces
- MCP Tool Reference
- CLI Reference
- Configuration
- Authentication
- Safety And Trust Model
- Architecture
- Distribution Contract
- Development
- Verification
- Deployment
- Troubleshooting
- Related Servers
- Documentation
- License
Naming
| Surface | This repo |
|---|---|
| Repository | dinglebear-ai/rytdl |
| Cargo crate | ytdl-rmcp |
| npm package | @dinglebear/rytdl |
| CLI / binary | rytdl |
| MCP tools | youtube_search, youtube_search_ui, youtube_download, youtube_probe, youtube_identify, youtube_stats, youtube_plex_playlist, youtube_transfer_queue |
| Env prefix | YTDLP_*, plus FFMPEG_*, FPCALC_PATH, and YTDLP_LOG |
| Transport | stdio only — no HTTP listener, no service port |
The crate and npm package use the *-rmcp family naming pattern, while the repository and runtime binary are rytdl so local shells get a short Rust-native command.
Capabilities And Boundaries
- Searches YouTube through yt-dlp without downloading media.
- Downloads audio, video, or both into a staging tree, tags audio metadata, and transfers the result to local, SSH, or rclone destinations.
- Optionally fingerprints audio through AcoustID/MusicBrainz and syncs completed audio downloads into a Plex playlist.
- Builds Plex playlists from successful transfer history and drains server-made retained-staging transfer manifests.
- Exposes an MCP App search UI for hosts that can render embedded widgets.
- Keeps a JSONL ledger for repeat-safe downloads and stats.
| This repo owns | Upstream owns | Explicitly out of scope |
|---|---|---|
| MCP tools, CLI setup, media staging, tagging, transfer policy, queue manifests, config validation, response shaping, plugin/package metadata. | yt-dlp extraction behavior, source-site availability, ffmpeg media conversion, Plex library indexing, SSH/rclone authentication. | Multi-tenant isolation, arbitrary local writes for untrusted callers, credential brokering, site-specific scraping guarantees, media-server replacement. |
Features
- Audio, video, or both — audio-first by default, with separate targets for audio and video.
- Proper tagging — embeds title / artist / album / date and cover art, and organizes output as
Artist/Title [id].extso media servers (Plex, etc.) index it cleanly. A non-greedyArtist - Titleparse recovers the artist from free-form video titles. Source.info.json, thumbnail, and description sidecars are preserved next to the media for future retagging/indexing. Common YouTube title noise like(Official Video),[Official Audio], and trailing channel handles is stripped from embedded title metadata by default. - Self-contained paths — the binary downloads/caches yt-dlp + ffmpeg when run directly; the container image bakes in ffmpeg, fpcalc, SSH, and rsync for media-host batch jobs.
- Self-installing —
ytdl-rmcp setupregisters the server into Claude Code, Codex, and/or Gemini CLI via each tool's ownmcp add. - Robust transfers — local paths (
/path) are copied in-process by the binary itself, SSH targets (host:/path) usersync -a --partial --protect-argswith anscpfallback whenrsyncis missing, and rclone targets (remote:pathorrclone:remote:/path) userclone copy. On transfer failure the local staging copy is kept for retry and recorded as a drainable manifest foryoutube_transfer_queue. - Repeat-safe —
use_archiverecords downloaded IDs (per mode) and skips them on later runs; YouTube mix/radio URLs are auto-cleaned to the seed video. - Stats-ready ledger — every completed download call appends a JSONL entry with timestamp, destinations, files, bytes, uploader, and transfer status.
- Plex playlist sync — when Plex credentials are configured, downloaded audio is added to
yt-dlp Downloadsby default.
MCP Tool Reference
| Tool | Purpose |
|---|---|
youtube_search | Search YouTube with yt-dlp and return result URLs without downloading. |
youtube_search_ui | Open an interactive YouTube search UI in MCP App-capable hosts. |
youtube_download | Download one or more URLs (audio/video/both) and transfer them to a target path. |
youtube_probe | Read-only: resolve title/duration/uploader/format counts without downloading. |
youtube_identify | Fingerprint local audio with fpcalc, return AcoustID/MusicBrainz candidates, preview canonical tags, and optionally write high-confidence tags. |
youtube_stats | Summarize the download ledger: totals, file kinds, uploaders, and recent entries. |
youtube_plex_playlist | Build or preview Plex audio playlists from successful transferred audio history. |
youtube_transfer_queue | List and drain retained-staging transfer failure manifests. |
youtube_download parameters
| Param | Default | Meaning |
|---|---|---|
urls | — (required) | One URL string or an array of URLs. |
mode | audio | audio, video, or both. |
audio_format | env YTDLP_AUDIO_FORMAT → mp3 | mp3/m4a/opus/flac/wav/best. |
audio_quality | 0 | yt-dlp quality for lossy codecs: 0–9 or a bitrate like 192K. |
max_height | best | Cap video resolution (e.g. 1080). |
container | mp4 | mp4 or mkv for video. |
target_path | env YTDLP_TARGET_PATH | Destination for audio. Use /path for local, host:/path for SSH, or remote:path or rclone:remote:/path for rclone. |
video_target_path | env YTDLP_VIDEO_TARGET_PATH → target_path | Destination for video when it should land somewhere different from audio. Same target forms. |
keep_local | false | Keep the local staging copy after transfer. |
use_archive | false | Record + skip already-downloaded IDs (per mode). |
plex_playlist | env YTDLP_PLEX_PLAYLIST → yt-dlp Downloads when Plex is configured | Plex playlist title or ID to add downloaded audio tracks to. Requires YTDLP_PLEX_URL and YTDLP_PLEX_TOKEN. |
response_format | markdown | markdown or json. |
When Plex credentials are configured, successful downloads that produced audio files search Plex for each downloaded track, create the target playlist if needed, and add missing tracks while skipping entries already present. The default playlist is yt-dlp Downloads; set YTDLP_PLEX_PLAYLIST or pass plex_playlist to override it. Plex errors are reported as plex_playlist_error and do not make the completed download fail. JSON responses include a plex_playlist summary with matched, added, already_present, and missing counts.
Canonical metadata matching through MusicBrainz/AcoustID is documented in docs/musicbrainz-acoustid.md. youtube_download automatically runs high-confidence MusicBrainz retagging for downloaded audio when YTDLP_ACOUSTID_CLIENT_KEY is configured; youtube_identify remains available for previewing or repairing existing library files, with manual tag writes enabled by write_tags=true.
youtube_download JSON response
With response_format=json, the call returns a single object describing the batch:
| Field | Meaning |
|---|---|
transferred | true if every produced subtree reached its target. |
transfer_error | null on success, else the failure/timeout message (string). |
target_path / destination / destinations | The per-kind target destination(s) actually used. |
staging_kept_at | Local staging path retained for retry (set when the transfer failed or keep_local was requested). |
total_files / total_bytes / total_size | Aggregate counts across all items. |
partial_items | Count of items that errored but still produced files. |
failed_items | Count of items that errored and produced no files. |
items[] | Per-URL results, each with a status, title, video_id, error, and a files[] list. |
Each items[].status is one of:
ok— succeeded with files.partial— an error occurred but some files were still produced.failed— errored with no files.skipped— nothing new (already in the archive).
Optional keys are attached only when the relevant stage ran:
metadata_retag— MusicBrainz/AcoustID auto-retag summary (attempted,matched,written,skipped,errors, or anerrorstring); present whenYTDLP_ACOUSTID_CLIENT_KEYis configured.plex_playlist— Plex playlist summary (playlist,matched,added,already_present,missing);plex_playlist_erroris set instead if the Plex update failed (a Plex failure does not fail the download).history_error— set when the download succeeded but the JSONL ledger append failed.
youtube_probe takes urls and response_format.
youtube_plex_playlist
Build or preview Plex audio playlists from successful ytdl-rmcp download history.
Actions:
| Action | Meaning |
|---|---|
list_candidates | Return audio candidates from history entries where transferred is true. |
preview | Resolve selected candidates against Plex without mutating Plex. |
apply | Add selected candidates to a Plex audio playlist idempotently. |
Candidates are history-derived and audio-only. Failed or retained-staging transfers are intentionally excluded.
apply can return plexamp_url, plex_web_url, and playback_link_status. plexamp_url is a best-effort generated listen.plex.tv playback link, not an official Plexamp API guarantee. The regular Plex playlist API calls use the official Plex Media Server API.
youtube_transfer_queue
List and drain server-created transfer failure manifests.
Actions:
| Action | Meaning |
|---|---|
list | Show pending retained-staging transfer manifests. |
retry | Retry one manifest by opaque manifest_id. |
retry_all | Retry all pending manifests. |
prune | Remove manifests whose staging directory is gone. |
The queue never accepts arbitrary filesystem paths. Retry uses the original target paths recorded at failure time and re-checks local target policy before transfer. Manifests are created by the local s