MoviePilot/docs/mcp-api.md

MoviePilot MCP (Model Context Protocol) API 文档

MoviePilot 实现了标准的 Model Context Protocol (MCP)，允许 AI 智能体（如 Claude, GPT 等）直接调用 MoviePilot 的功能进行媒体管理、搜索、订阅和下载。

1. 基础信息

• 基础路径: /api/v1/mcp
• 协议版本: 2025-11-25, 2025-06-18, 2024-11-05
• 传输协议: HTTP (JSON-RPC 2.0)
• 认证方式:
  • Header: X-API-KEY: <你的API_KEY>
  • Query: ?apikey=<你的API_KEY>

安全提示

MCP 使用系统配置中的 API_TOKEN 作为认证密钥，文档中的 API KEY 是请求字段名。该密钥应按管理员级 secret 保管，持有者可作为受信第三方集成调用暴露的 MoviePilot 工具。

• 优先使用 X-API-KEY 请求头；查询参数更容易出现在代理、浏览器或客户端日志中。
• 不要在缺少 HTTPS、访问控制和网络隔离的情况下，将 MCP、OpenAI 或 Anthropic 兼容接口直接暴露到公网。
• MCP 隐藏工具列表只用于减少默认暴露面，不是 per-user 权限系统。

2. 标准 MCP 协议 (JSON-RPC 2.0)

端点

POST /api/v1/mcp

支持的方法

• initialize: 初始化会话，协商协议版本和能力。
• notifications/initialized: 客户端确认初始化完成。
• tools/list: 获取可用工具列表。
• tools/call: 调用特定工具。
• ping: 连接存活检测。

动态插件工具

tools/list 会同时返回 MoviePilot 内置工具和已启用插件通过 get_agent_tools() 声明的工具。插件启动、停止、重载或配置生效后，MCP 工具管理器会在下一次列出或调用工具时按注册表版本惰性刷新，避免继续暴露已移除的工具或遗漏新工具。

MCP 当前不会主动发送工具列表变更通知（listChanged=false）。如果客户端缓存了工具列表，插件状态变化后需要让客户端重新请求 tools/list；无法手动刷新的客户端应重新连接 MCP 服务或新建会话。

3.1 结构化 Agent 工具与完整参数合同

tools/list 会为以下四个正式入口返回可直接校验的 JSON Schema。每个入口都按 operation/action 生成 oneOf 分支，分支中包含必填字段、类型、默认值、枚举、嵌套对象和互斥/至少一项等跨字段规则；外部 MCP 客户端可以在一次 tools/call 中完成参数构造，不需要猜测 URL、HTTP 方法或第三方 SDK 参数。

MCP 工具	用途	参数合同来源
moviepilot_api	MoviePilot 产品业务 API：媒体、搜索、订阅、下载、整理、站点、存储、调度、工作流、插件、过滤规则和系统配置	skills/moviepilot-api/SKILL.md；运行时 schema 为 app/agent/policy/resources/api_mcp_schema.json
downloader_operation	qBittorrent、Transmission、rTorrent 原生任务、队列、文件、限速、标签和会话操作	skills/downloader-operation/SKILL.md 与 skills/downloader-operation/scripts/mp-downloader.py 的 ACTIONS
mediaserver_operation	Emby、Jellyfin、Plex、ZSpace、UGREEN、TrimeMedia、Navidrome 原生媒体库、搜索、播放、扫描和刷新操作	skills/mediaserver-operation/SKILL.md 与 skills/mediaserver-operation/scripts/mp-mediaserver.py 的 ACTIONS
database_operation	MoviePilot 配置数据库表清单、实时 schema、只读 SQL 和明确授权写入	skills/database-operation/SKILL.md 与 skills/database-operation/scripts/mp-db.py 的 ACTIONS

这四个工具都要求管理员级 MCP 集成身份；tools/list 的可见性不等于绕过业务权限或写操作确认。下载器和媒体服务器工具会在一次调用内自动选择默认/唯一实例；实例不明确时，错误结果会列出可复用的精确实例名。数据库工具不接受任意连接串或凭据，脚本从 MoviePilot 运行时配置读取数据库连接。

app/agent/policy/resources/api_mcp_schema.json 是 moviepilot_api 的生成制品，不是设置项或 API 参数的手工事实源。scripts/generate_agent_api_mcp_schema.py 从当前 FastAPI OpenAPI、固定 operation 路由和 Agent 专用英文参数说明生成该文件；运行时直接读取它响应外部 MCP tools/list，测试会校验生成结果没有漂移。修改 API、请求模型或 operation 后应重新生成并提交该文件，不应直接编辑 JSON。

当前完整 FastAPI OpenAPI 包含 375 个 HTTP 操作，其中 203 个稳定业务操作进入 moviepilot_api，使用 201 个固定路由模板：200 条 OpenAPI 路由直接匹配，另有 1 条只允许 tmdb、douban、bangumi、anilist 四个来源的受限人物作品动态路由。每个 operation 均同时具备固定 method/path、角色权限、副作用等级、确认与恢复策略、结果敏感性、英文用途说明， 以及可直接提交的 path/query/body JSON Schema；Skill front matter、正文 operation 章节、运行时 注册表和 MCP tools/list 的 203 个 oneOf 分支必须完全一致。

数量不相等是明确的安全与语义边界，而不是漏生成。当前 375 条路由均被审计并锁定为以下一种 归属，审计生成器不再提供“未归类”兜底：

归属	数量	Agent 使用方式
gateway	200	通过 moviepilot_api 的稳定 operation 和精确参数合同调用
consolidated	72	通过同领域聚合 operation 调用，不复制数据源或前端专用路由
provider-skill	11	通过下载器或媒体服务器 Skill 调用第三方 provider API
alternate-auth-duplicate	11	使用对应 bearer-authenticated gateway operation，不暴露 API_TOKEN 兼容副本
transport_or_identity	66	由登录、令牌、MCP、会话、回调、健康检查等宿主传输/身份边界拥有
stream_or_binary	10	由直接客户端处理流式日志、消息、文件、图片等非结构化响应
ui_presentation	5	由前端或插件渲染面拥有，不作为业务 Agent operation

逐路由归属见 docs/architecture/agent-api-surface-audit.md，并由 tests/test_agent_api_surface_audit.py 对当前 OpenAPI、固定注册表、MCP schema、英文 Skill 合同及全部非网关归属做漂移检查。任何新增端点必须先明确归属；对 Agent 开放时还必须补齐 operation ID、权限、副作用、确认、恢复、结果敏感性及精确参数说明。

moviepilot_api 调用形状

{
  "name": "moviepilot_api",
  "arguments": {
    "operation_id": "subscription.list",
    "path_params": {},
    "query": {"page": 1, "count": 20},
    "body": {}
  }
}

只允许传 tools/list 对应 operation 分支中声明的 path_params、query 和 body 字段。不得传 URL、认证头、API Token 或任意 HTTP 方法。

查询结果的兼容分页合同如下：

• 原先返回完整列表、没有分页参数的接口会在端点签名、OpenAPI、Skill 和 MCP oneOf 中显式声明可选 page / count；page 必须不小于 1，count 范围为 1 到 200。两者都省略时仍返回原来的完整列表，不启用分页；显式传入任一参数时才分页，缺失的 page 按 1、缺失的 count 按 50 处理。FastAPI 的 response 注入对象不是业务输入，不会出现在 REST、Skill 或 MCP 参数中。
• 数据库列表在查询层先应用授权范围和业务筛选，再执行稳定排序、LIMIT/OFFSET 和同条件精确 COUNT；不得先全表加载、响应后切片。纯内存、配置、缓存、文件系统或运行时列表可以在序列化边界切片。已有 max_results 等原生限量参数的接口继续支持显式限量；原生限量参数默认值为 None 时，省略所有分页和限量参数仍返回完整列表，显式 page/count 的优先级由端点合同说明。
• REST 响应的 data 保持原列表结构，不改成 {items,total}。X-Result-Count 报告本次实际返回数量；仅当 MoviePilot 已经取得完整筛选结果时，才增加精确的 X-Total-Count。原有结构化分页接口继续在既有 data.total 与 data.items / data.list 中返回总数。
• moviepilot_api 把这些响应头投影为响应中的附加 collection 对象：result_count 为本次返回数量，total_count 仅在精确可知时出现，page / count 在可用时出现。collection 是附加元数据，不替换或改写 data。
• Agent 仅查询数量或摘要时，应对支持精确总数的列表发送最小窗口；兼容分页接口使用 page=1,count=1，然后直接读取 collection.total_count。即使列表内容触发 64KB 工具预览截断，网关也会把 collection 放在 data 前面，确保总数仍可见；不得因为条目被截断就回退到数据库统计。
• 已经由第三方接口原生分页或限量、但上游没有返回总数的查询不会伪造 total_count；Agent 应以 result_count 判断当前页是否为空，并按原接口的分页参数继续读取。

downloader_operation / mediaserver_operation 调用形状

{
  "name": "downloader_operation",
  "arguments": {
    "client": "main-qb",
    "action": "tasks.list",
    "arguments": {
      "status": "downloading",
      "offset": 0,
      "limit": 20
    }
  }
}

媒体服务器将顶层实例字段改为 server，其余结构相同。client/server 可省略；具体 action 的 arguments 必须严格匹配对应 oneOf 分支。

database_operation 调用形状

{
  "name": "database_operation",
  "arguments": {
    "action": "query",
    "arguments": {
      "sql": "SELECT title, year FROM downloadhistory ORDER BY id DESC",
      "limit": 20,
      "write": false
    }
  }
}

数据库 action 参数为：

• tables：无参数，列出当前数据库实际表。
• schema：必填 table_name，必须使用 tables 返回的精确名称。
• query：sql 与 file 二选一；可选 limit（默认 100）和 write（默认 false）。默认只允许 SELECT、WITH、EXPLAIN。
• write：sql 与 file 二选一，只允许单条写入或结构变更语句；必须已有明确授权。

数据库 ORM 当前维护的完整表清单与字段基线见 skills/database-operation/SKILL.md 的 Core Tables；运行时仍应先调用 schema，因为实际部署可能存在迁移差异或插件表。

系统设置、配置变量与数据库配置

系统设置统一使用 moviepilot_api，不需要恢复旧的 query_system_settings / update_system_settings 工具：

• config.system.get 同时查询 Settings 运行配置变量和 SystemConfigKey 数据库配置。可用 setting_key 精确读取，或用 group + keyword 发现键；单项默认返回完整值，多项默认只返回摘要。
• 每个发现结果都返回动态 definition：声明类型、当前值形状、是否可空/敏感、允许的更新操作、列表默认匹配字段和持久化位置。Agent 应先发现定义，再按返回的精确键和形状调用更新。
• config.system.update 支持 replace、merge_dict、upsert_list_item、remove_list_item。Settings 字段会执行类型转换并持久化到 app.env；SystemConfigKey 会经配置服务写入数据库并发布配置变更事件。
• 敏感值默认脱敏；只有管理员明确要求时才传 query.show_secrets=true，并继续受宿主确认和保护输出策略约束。
• database_operation 直接修改 systemconfig 只用于受控数据修复。普通配置修改不得绕过键注册、类型转换、插件 mutation 门禁和事件通知。

skills/moviepilot-api/SKILL.md 只维护稳定的发现与更新流程，不复制当前版本全部 Settings / SystemConfigKey 清单。真实键、类型和值形状由 config.system.get 运行时发现；MCP tools/list 的 config.system.get/update 分支负责说明发现参数和更新请求结构。

---

4. 客户端配置示例

Claude Desktop (Anthropic)

在Claude Desktop的配置文件中添加MoviePilot的MCP服务器配置：

macOS: ~/Library/Application Support/Claude/claude_desktop_config.json
Windows: %APPDATA%\Claude\claude_desktop_config.json

使用请求头方式：

{
  "mcpServers": {
    "moviepilot": {
      "url": "http://localhost:3001/api/v1/mcp",
      "headers": {
        "X-API-KEY": "your_api_key_here"
      }
    }
  }
}

或使用查询参数方式：

{
  "mcpServers": {
    "moviepilot": {
      "url": "http://localhost:3001/api/v1/mcp?apikey=your_api_key_here"
    }
  }
}

4.1 Agent 外部 MCP Client 配置

MoviePilot 的内置 Agent 也可以作为 MCP Client 连接外部 MCP 服务器，将外部工具注入到智能助手工具列表中。当前支持：

• stdio：按配置的命令和参数启动本地 MCP 进程，通过标准输入输出交换 JSON-RPC 消息。
• sse：连接旧版 HTTP+SSE MCP 服务，先读取 endpoint 事件，再向返回的 endpoint POST JSON-RPC 消息。
• http / streamable_http：连接 Streamable HTTP MCP 服务，直接向配置 URL POST JSON-RPC 消息。

这些配置是管理员级 Agent 运行时配置，保存在 SystemConfigKey.AIAgentMcpServers 中。外部 MCP 工具默认要求管理员上下文调用，避免普通用户触发高权限外部工具。

Agent MCP 配置接口

这些接口使用登录态鉴权，并要求当前用户为超级管理员。

方法	路径	说明
GET	/api/v1/message/agent/mcp/servers	查询已配置的外部 MCP 服务器列表
POST	/api/v1/message/agent/mcp/servers	保存外部 MCP 服务器列表
POST	/api/v1/message/agent/mcp/servers/test	测试单个外部 MCP 服务器，返回发现的工具列表

5. 错误码说明

错误码	消息	说明
-32700	Parse error	JSON 格式错误
-32600	Invalid Request	无效的 JSON-RPC 请求
-32601	Method not found	方法不存在
-32602	Invalid params	参数验证失败
-32002	Session not found	会话不存在或已过期
-32003	Not initialized	会话未完成初始化流程
-32603	Internal error	服务器内部错误

6. RESTful API

HTTP 工具管理端点统一位于 /api/v1/mcp，并与标准 MCP JSON-RPC 端点共享同一最终工具目录。

相关 REST 端点

MoviePilot 也提供普通 REST API 给前端和自动化客户端使用。所有接口同样需要 API KEY 认证，在请求头中添加 X-API-KEY: <api_key> 或在查询参数中添加 apikey=<api_key>。

REST API 版本

• 普通 JSON REST 接口统一使用 /api/v1，不再提供 /api/v2 套壳版本。
• 成功和失败响应都只包含 success、message、data 三个顶层字段；各接口只有 data 的模型可以变化。
• 成功响应为 {"success": true, "message": "", "data": <接口数据>}。HTTP 错误保留原状态码，返回 {"success": false, "message": <错误原因>, "data": null}；请求参数校验错误会在 data 中附带结构化错误列表。
• 查询接口未命中但请求已正常完成时仍返回 success=true，存在性等业务状态通过 data 表达。例如 /mediaserver/exists 未命中时返回空的 data.item。
• 每个普通 JSON 端点都会在 OpenAPI 中声明具体的 Response[DataModel]，调用方可从 /docs 或 /api/v1/openapi.json 查询数据结构。
• SSE、文件、图片、HTML、空响应，以及 OAuth2 登录、OpenAI、Anthropic、MCP JSON-RPC 等标准协议端点保持协议原生响应体；它们会在 OpenAPI 中显式声明对应的流、文件或协议模型。
• 插件通过 get_api() 动态注册的 /api/v1/plugin/... 端点不属于主程序统一响应信封范围。插件自行声明响应模型、状态码和返回体，宿主只补充路径与鉴权依赖。

客户端可发送 X-MoviePilot-Locale: zh-CN|zh-TW|en-US 或 Accept-Language。后端会按当前请求语言直接翻译顶层 message；未提供语言头时使用简体中文，翻译缺失时回退原文本。SSE 和业务数据中原有的 text_i18n、error_i18n 等展示字段继续保留。

GET /api/v1/login/wallpaper 会将壁纸 URL 放在 data 字段中。POST /api/v1/user/avatar/{user_id} 会以 data.filename 返回原始文件名。上述接口的 message 均不承载业务数据。

FastAPI 的 HTTP 异常和参数校验异常统一使用 message，不再返回顶层 detail / detail_i18n。

交互式接口文档 /docs 读取 /api/v1/openapi.json，页面版本号直接使用 version.py 中的后端 APP_VERSION。

系统更新

系统 Release 更新采用“检查、后台下载、确认安装”三阶段流程，以下接口均要求超级管理员登录态。后台每 6 小时自动检查一次稳定版 v3 GitHub Release 和站点资源包；升级类型只有 application（主程序，前端版本由后端 Release 中的 version.py 决定）与 resources（认证资源和索引资源）。下载完成前不重启服务，安装接口只消费已下载并校验的完整制品，启动器会先应用主程序包，再应用资源包，之后才启动进程；启动后的初始化不会再次下载或触发资源重启。原 Dev 更新入口继续保留，但 /system/upgrade 只接受请求体 "dev"，不再处理 Release 更新。

方法	路径	说明
GET	/api/v1/system/update/status	查询聚合状态及 updates 中两类升级明细的 idle、available、downloading、ready、installing 或 failed 状态，以及版本、字节数和进度
POST	/api/v1/system/update/check	立即检查最新稳定版 v3 Release 和当前平台站点资源包
POST	/api/v1/system/update/download	请求体可传 {"target":"application"} 或 {"target":"resources"}；后台下载并校验对应制品
POST	/api/v1/system/update/install	请求体可传 {"target":"application"} 或 {"target":"resources"}；再次校验对应制品，写入安装意图并重启
POST	/api/v1/system/upgrade	保留 Dev 更新并重启，请求体只能为 "dev"

媒体识别 / 整理

媒体识别、搜索和手动整理统一使用 media_source + media_id 表示媒体主身份。内置来源通过 MediaSource 提供 themoviedb、douban、bangumi、anilist、imdb、tvdb、musicbrainz、theaudiodb、doubanmusic、bilibili、mangguodiscover、migu 和 tencentvideodiscover 等常量；该列表不是插件来源白名单，插件可以注册符合 OpenAPI 格式约束的稳定扩展标识。media_id 是该来源的原生 ID，不添加 tmdb: 等前缀。需要精确身份时两个字段必须同时提供，不能只传其中一个。

影视自动识别在未指定来源时只使用 TMDB，未命中时不会继续查询其它影视源。音乐路径识别严格按 AcoustID 音频指纹、文件标签、文件名三级依次执行；指纹或标签直接提供 MusicBrainz Recording ID 时，会直接查询 MusicBrainz 详情，标签和文件名标题识别也只使用 MusicBrainz。其它元数据源仅在手动操作通过请求级 media_source，或通过完整的 media_source + media_id 精确指定时使用，不修改系统默认值，也不会跨来源兜底。MediaInfo 响应仍可能包含 tmdb_id、douban_id、bangumi_id、anilist_id 等跨源映射辅助字段，但这些字段不是通用请求入口。明确归属 /tmdb、/douban、/bangumi、/anilist 的接口，以及固定使用 TMDB 的剧集组和排期接口，仍可按其单数据源契约接收原生 ID。

方法	路径	说明
GET	/api/v1/media/search	按标题搜索媒体、合集、人物或音乐，参数：title、type、page、count，可重复传入可选 media_source；内置模块只处理自身支持的来源，插件模块可以处理其注册的扩展来源，旧客户端的逗号格式仅在输入边界兼容
GET	/api/v1/media/recognize	识别标题，参数：title、subtitle、custom_words，可选 media_source；当 title 为含目录的媒体文件路径时，会合并父目录中的名称、年份等信息
GET	/api/v1/media/recognize_file	识别文件路径，参数：path，可选 media_source
GET	/api/v1/media/{media_id}	按原生 ID 查询影视或音乐详情；必填参数：media_source、type_name，其中 media_source 与路径中的 media_id 组成统一媒体身份，type_name 支持电影、电视剧和音乐
POST	/api/v1/media/scrape/{storage}	刮削媒体元数据；请求体为 FileItem，可选查询参数 media_source、media_id、type_name（电影/电视剧/音乐）。音乐会按策略处理音频标签、封面和歌词
POST	/api/v1/transfer/manual/target-path	按源文件与目录配置匹配手动整理目标路径；请求体为 ManualTransferItem，该接口不执行媒体识别
POST	/api/v1/transfer/manual/history	查询文件、批量文件或目录命中的成功整理历史摘要，用于进入手动整理界面时显示重新整理状态
POST	/api/v1/transfer/manual	手动整理；请求体可用 media_source + media_id 指定本次识别与刮削数据源；音乐请求未传 music_type 时，目录按 album、文件按 recording 解释；命中失败历史时自动清理旧目标和记录后重试，reorganize=true 时清理命中的成功历史和非移动模式旧目标后重新整理
GET	/api/v1/transfer/tasks/manual-reviews	管理员分页查询 durable 人工复核任务；state 仅允许 manual_review（默认）或已经人工判定、等待调度恢复的 retry_wait，支持 page 与 page_size。响应只公开任务、源文件、状态、步骤意图/证据/错误和复核修订号，不返回 lease 或 attempt 身份
GET	/api/v1/transfer/tasks/{task_id}/manual-review	管理员查询单个 durable 人工复核任务详情；仅可读取 manual_review 或已经人工判定的 retry_wait 任务，其余状态按不存在处理
POST	/api/v1/transfer/tasks/{task_id}/manual-review	管理员判定处于 manual_review 的 durable 整理步骤；请求包含 operation_id、`decision=not_applied

站点

方法	路径	说明
GET	/api/v1/site/media/{media_type}	按媒体类型查询已配置且启用的可搜索站点；media_type 支持 movie、tv、music 或对应中文类型，音乐仅返回明确声明音乐能力的站点，影视不返回纯音乐站点

搜索 / 种子 / 字幕

方法	路径	说明
GET	/api/v1/search/media/{media_id}	按统一媒体身份搜索站点种子资源；必填参数：media_source，其它参数：mtype、area、season、sites、music_type、include_candidates
GET	/api/v1/search/media/{media_id}/stream	按统一媒体身份渐进式搜索站点种子资源，返回 SSE，参数同上
GET	/api/v1/search/title	按关键字模糊搜索站点种子资源，参数：keyword、page、sites，可选 mtype=音乐 仅搜索音乐分类
GET	/api/v1/search/title/stream	按关键字渐进式搜索站点种子资源，返回 SSE，参数：keyword、page、sites，可选 mtype=音乐
GET	/api/v1/search/subtitle/title	按关键字搜索站点字幕资源，参数：keyword、page、sites
GET	/api/v1/search/subtitle/title/stream	按关键字渐进式搜索站点字幕资源，返回 SSE，参数：keyword、page、sites
GET	/api/v1/search/subtitle/media/{media_id}	按统一媒体身份精确搜索站点字幕资源；必填参数：media_source，其它参数：mtype、season、episode、sites
GET	/api/v1/search/subtitle/media/{media_id}/stream	按统一媒体身份渐进式精确搜索站点字幕资源，返回 SSE，参数同上
GET	/api/v1/search/last	获取上一次种子搜索结果
GET	/api/v1/search/last/context	获取上一次搜索结果及可复用搜索参数，params.result_type 为 torrent 或 subtitle
POST	/api/v1/search/recommend	获取 AI 推荐资源，请求体：filtered_indices、check_only、force

渐进式搜索在无业务事件时每 15 秒发送 {"type":"heartbeat"}，客户端应将其仅用于连接保活。超过 48 条的最终 replace 会分批发送：首批 type=replace，后续批次 type=append，所有批次均带 replace_batch=true、从 0 开始的 batch_index、batch_count 和最终 total_items；客户端必须按顺序收齐后再原子替换结果。最终 done 在已发送 replace 后不重复携带 items。

AniList 榜单 / 探索

AniList 榜单、探索、详情、人物和推荐接口优先通过 anilist-chinese 代理查询。代理不可用时自动回退 AniList 官方 GraphQL，并合并 anilist-chinese 每日数据集；媒体标题优先使用项目提供的中文标题，未提供中文标题时回退 AniList 原语言标题。

方法	路径	说明
GET	/api/v1/anilist/trending	查询 TRENDING NOW 榜单，参数：page、count
GET	/api/v1/anilist/popular-this-season	查询 POPULAR THIS SEASON 榜单，参数：page、count
GET	/api/v1/anilist/discover	组合探索动画，参数：search、genre、format、season、season_year、status、country、sort、page、count
GET	/api/v1/anilist/{anilist_id}	查询动画详情
GET	/api/v1/anilist/credits/{anilist_id}	查询日语配音演员，参数：page、count
GET	/api/v1/anilist/recommend/{anilist_id}	查询相关推荐，参数：page、count
GET	/api/v1/anilist/person/{person_id}	查询人物详情
GET	/api/v1/anilist/person/credits/{person_id}	查询人物参与的动画作品，参数：page、count

音乐元数据 / 推荐 / 探索

音乐元数据使用 MusicMeta / MusicInfo 独立模型。music_type=recording 表示单曲，album 表示包含多首曲目的完整专辑，artist 仅用于浏览；稳定身份分别使用对应的 musicbrainz:<mbid>。单曲和专辑可进入搜索、订阅、下载、整理、刮削和已配置音乐媒体服务器的入库检查，艺术家不能作为订阅或下载目标。

音乐与影视共用媒体搜索、资源查询、过滤、匹配和订阅搜索编排。资源 meta_info 来自 标题、副标题的实际解析，不用目标媒体回填证据；title_aliases、album_aliases、 artist_aliases 分别保留同一实体的可信别名及展示转简体前的原文。

音乐资源搜索及对应 SSE 接口默认只返回精确匹配。手动调用可传 include_candidates=true， 额外返回待确认资源及关联专辑：match_status=candidate、match_reason 描述原因， 且 media_info 为空、不绑定目标 ID；精确结果为 match_status=exact。自动订阅和批量下载 不采用待确认项。单曲的关联专辑不代表已经确认包含该单曲，专辑下载仍需检查曲目覆盖。 SSE 的 candidate_items 是站点原始返回数量，match_counts 记录身份、分类及规则淘汰原因。 只有完整过滤后还有精确结果时才会按多名称设置提前停止；音乐元数据多来源结果先各自去重再公平合并。

音乐识别结果同时提供 audio_format、audio_lossless、audio_quality、bit_depth、sample_rate、bitrate、audio_specs 和 audio_quality_score。本地文件识别读取实际音频流参数，并使用 Chromaprint 的 fpcalc 在本地生成指纹后查询 AcoustID；音频文件本身不会上传。站点资源识别从标题和描述提取声明参数；码率、采样率的存储单位分别为 bps 和 Hz。

方法	路径	说明
GET	/api/v1/media/search	当 type=music 或指定音乐 media_source 时按歌曲、专辑或歌手关键词搜索音乐元数据，参数：title、type、count、可重复的 media_source 枚举
POST	/api/v1/music/recognize	按 media_source + media_id 识别音乐详情，请求体：MusicRecognizeRequest
GET	/api/v1/music/explore	按来源浏览音乐；media_source=musicbrainz 支持 `mode=chart
GET	/api/v1/music/album/{album_id}	按来源专辑 ID 查询专辑详情、完整曲目和发行版本，参数：media_source
GET	/api/v1/music/album/{album_id}/related	按来源查询关联专辑，参数：media_source、count
GET	/api/v1/music/artist/{artist_id}	查询艺术家详情；艺术家为只读浏览实体，参数：media_source
GET	/api/v1/music/artist/{artist_id}/albums	分页查询艺术家的专辑、EP 和单曲，参数：media_source、page、count、album_type
GET	/api/v1/music/artist/{artist_id}/related	查询关联艺术家，参数：media_source、count
GET	/api/v1/recommend/music_weekly	浏览本周热门音乐，参数：page、count
GET	/api/v1/recommend/music_douban	浏览豆瓣音乐新碟榜，参数：page、count

专辑下载与订阅按“整包”处理：下载层会读取种子文件清单并以专辑 total_tracks 校验独立音频文件数量；未确认完整覆盖时不会把专辑订阅销订，也不会把部分曲目报告为完整专辑已入库。音乐整理会迁移与音轨同目录、同主干名的 .lrc、.txt 和 .lyricsfile.yaml 旁挂歌词。音乐刮削默认使用“质量升级”策略：先读取已有旁挂和 MP3/FLAC/Ogg/MP4 内嵌歌词，再聚合插件、LRCLIB、可选 Musixmatch 和 TheAudioDB 纯文本候选；逐字 Lyricsfile、逐行同步 LRC、纯文本依次降级，任何覆盖入口都不会用低质量结果替换高质量歌词。LRCLIB 的 Lyricsfile 会保留为 .lyricsfile.yaml，同时生成播放器兼容的 .lrc。

音乐订阅可使用 audio_quality=hires|lossless|lossy（支持正则组合）、audio_format、min_bitrate、min_bit_depth、min_sample_rate 过滤资源。best_version=1 开启音质洗版，系统按格式、无损属性、位深、采样率和码率换算 0-100 优先级，只下载高于 current_priority 的候选；DSD 或 24-bit/192 kHz 无损资源达到终态 100。内置规则 HIRES、LOSSLESS、FLAC、ALAC、APE、WAV、DSD、MP3、AAC、OPUS、BITRATE320、BITRATE256、BITRATE192 可用于自定义过滤规则组。

下载

方法	路径	说明
GET	/api/v1/download/	查询正在下载的任务，参数：name；关联下载历史时返回媒体类型、来源站点 site_name，以及 media.poster 海报和 media.backdrop 背景图；兼容字段 media.image 与 media.poster 相同
POST	/api/v1/download/	添加含媒体信息的下载任务，请求体包含媒体信息和种子信息
POST	/api/v1/download/add	添加不含媒体信息的下载任务，请求体包含 torrent_in，可选且必须成对提供 media_source + media_id，并支持 music_type、downloader、save_path；影视或音乐识别失败时统一响应 data.requires_confirmation=true，用户确认后可用 allow_unrecognized=true 重试本次下载
POST	/api/v1/download/subtitle	下载字幕到识别出的媒体下载目录，请求体包含 subtitle_in，并必须提供 media_source + media_id；可选 save_path
GET	/api/v1/download/start/{hashString}	恢复下载任务，参数：name
GET	/api/v1/download/stop/{hashString}	暂停下载任务，参数：name
GET	/api/v1/download/clients	查询可用下载器
GET	/api/v1/download/paths	查询可用于下载接口 save_path 参数的下载路径
DELETE	/api/v1/download/{hashString}	删除下载任务，参数：name

历史

方法	路径	说明
GET	/api/v1/history/download	按下载时间倒序查询下载历史，参数：page、count；poster 为海报，兼容字段 image 为背景图
DELETE	/api/v1/history/download	删除下载历史，请求体为下载历史记录

系统

方法	路径	说明
GET	/api/v1/system/ping	登录用户服务存活检测，用于前端重启后轮询恢复状态
GET	/api/v1/dashboard/system	查询仪表板系统摘要，包括主机名称、操作系统、MoviePilot 运行时间和后端版本
GET	/api/v1/dashboard/schedule	查询所有后台定时服务，包含当前完成百分比、进度文本和执行状态
GET	/api/v1/dashboard/schedule/{job_id}/progress	查询指定后台定时服务的实时进度详情
GET	/api/v1/dashboard/schedule2/{job_id}/progress	使用 API_TOKEN 查询指定后台定时服务的实时进度详情
GET	/api/v1/system/setting/public/{key}	登录用户读取白名单内非敏感系统设置，仅支持目录、存储、站点范围、默认订阅规则、Follow 订阅者和插件市场地址等前端必需配置
POST	/api/v1/system/setting/PLUGIN_MARKET/sync-wiki	管理员从 MoviePilot Wiki 的插件文档同步公开插件仓库清单，和本地 PLUGIN_MARKET 合并去重后写入配置
GET	/api/v1/system/modulelist	查询已加载模块，保留 name 原始中文字段，并提供 name_i18n 和 name_key 给多语言前端展示
GET	/api/v1/system/moduletest/{moduleid}	测试指定模块可用性，标准响应的 message 会按请求语言直接返回翻译文本
GET	/api/v1/message/agent/mcp/servers	管理员查询 Agent 外部 MCP 服务器配置
POST	/api/v1/message/agent/mcp/servers	管理员保存 Agent 外部 MCP 服务器配置
POST	/api/v1/message/agent/mcp/servers/test	管理员测试单个 Agent 外部 MCP 服务器并读取工具列表

缓存管理

以下接口使用登录态鉴权，并要求当前用户为超级管理员。

方法	路径	说明
GET	/api/v1/tmdb/cache	查询 TheMovieDb 识别缓存统计、共享识别累计成功命中次数及开关状态
DELETE	/api/v1/tmdb/cache/{cache_key}	按缓存键删除单条 TheMovieDb 识别缓存，缓存键需要进行 URL 编码
DELETE	/api/v1/tmdb/cache	清空全部 TheMovieDb 识别缓存
GET	/api/v1/music/cache	查询 MusicBrainz 音乐识别缓存统计及条目列表
DELETE	/api/v1/music/cache/{cache_key}	按缓存键删除单条音乐识别缓存，缓存键需要进行 URL 编码
DELETE	/api/v1/music/cache	清空全部音乐识别缓存

TMDB 缓存查询响应的 data 包含 count、recognized、unrecognized、data，以及共享识别统计字段 shared_recognized 和开关字段 shared_recognize_enabled。共享命中次数仅在共享结果驱动的二次媒体识别成功后累计。

音乐识别缓存查询响应的 data 包含 count、recognized、unrecognized 和 data；条目字段包括缓存键、media_id、title、artists、album、year、music_type 和 cover_url。未携带远端身份的兜底负缓存仅保留在内存，不参与持久化。

插件补充接口

GET /api/v1/plugin/history/{plugin_id}

按需读取指定已安装插件的最新远端更新说明。该接口用于前端在用户点击“查看更新说明”时再实时访问插件仓库，避免加载已安装插件列表时批量请求网络。

GET /api/v1/plugin/rating?plugin_ids={plugin_id,...}

批量查询插件平均分、评分人数和当前安装实例评分。plugin_ids 省略时查询中心端已有的全部插件评分。

GET /api/v1/plugin/rating/{plugin_id}

查询单个插件平均分、评分人数和当前安装实例评分。中心端暂不可用时返回该插件的零评分结果。

POST /api/v1/plugin/rating/{plugin_id}

为已安装插件提交当前安装实例评分，请求体为 {"rating": 4.5}。评分范围为 0.1 至 5.0，精确到 0.1；同一安装实例再次提交会更新原评分。

1. 列出所有工具

GET /api/v1/mcp/tools

获取所有可用的MCP工具列表。

MCP、HTTP 工具管理接口、本地 CLI 和内置 Agent 都从同一严格目录生成工具列表。 旧业务工具名不再注册，也没有 MCP 别名或兼容目录；例如 search_media、add_subscribe、query_download_tasks、query_schedulers 会直接返回工具不存在。插件工具仍由插件的 get_agent_tools() 动态声明，重名会让目录 构造失败，不采用 first-wins 覆盖。

固定目录按职责收敛为：

工具	说明
moviepilot_api	通过固定 operation_id 调用受控 MoviePilot 业务 API；不接受 URL、HTTP method、认证头或 Token
agent_task	通过 `action=create
persona	通过 `action=list
send_message、send_local_file	当前目录中可用的消息和文件发送能力；实际渠道能力仍由运行时校验
browse_webpage、recognize_captcha	浏览和验证码等非 MoviePilot 业务 API 能力
query_doctor_report	只读系统诊断

read_skill、read_file、write_file、edit_file、apply_patch、execute_command 和 search_web 不通过 MCP 暴露。隐藏列表只负责收敛接口暴露面，不替代各工具自身的 权限、路径和网络边界。

下载器和媒体服务器的第三方原生高级能力不注册成永久 MCP 工具。内置 Agent 按需 加载 downloader-operation 或 mediaserver-operation Skill，通过固定脚本读取本机 配置、发现 provider 能力并调用受控 action；脚本不接受任意 URL、认证信息或任意 SDK method。普通 MCP 客户端如需这些 provider 原生能力，应使用对应第三方服务的 正式 API，而不是依赖已删除的 MoviePilot 旧工具名。

send_message 新增可选的 rich_message 字符串参数，用于传入一份完整的 GitHub 风格 Markdown 正文。Telegram 渠道会把它转换为 Bot API Rich Message，支持标题、列表、表格、引用、代码块和链接，并按 Rich Message 限制自动分段；没有使用该参数时继续走原有普通消息链路。广播到其它通知渠道时，同一正文会作为普通 text 回退。rich_message 是完整正文，不应再同时传 message、title 或 image_url 表达同一份内容。内置 Agent 在 Telegram 会话中的普通回复、流式首发和后续流式编辑都会优先使用该富文本链路。

moviepilot_api 的模型可见输入固定为：

{
  "operation_id": "media.search",
  "path_params": {},
  "query": {"title": "流浪地球", "type": "media"},
  "body": {}
}

宿主按 operation_id 决定固定 method 与 path，使用真实持久化管理员身份为 API KEY 集成签发短期本机令牌，并按 operation 执行权限、确认、结果脱敏和恢复策略。 调用方不能注入 host、URL、认证头或 API Token。 Web Agent 直接调用 moviepilot_api 时，宿主会自动加载 moviepilot-api Skill 的 operation 白名单后再执行；这只是授权兜底，不会放宽固定 operation、身份、权限 或确认策略。

当前业务 operation 分组如下；完整参数合同以 skills/moviepilot-api/SKILL.md 和 各 REST 请求模型为准：

领域	Operation ID
媒体/搜索	media.search、media.person.search、media.person.credits、media.recognize、media.scrape、media.episode_schedule、media.detail、search.torrents、search.results、recommendation.list
订阅	subscription.add、subscription.update、subscription.search、subscription.list、subscription.shares、subscription.popular、subscription.history、subscription.delete
下载/历史	download.add、download.history.delete、transfer.history.delete
媒体库/存储/转移	library.exists、storage.settings、storage.list、transfer.history、transfer.file
站点	site.list、site.update、site.userdata、site.test、site.cookie.update
调度/工作流	scheduler.list、scheduler.run、workflow.list、workflow.run
插件	plugin.installed、plugin.market、plugin.capabilities、plugin.config.get、plugin.config.update、plugin.reload、plugin.install、plugin.uninstall、plugin.data
规则/配置/命令	filter.builtin、filter.custom、filter.groups、filter.custom.add、filter.custom.update、filter.custom.delete、filter.group.add、filter.group.update、filter.group.delete、config.identifiers.get、config.identifiers.update、config.system.get、config.system.update、slash.list、slash.run

download.list、download.update、download.delete、downloaders.list 和 library.latest 已从 Agent operation 目录删除，避免与 provider Skill 重复。供前端和 其它宿主使用的普通 REST 端点仍然保留。

Agent 自主定时任务与人格

agent_task 是唯一的自主任务工具，要求管理员权限：

Action	说明
create	创建单次或周期任务，并保存任务内容及当前用户、会话上下文
list	查询任务配置、启用状态、下次执行时间及最近执行结果
update	修改任务内容或触发器，也可通过 enabled 暂停、恢复任务
run	使用整数 task_id 将当前用户已启用的任务提交为立即执行
delete	永久删除任务并立即移除运行时调度

trigger_type=date 表示单次执行：“30 分钟后检查”这类相对时间传 delay_minutes=30，由后端计算精确时间；固定时间则传 ISO 8601 trigger，支持精确到秒。trigger_type=cron 使用标准五段 cron（分、时、日、月、周），适合周期检查。未显式携带时区的时间按 MoviePilot 的 TZ 配置解释。任务由内存调度器精确触发，配置持久化到数据库，服务重启后会自动恢复；触发后 Agent 在原会话中执行 content，执行过程及最终结果均不绑定创建任务时的消息渠道，而是通过 MoviePilot 已配置的通知渠道广播。如果 Agent 在执行过程中已通过消息工具发送完整结果，任务结束时不会再次发送相同的最终回复。

服务重启时仍处于运行中的任务会显示为 interrupted，表示上次结果未知且可能已有部分操作。中断的一次任务不会自动补跑，暂停后恢复也仍保留中断状态；需要先核对实际结果，再用 agent_task(action="run") 明确立即重跑，或通过 agent_task(action="update") 提供新的 trigger_type 与未来触发时间重新安排。

Agent 自主任务使用数据库中的整数 task_id。scheduler.list 与 scheduler.run operation 仅面向系统、插件和工作流注册的运行时定时服务，使用字符串 job_id，不会返回或执行 agent-task-*。两类 ID 不可混用；需要立即执行自主任务时，应先通过 agent_task(action="list") 确认归属和状态，再调用 agent_task(action="run")。立即执行只提交任务，不在当前工具调用内等待结果，从而避免同一 Agent 会话互相等待；执行结果仍按上述通知规则广播。

上述过滤只约束 Agent 工具，避免模型混用两类任务。前端系统设置和仪表盘使用的 /api/v1/dashboard/schedule 仍返回完整运行时列表，其中包含 provider=[Agent] 的自主任务；前端通过 /api/v1/system/runscheduler 立即执行这类列表项的行为也保持不变。

创建单次任务的参数示例：

{
  "tool_name": "agent_task",
  "arguments": {
    "action": "create",
    "name": "检查电影资源",
    "content": "搜索电影《示例电影》是否已有可下载资源，并报告站点、版本和大小；不要自动下载。",
    "trigger_type": "date",
    "delay_minutes": 30
  }
}

创建每天 20:30 执行的周期任务时，使用 trigger_type=cron 和 trigger="30 20 * * *"。

persona 使用 action=list|switch|update。list 可按 query 过滤； switch 必须提供 persona_id；update 只有管理员可用，支持替换 label、 description、aliases、instructions，或通过 append_instructions 追加规则。旧的 query_personas、switch_persona 和 update_persona_definition 不再注册。

认证: 需要API KEY，在请求头中添加 X-API-KEY: <api_key> 或在查询参数中添加 apikey=<api_key>

响应示例:

{
  "success": true,
  "message": "",
  "data": [
    {
      "name": "moviepilot_api",
      "description": "调用经过白名单审核的 MoviePilot 业务 API...",
      "inputSchema": {
        "type": "object",
        "properties": {
          "operation_id": {
            "type": "string",
            "description": "稳定的 MoviePilot API operation ID"
          }
        },
        "required": ["operation_id"]
      }
    }
  ]
}

系统诊断工具

query_doctor_report 以只读方式返回 MoviePilot Doctor 诊断报告，可通过 deep 启用深度检查，并通过 include_details 控制是否返回完整详情。每条诊断项的 affects_report_status 表示其是否参与整体状态聚合；插件日志异常会保留为 warn/degraded 线索，但该字段为 false，不会单独把系统整体状态降为 degraded。

2. 调用工具

POST /api/v1/mcp/tools/call

调用指定的MCP工具。

认证: 需要API KEY，在请求头中添加 X-API-KEY: <api_key> 或在查询参数中添加 apikey=<api_key>

请求体:

{
  "tool_name": "moviepilot_api",
  "arguments": {
    "operation_id": "media.search",
    "query": {
      "title": "流浪地球",
      "type": "media"
    }
  }
}

响应示例:

{
  "success": true,
  "message": "",
  "data": {
    "result": "{\"success\":true,\"message\":\"\",\"data\":[...]}"
  }
}

错误响应示例:

{
  "success": false,
  "message": "调用工具失败: 参数验证失败",
  "data": null
}

3. 获取工具详情

GET /api/v1/mcp/tools/{tool_name}

获取指定工具的详细信息。

认证: 需要API KEY，在请求头中添加 X-API-KEY: <api_key> 或在查询参数中添加 apikey=<api_key>

路径参数:

• tool_name: 工具名称

响应示例:

{
  "success": true,
  "message": "",
  "data": {
    "name": "moviepilot_api",
    "description": "调用经过白名单审核的 MoviePilot 业务 API...",
    "inputSchema": {
      "type": "object",
      "properties": {
        "operation_id": {
          "type": "string",
          "description": "稳定的 MoviePilot API operation ID"
        }
      },
      "required": ["operation_id"]
    }
  }
}

4. 获取工具参数Schema

GET /api/v1/mcp/tools/{tool_name}/schema

获取指定工具的参数Schema（JSON Schema格式）。

认证: 需要API KEY，在请求头中添加 X-API-KEY: <api_key> 或在查询参数中添加 apikey=<api_key>

路径参数:

• tool_name: 工具名称

响应示例:

{
  "success": true,
  "message": "",
  "data": {
    "type": "object",
    "properties": {
      "operation_id": {
        "type": "string",
        "description": "稳定的 MoviePilot API operation ID"
      },
      "query": {
        "type": "object",
        "description": "固定 operation 的查询参数"
      }
    },
    "required": ["operation_id"]
  }
}