Vlc MCP Server

🚀 VLC MCP サーバ

VLCメディアプレイヤーを使用して映画を再生および制御するModel Context Protocol (MCP) サーバです。
任意のMCPクライアント（例：awesome-mcp-clients）を使用して、リモートでビデオ再生を制御できます。

私は古いノートパソコンで動作するsignal-mcp-clientを使用し、それを介してプロジェクターに接続しています。
これにより、シグナルメッセージを送信するだけで映画を再生できます。下図は使用方法の一例を示しています。

🚀 クイックスタート

このセクションでは、VLC MCPサーバの基本的なセットアップと使用方法を説明します。

📦 インストール

このインストール手順は、UbuntuまたはDebianベースのLinuxシステム（例：Raspberry Pi OS）で動作します。適切な変更を加えれば、他のシステムでも動作するはずです。他のシステムで成功した場合は、ぜひプルリクエストを提出してください。

1. VLC、mediainfo、uvをインストールします。

   sudo apt-get install vlc mediainfo
   curl -LsSf https://astral.sh/uv/install.sh | sh
   

2. VLC HTTPサーバを起動します。

   export DISPLAY=:0 # リモートサーバで実行する場合はこの変数を設定する必要があります
   vlc --extraintf=http --http-host=localhost --http-port=8081 --http-password=your_password
   

3. MCPクライアントをVLC HTTPインターフェースと通信するように設定します。例えば、config.jsonに以下の内容を追加します。

   {
     "vlc": {
       "host": "localhost",
       "port": 8081,
       "password": "your_password"
     }
   }
   

4. MCPクライアントを使用してVLCプレーヤーを制御します。例えば、以下のコマンドを送信してメディアを再生します。

   mcpctl send vlc.play "media_url"
   

💻 使用例

基本的な使用法

# メディアを再生する例
mcpctl send vlc.play "media_url"

🤝 貢献ガイド

どんな貢献も大歓迎です！問題を見つけた場合は、GitHubでイシューやプルリクエストを提出してください。

• エラー報告：Issuesページでエラーを報告してください。
• 機能リクエスト：同じくIssuesページで新機能のリクエストを行ってください。
• コード貢献：リポジトリをForkしてブランチで変更を加え、プルリクエストを作成してください。

🛠️ 開発ガイド

1. コードのフォーマット： Pythonコードをblackでフォーマットします。

   black .
   

2. ドキュメントのビルド： sphinx-buildを使用してドキュメントを生成します。

   sphinx-build docs/ docs/_build/
   

3. テスト： ユニットテストを実行して機能が正常に動作することを確認します。

⚙️ システムサービスの設定

システム起動時に自動的にVLC HTTPサーバを起動するには、以下の手順でsystemdサービスを設定します。

1. vlc-http.serviceという名前のファイルを作成し、以下の内容を追加します。

   cat << EOF > "/home/$USER/.config/systemd/user/vlc-http.service"
   [Unit]
   Description=VLC Media Player with HTTP Interface
   After=network.target sound.target
   
   [Service]
   Restart=on-failure
   RestartSec=30
   SyslogIdentifier=vlc-http
   Environment="DISPLAY=:0"
   
   ExecStart=/usr/bin/vlc --extraintf=http --http-host=localhost --http-port=8081 --http-password=your_password
   
   ExecStop=/usr/bin/pkill -f '/usr/bin/vlc --extraintf=http --http-host=localhost --http-port=8081'
   
   [Install]
   WantedBy=default.target
   EOF
   

2. サービスを有効化して起動します。

   systemctl --user daemon-reload
   systemctl --user enable vlc-http.service
   systemctl --user start vlc-http.service
   

3. サービスの状態とログを確認します。

   systemctl --user status vlc-http.service
   journalctl --user -u vlc-http.service -f
   

📄 ライセンス

このプロジェクトはMITライセンスの下でオープンソース化されています。詳細については、LICENSEファイルを参照してください。