@felores/mcp-video 0.5.3 → 0.5.4

package/.prettierrc

@@ -1,3 +1,3 @@
-{
-  "endOfLine": "auto"
-}
+{
+  "endOfLine": "auto"
+}

package/CODE_OF_CONDUCT.md

@@ -1,49 +1,49 @@
-# Contributor Code of Conduct
-
-As contributors and maintainers of this project, and in the interest of
-fostering an open and welcoming community, we pledge to respect all people who
-contribute through reporting issues, posting feature requests, updating
-documentation, submitting pull requests or patches, and other activities.
-
-We are committed to making participation in this project a harassment-free
-experience for everyone, regardless of level of experience, gender, gender
-identity and expression, sexual orientation, disability, personal appearance,
-body size, race, ethnicity, age, religion, or nationality.
-
-Examples of unacceptable behavior by participants include:
-
-- The use of sexualized language or imagery
-- Personal attacks
-- Trolling or insulting/derogatory comments
-- Public or private harassment
-- Publishing other's private information, such as physical or electronic
-  addresses, without explicit permission
-- Other unethical or unprofessional conduct
-
-Project maintainers have the right and responsibility to remove, edit, or
-reject comments, commits, code, wiki edits, issues, and other contributions
-that are not aligned to this Code of Conduct, or to ban temporarily or
-permanently any contributor for other behaviors that they deem inappropriate,
-threatening, offensive, or harmful.
-
-By adopting this Code of Conduct, project maintainers commit themselves to
-fairly and consistently applying these principles to every aspect of managing
-this project. Project maintainers who do not follow or enforce the Code of
-Conduct may be permanently removed from the project team.
-
-This Code of Conduct applies both within project spaces and in public spaces
-when an individual is representing the project or its community.
-
-Instances of abusive, harassing, or otherwise unacceptable behavior may be
-reported by contacting a project maintainer at anais@anaisbetts.org. All
-complaints will be reviewed and investigated and will result in a response that
-is deemed necessary and appropriate to the circumstances. Maintainers are
-obligated to maintain confidentiality with regard to the reporter of an
-incident.
-
-This Code of Conduct is adapted from the [Contributor Covenant][homepage],
-version 1.3.0, available at
-[http://contributor-covenant.org/version/1/3/0/][version]
-
-[homepage]: http://contributor-covenant.org
-[version]: http://contributor-covenant.org/version/1/3/0/
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+- The use of sexualized language or imagery
+- Personal attacks
+- Trolling or insulting/derogatory comments
+- Public or private harassment
+- Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+- Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at anais@anaisbetts.org. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

package/COPYING

@@ -1,7 +1,7 @@
-Copyright (c) 2024 Anaïs Betts
-
-Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+Copyright (c) 2024 Anaïs Betts
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -1,207 +1,186 @@
-# Video MCP Server
-
-A powerful Model Context Protocol (MCP) server that enables AI assistants like Claude to work with video content. This server provides capabilities for downloading video transcripts in plain text and videos from various platforms including YouTube, Vimeo, Twitter/X, and TikTok.
-
-This project is a fork from anaisbetts/mcp-youtube which only outputs the transcript with timestamps. This project outputs the transcript in plain text without timestamps for easy LLM consumption and adds the download tool.
-
-## Features
-
-- Download and process video subtitles/closed captions for AI analysis
-- Download videos in high quality (up to 1080p)
-- Support for multiple platforms:
-  - YouTube
-  - Vimeo
-  - Twitter/X
-  - TikTok
-  - And more platforms supported by yt-dlp
-
-## MCP Tools
-
-This server provides two powerful tools that can be used by AI assistants through the Model Context Protocol:
-
-### 1. Video Transcript Tool (`get_video_transcript`)
-- Downloads and processes video subtitles/closed captions into plain text format
-- Removes timestamps and formatting for easy AI consumption
-- Supports auto-generated captions when available
-- Works with multiple languages (defaults to English)
-- Input: Video URL from any supported platform
-- Output: Clean, plain text transcript ready for AI analysis
-
-### 2. Video Download Tool (`download_video`)
-- Downloads videos in high quality (limited to 1080p for reasonable file sizes)
-- Automatically selects the best quality format
-- Merges video and audio streams when necessary
-- Saves files to a configurable downloads directory
-- Input: 
-  - Video URL from any supported platform
-  - Optional filename (recommended format: platform-id, e.g., 'youtube-MhOTvvmlqLM')
-- Output: 
-  - Downloaded video file in MP4 format
-  - File information including title, duration, resolution, and file size
-
-## Prerequisites
-
-### Node.js and npm
-
-1. Install Node.js (version 18 or higher) and npm from [nodejs.org](https://nodejs.org/)
-2. Verify installation:
-   ```bash
-   node --version
-   npm --version
-   ```
-
-### Installing yt-dlp
-
-The server requires `yt-dlp` to be installed on your system. Here are the installation methods for different platforms:
-
-#### Windows
-1. Using WinGet (Recommended):
-   ```powershell
-   winget install yt-dlp
-   ```
-2. Using Scoop:
-   ```powershell
-   scoop install yt-dlp
-   ```
-3. Manual Installation:
-   - Download the latest release from [yt-dlp releases](https://github.com/yt-dlp/yt-dlp/releases)
-   - Place the executable in a directory in your PATH
-
-#### macOS
-1. Using Homebrew:
-   ```bash
-   brew install yt-dlp
-   ```
-2. Using MacPorts:
-   ```bash
-   sudo port install yt-dlp
-   ```
-
-#### Linux
-1. Using package manager:
-   ```bash
-   # On Debian/Ubuntu
-   sudo apt install yt-dlp
-   
-   # On Fedora
-   sudo dnf install yt-dlp
-   
-   # On Arch Linux
-   sudo pacman -S yt-dlp
-   ```
-2. Using pip:
-   ```bash
-   python3 -m pip install -U yt-dlp
-   ```
-
-## Installation and Setup
-
-### Option 1: Direct Installation (Recommended for Users)
-
-Install the MCP server using the [mcp-installer](https://github.com/anaisbetts/mcp-installer):
-```bash
-# Install mcp-installer if you haven't already
-npm install -g @anaisbetts/mcp-installer
-
-# Install this MCP server
-mcp-installer install @felores/mcp-video
-```
-
-### Option 2: Manual Installation (Recommended for Developers)
-
-1. Clone the repository:
-   ```bash
-   git clone https://github.com/felores/mcp-video.git
-   cd mcp-video
-   ```
-
-2. Install dependencies:
-   ```bash
-   npm install
-   ```
-
-3. Build the project:
-   ```bash
-   npm run build
-   ```
-
-4. Start the server:
-   ```bash
-   npm start
-   ```
-
-## Usage
-
-Once installed, you can use this server through any MCP-compatible client (like Claude.ai). Here are some example prompts:
-
-1. To analyze a video's content:
-   ```
-   Summarize the YouTube video https://youtube.com/watch?v=VIDEO_ID
-   ```
-
-2. To get specific information:
-   ```
-   What are the main points discussed in this video: https://youtube.com/watch?v=VIDEO_ID
-   ```
-
-The server will automatically:
-1. Download the video's subtitles/closed captions
-2. Process and clean the text
-3. Make it available to the AI assistant for analysis
-
-## Environment Variables
-
-- `DOWNLOADS_DIR`: Specify a custom directory for downloaded videos (default: `./downloads`)
-
-## Development
-
-### Setting Up Development Environment
-
-1. Fork and clone the repository:
-   ```bash
-   git clone https://github.com/YOUR_USERNAME/mcp-video.git
-   cd mcp-video
-   ```
-
-2. Install development dependencies:
-   ```bash
-   npm install
-   ```
-
-3. Build the project:
-   ```bash
-   npm run build
-   ```
-
-4. Start the development server:
-   ```bash
-   npm start
-   ```
-
-### Running Tests
-```bash
-npm test
-```
-
-### Making Changes
-1. Create a new branch:
-   ```bash
-   git checkout -b feature/your-feature-name
-   ```
-
-2. Make your changes and commit:
-   ```bash
-   git add .
-   git commit -m "Description of changes"
-   ```
-
-3. Push to your fork:
-   ```bash
-   git push origin feature/your-feature-name
-   ```
-
-4. Create a Pull Request from your fork to the main repository
-
-## License
-
-MIT License - See [COPYING](COPYING) for details.
+# Video MCP Server
+
+A powerful Model Context Protocol (MCP) server that enables AI assistants like Claude to work with video content. This server provides capabilities for downloading video transcripts in plain text and videos from various platforms including YouTube, Vimeo, Twitter/X, and TikTok.
+
+This project is a fork from anaisbetts/mcp-youtube which only outputs the transcript with timestamps. This project outputs the transcript in plain text without timestamps for easy LLM consumption and adds the download tool.
+
+## Features
+
+- Download and process video subtitles/closed captions for AI analysis
+- Download videos in high quality (up to 1080p)
+- Support for multiple platforms:
+  - YouTube
+  - Vimeo
+  - Twitter/X
+  - TikTok
+  - And more platforms supported by yt-dlp
+
+## Prerequisites
+
+Before installing the MCP server, make sure you have the following prerequisites:
+
+### 1. yt-dlp (Required)
+
+The server requires [yt-dlp](https://github.com/yt-dlp/yt-dlp) to be installed on your system first. Here are the installation methods for different platforms:
+
+#### Windows
+Using WinGet (Recommended):
+   ```powershell
+   winget install yt-dlp
+   ```
+#### macOS
+Using Homebrew:
+   ```bash
+   brew install yt-dlp
+   ```
+#### Linux
+Using package manager:
+   ```bash
+   sudo apt install yt-dlp
+   ```
+
+### 2. Node.js and npm
+
+1. Install Node.js (version 18 or higher) and npm from [nodejs.org](https://nodejs.org/)
+2. Verify installation:
+   ```bash
+   node --version
+   npm --version
+   ```
+
+## Installation and Setup
+
+After installing the prerequisites above, you can install the MCP server using one of these methods:
+
+### Option 1: NPX Installation (Recommended)
+
+Add the following to your `claude_desktop_config.json`:
+
+```bash
+{
+  "mcpServers": {    
+    "video": {
+      "command": "npx",
+      "args": [
+        "@felores/mcp-video"
+      ],
+      "env": {
+        "DOWNLOADS_DIR": "path/to/downloads"
+      }
+    }
+  }
+}
+```
+Replace `path/to/downloads` with the path to your desired downloads directory.
+
+This will automatically install and run the latest version of the server.
+
+### Option 2: Using MCP Installer
+
+Install the [mcp-installer](https://github.com/anaisbetts/mcp-installer), restart Claude, and prompt claude to install the Video MCP Server:
+```bash
+Install @felores/mcp-video with environment DOWNLOADS_DIR set to path/to/downloads
+```
+Modify path/to/downloads to your desired downloads directory system path.
+
+### Option 3: Manual Installation (For Developers)
+
+1. Clone the repository:
+   ```bash
+   git clone https://github.com/felores/mcp-video.git
+   cd mcp-video
+   ```
+
+2. Install dependencies:
+   ```bash
+   npm install
+   ```
+
+3. Build the project:
+   ```bash
+   npm run build
+   ```
+
+4. Start the server:
+   ```bash
+   npm start
+   ```
+
+Add the following to your `claude_desktop_config.json`:
+
+```bash
+{
+"mcpServers": {    
+   "video": {
+      "command": "node",
+      "args": ["path/to/mcp-video/lib/index.mjs"],
+      "env": {
+        "DOWNLOADS_DIR": "path/to/downloads"
+      }
+    }
+  }
+}
+```
+## Usage
+
+## MCP Tools
+
+This server provides two powerful tools that can be used by AI assistants through the Model Context Protocol:
+
+### 1. Video Transcript Tool (`get_video_transcript`)
+- Downloads and processes video subtitles/closed captions into plain text format
+- Removes timestamps and formatting for easy AI consumption
+- Supports auto-generated captions when available
+- Works with multiple languages (defaults to English)
+- Input: Video URL from any supported platform
+- Output: Clean, plain text transcript ready for AI analysis
+
+### 2. Video Download Tool (`download_video`)
+- Downloads videos in high quality (limited to 1080p for reasonable file sizes)
+- Automatically selects the best quality format
+- Merges video and audio streams when necessary
+- Saves files to a configurable downloads directory
+- Input: 
+  - Video URL from any supported platform
+  - Optional filename (recommended format: platform-id, e.g., 'youtube-MhOTvvmlqLM')
+- Output: 
+  - Downloaded video file in MP4 format
+  - File information including title, duration, resolution, and file size
+
+Once installed, you can use this server through any MCP-compatible client (like Claude.ai). Here are some example prompts:
+
+1. To analyze a video's content:
+   ```
+   Summarize the YouTube video https://youtube.com/watch?v=VIDEO_ID
+   ```
+
+2. To get specific information:
+   ```
+   What are the main points discussed in this video: https://youtube.com/watch?v=VIDEO_ID
+   ```
+
+The server will automatically:
+1. Download the video's subtitles/closed captions
+2. Process and clean the text
+3. Make it available to the AI assistant for analysis
+
+## Environment Variables
+
+- `DOWNLOADS_DIR`: Specify a custom directory for downloaded videos (default: `./downloads`)
+
+## Reference
+
+### Supported Platforms
+- YouTube
+- Vimeo
+- Twitter/X
+- TikTok
+- And any platform supported by [yt-dlp](https://github.com/yt-dlp/yt-dlp/blob/master/supportedsites.md)
+
+### Dependencies
+- [yt-dlp](https://github.com/yt-dlp/yt-dlp) - Video downloader
+- [Model Context Protocol](https://github.com/anaisbetts/mcp) - AI communication protocol
+
+## License
+
+MIT License - See [COPYING](COPYING) for details.