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"
   

贡献指南

欢迎任何贡献！如果您发现任何问题，请在GitHub上提交问题或拉取请求。

• 报告错误：请在Issues页面提交错误。
• 功能请求：同样可以在Issues页面提出新功能的请求。
• 代码贡献：请 Fork 仓库并在您的分支上进行更改，然后创建一个拉取请求。

开发指南

1. 格式化代码： 使用black来格式化Python代码：

   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文件。