diff --git a/README.md b/README.md index 53ba80b..7e13c76 100644 --- a/README.md +++ b/README.md @@ -91,24 +91,113 @@ Integrate yt-dlp with Claude, Dive, and other MCP-compatible AI systems. Downloa -### Quick Setup with Dive Desktop +### Getting Started -1. Open [Dive Desktop](https://github.com/OpenAgentPlatform/Dive) -2. Click **"+ Add MCP Server"** -3. Paste this configuration: +Add the following config to your MCP client: ```json { "mcpServers": { "yt-dlp": { "command": "npx", - "args": ["-y", "@kevinwatt/yt-dlp-mcp"] + "args": ["-y", "@kevinwatt/yt-dlp-mcp@latest"] } } } ``` -4. Click **"Save"** and you're ready! 🎉 +### MCP Client Configuration + +
+Dive + +1. Open [Dive Desktop](https://github.com/OpenAgentPlatform/Dive) +2. Click **"+ Add MCP Server"** +3. Paste the config provided above +4. Click **"Save"** and you're ready! + +
+ +
+Claude Code + +Use the Claude Code CLI to add the yt-dlp MCP server ([guide](https://docs.anthropic.com/en/docs/claude-code/mcp)): + +```bash +claude mcp add yt-dlp npx @kevinwatt/yt-dlp-mcp@latest +``` + +
+ +
+Claude Desktop + +Add to your `claude_desktop_config.json`: + +- macOS: `~/Library/Application Support/Claude/claude_desktop_config.json` +- Windows: `%APPDATA%\Claude\claude_desktop_config.json` +- Linux: `~/.config/Claude/claude_desktop_config.json` + +```json +{ + "mcpServers": { + "yt-dlp": { + "command": "npx", + "args": ["-y", "@kevinwatt/yt-dlp-mcp@latest"] + } + } +} +``` + +
+ +
+Cursor + +Go to `Cursor Settings` -> `MCP` -> `New MCP Server`. Use the config provided above. + +
+ +
+VS Code / Copilot + +Install via the VS Code CLI: + +```bash +code --add-mcp '{"name":"yt-dlp","command":"npx","args":["-y","@kevinwatt/yt-dlp-mcp@latest"]}' +``` + +Or follow the [MCP install guide](https://code.visualstudio.com/docs/copilot/chat/mcp-servers#_add-an-mcp-server) with the standard config from above. + +
+ +
+Windsurf + +Follow the [configure MCP guide](https://docs.windsurf.com/windsurf/cascade/mcp#mcp-config-json) using the standard config from above. + +
+ +
+Cline + +Follow [Cline MCP configuration guide](https://docs.cline.bot/mcp/configuring-mcp-servers) and use the config provided above. + +
+ +
+Warp + +Go to `Settings | AI | Manage MCP Servers` -> `+ Add` to [add an MCP Server](https://docs.warp.dev/knowledge-and-collaboration/mcp#adding-an-mcp-server). Use the config provided above. + +
+ +
+JetBrains AI Assistant + +Go to `Settings | Tools | AI Assistant | Model Context Protocol (MCP)` -> `Add`. Use the config provided above. + +
### Manual Installation @@ -333,7 +422,7 @@ YTDLP_COOKIES_FILE=/path/to/cookies.txt "mcpServers": { "yt-dlp": { "command": "npx", - "args": ["-y", "@kevinwatt/yt-dlp-mcp"], + "args": ["-y", "@kevinwatt/yt-dlp-mcp@latest"], "env": { "YTDLP_COOKIES_FROM_BROWSER": "chrome" } diff --git a/package-lock.json b/package-lock.json index 184a1b1..60f2180 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,12 +1,12 @@ { "name": "@kevinwatt/yt-dlp-mcp", - "version": "0.8.1", + "version": "0.8.2", "lockfileVersion": 3, "requires": true, "packages": { "": { "name": "@kevinwatt/yt-dlp-mcp", - "version": "0.8.1", + "version": "0.8.2", "license": "MIT", "dependencies": { "@modelcontextprotocol/sdk": "0.7.0", diff --git a/package.json b/package.json index 7d21d99..512030f 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "@kevinwatt/yt-dlp-mcp", - "version": "0.8.1", + "version": "0.8.2", "description": "An MCP server implementation that integrates with yt-dlp, providing video and audio content download capabilities (e.g. YouTube, Facebook, Tiktok, etc.) for LLMs.", "keywords": [ "mcp",