Vlc MCP Server

🚀 VLC MCP 服務器

VLC MCP 服務器是一個藉助 VLC 媒體播放器來實現電影播放與控制的 Model Context Protocol (MCP) 服務器。藉助任意 MCP 客戶端（例如 awesome-mcp-clients），就能遠程操控視頻播放。

我使用運行在舊筆記本電腦上的 signal-mcp-client 連接到投影儀，這樣只需發送一條信號消息就能播放電影。以下是使用方法示例：

🚀 快速開始

此安裝適用於運行 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"
   

💻 使用示例

基礎用法

# 安裝依賴
sudo apt-get install vlc mediainfo
curl -LsSf https://astral.sh/uv/install.sh | sh

# 啟動 VLC HTTP 服務器
export DISPLAY=:0
vlc --extraintf=http --http-host=localhost --http-port=8081 --http-password=your_password

# 配置 MCP 客戶端
{
    "vlc": {
        "host": "localhost",
        "port": 8081,
        "password": "your_password"
    }
}

# 播放媒體
mcpctl send vlc.play "media_url"

高級用法

# 若要在系統啟動時自動運行 VLC HTTP 服務器，可配置 systemd 服務
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

# 啟用並啟動服務
systemctl --user daemon-reload
systemctl --user enable vlc-http.service
systemctl --user start vlc-http.service

# 檢查服務狀態和日誌
systemctl --user status vlc-http.service
journalctl --user -u vlc-http.service -f

🤝 貢獻指南

歡迎任何貢獻！如果您發現任何問題，請在 GitHub 上提交問題或拉取請求。

• 報告錯誤：請在 Issues 頁面提交錯誤。
• 功能請求：同樣可以在 Issues 頁面提出新功能的請求。
• 代碼貢獻：請 Fork 倉庫並在您的分支上進行更改，然後創建一個拉取請求。

🛠️ 開發指南

1. 格式化代碼： 使用 black 來格式化 Python 代碼：

   black .
   

2. 構建文檔： 使用 sphinx-build 生成文檔：

   sphinx-build docs/ docs/_build/
   

3. 測試： 運行單元測試以確保功能正常。

📄 許可證

此項目在 MIT 許可證下開源。有關詳細信息，請參閱 LICENSE 文件。