README
🚀 MoviePilot - MCP 项目
MoviePilot - MCP 是一款专门为电影爱好者打造的 MCP(MCP 可能指多用途控制面板或其他相关技术术语)服务,它基于 MoviePilot 的 API 构建。此服务旨在提供一个统一的控制台,助力用户管理媒体库、搜索并下载资源,同时监控下载任务的状态。
🚀 快速开始
MoviePilot - MCP 服务基于 MoviePilot API 构建,为用户提供统一控制台,便于管理媒体库、搜索下载资源以及监控下载任务状态。
先决条件
- 操作系统:需具备 Python 3.12+ 环境
- 工具:uv 包管理器
- 基础设施:一个正在运行且可访问的 MoviePilot 服务实例
配置步骤
- 克隆仓库:
git clone https://github.com/Pollo3470/MoviePilot - MCP
cd MoviePilot - MCP
- 创建配置文件:
- 复制
.env.example文件并重命名为.env - 填写必要的配置信息,例如:
- 复制
# .env 示例
MOVIEPILOT_BASE_URL=http://your - moviepilot - ip:3000 # 你的 MoviePilot 地址
# 配置认证方式
MOVIEPILOT_USERNAME=your_moviepilot_username # 你的 MoviePilot 用户名(用于密码认证)
MOVIEPILOT_PASSWORD=your_moviepilot_password # 你的 MoviePilot 密码(用于密码认证)
- 创建开发环境:
uv sync
✨ 主要特性
- 统一控制台:可在一处管理和监控所有媒体相关操作。
- 智能搜索:借助精确和模糊搜索功能,能快速找到所需的电影或电视剧。
- 可扩展性:设计灵活,未来计划提供 SSE 部署方式。
- 安全性:内置安全措施,保障环境和账号的安全。
📦 安装指南
先决条件
- 操作系统:Python 3.12+ 环境
- 工具:uv 包管理器
- 基础设施:一个正在运行且可访问的 MoviePilot 服务实例
配置步骤
- 克隆仓库:
git clone https://github.com/Pollo3470/MoviePilot - MCP
cd MoviePilot - MCP
- 创建配置文件:
- 复制
.env.example文件并重命名为.env - 填写必要的配置信息,例如:
- 复制
# .env 示例
MOVIEPILOT_BASE_URL=http://your - moviepilot - ip:3000 # 你的 MoviePilot 地址
# 配置认证方式
MOVIEPILOT_USERNAME=your_moviepilot_username # 你的 MoviePilot 用户名(用于密码认证)
MOVIEPILOT_PASSWORD=your_moviepilot_password # 你的 MoviePilot 密码(用于密码认证)
- 创建开发环境:
uv sync
💻 使用示例
媒体库管理
添加媒体
通过 API 将新内容添加到媒体库中。
删除媒体
移除不再需要的内容。
搜索媒体
按标题、年份或类别查找特定的电影或电视剧。
下载任务控制
启动下载
开始新的下载任务。
暂停/恢复
临时停止或重新启动正在下载的任务。
删除任务
取消未完成的下载任务。
资源管理
资源搜索
根据 TMDB ID 或豆瓣 ID 查找可下载的种子。
模糊搜索
通过关键词查找资源。
历史记录
查看过去的下载记录。
📚 详细文档
开发状态
当前,项目处于功能逐步接入阶段。未来计划包括提供 SSE 部署方式,以增强服务的扩展性和性能。
安全提示
- 环境安全:确保存储 MoviePilot 账号信息的环境安全。
- 账号安全:建议创建专用账号用于此 MCP 服务器,避免使用管理员账号。
开发指引
先决条件
- 操作系统:Python 3.12+ 环境
- 工具:uv 包管理器
- 基础设施:一个正在运行且可访问的 MoviePilot 服务实例
配置步骤
- 克隆仓库:
git clone https://github.com/Pollo3470/MoviePilot - MCP
cd MoviePilot - MCP
- 创建配置文件:
- 复制
.env.example文件并重命名为.env - 填写必要的配置信息,例如:
- 复制
# .env 示例
MOVIEPILOT_BASE_URL=http://your - moviepilot - ip:3000 # 你的 MoviePilot 地址
# 配置认证方式
MOVIEPILOT_USERNAME=your_moviepilot_username # 你的 MoviePilot 用户名(用于密码认证)
MOVIEPILOT_PASSWORD=your_moviepilot_password # 你的 MoviePilot 密码(用于密码认证)
- 创建开发环境:
uv sync
贡献
欢迎社区贡献!如发现 bug 或有功能建议,请通过仓库 Issues 提交。您的贡献将帮助项目不断改进。
致谢
感谢 MoviePilot 项目的技术支持,使得本 MCP 服务的开发成为可能。
📄 许可证
该项目遵循 [LICENSE] 协议,具体内容请参见项目的 LICENSE 文件。
Scan to contact