使用说明

项目简介

GPTDARR 是一个 MCP 服务器,旨在通过 Model Context Protocol (MCP) 协议,为 AI 助手提供操作 Sonarr 和 Radarr 媒体库的能力。它允许用户通过 AI 助手以自然语言搜索媒体内容,并将电影和电视剧添加到 Sonarr 和 Radarr 进行自动下载和管理。

主要功能点

  • 媒体内容搜索: 通过 'lookup-content' 工具,AI 助手可以搜索 Sonarr 和 Radarr 媒体库中的电影和电视剧。
  • 电视剧添加: 通过 'add-series' 工具,AI 助手可以将指定的电视剧添加到 Sonarr 进行管理。
  • 电影添加: 通过 'add-movies' 工具,AI 助手可以将指定的电影添加到 Radarr 进行管理。
  • 详细日志: 提供全面的日志记录,方便开发调试和监控服务器运行状态。

安装步骤

  1. 环境准备: 确保已安装 Node.js 18 或更高版本,并已配置运行 Sonarr 和 Radarr 服务。
  2. 安装 GPTDARR: 打开终端,运行以下命令安装 GPTDARR:
    npx gptdarr setup
    按照交互式配置向导提示,输入 Sonarr 和 Radarr 的 URL、API 密钥、质量配置、根目录等信息。配置向导将自动生成必要的配置文件。
  3. 复制启动命令: 配置向导完成后,会生成一个 'npx gptdarr ...' 命令,复制此命令。

服务器配置

为了使 MCP 客户端能够连接到 GPTDARR 服务器,您需要在 MCP 客户端中配置一个新的工具,配置信息如下:

{
  "serverName": "GPTDARR",
  "command": "npx gptdarr",
  "args": [
    "--enable_logging", "true",  // 是否启用日志,可选 "true" 或 "false",默认为 "true"
    "--sonarr_url", "<Your Sonarr URL>", // Sonarr 服务器 URL,例如 "http://localhost:8989"
    "--sonarr_api_key", "<Your Sonarr API Key>", // Sonarr API 密钥
    "--sonarr_quality_profile_id", "<Your Sonarr Quality Profile ID>", // Sonarr 质量配置 ID
    "--sonarr_root_folder", "<Your Sonarr Root Folder Path>", // Sonarr 根目录路径,例如 "/path/to/tvshows"
    "--radarr_url", "<Your Radarr URL>", // Radarr 服务器 URL,例如 "http://localhost:7878"
    "--radarr_api_key", "<Your Radarr API Key>", // Radarr API 密钥
    "--radarr_quality_profile_id", "<Your Radarr Quality Profile ID>", // Radarr 质量配置 ID
    "--radarr_root_folder", "<Your Radarr Root Folder Path>", // Radarr 根目录路径,例如 "/path/to/movies"
    "--radarr_force_search_on_existing", "true" // Radarr 是否强制搜索已存在的电影,可选 "true" 或 "false",默认为 "true"
  ]
}

请注意:

  • '<Your Sonarr URL>'、'<Your Sonarr API Key>' 等参数需要替换为您在 Sonarr 和 Radarr 中实际配置的值。
  • 您可以通过运行 'npx gptdarr setup' 配置向导来简化配置过程,并获取完整的启动命令。
  • 如果 MCP 客户端支持,可以直接粘贴配置向导生成的 'npx gptdarr ...' 命令到客户端的工具配置中。

基本使用方法

  1. 在 MCP 客户端中添加上述配置的 GPTDARR 工具。
  2. 在 AI 助手中,您可以使用以下工具来操作媒体库:
    • lookup-content: 搜索电影或电视剧。
      • 参数: 'title' (电影或电视剧标题), 'year' (可选,年份)
      • 示例: 'lookup-content title="疑犯追踪" year="2011"'
    • add-series: 添加电视剧到 Sonarr。
      • 参数: 'items' (电视剧列表,包含 'seriesName' 电视剧名称, 'seriesYear' 可选年份)
      • 示例: 'add-series items=[{seriesName="绝命毒师", seriesYear="2008"}, {seriesName="权力的游戏"}]'
    • add-movies: 添加电影到 Radarr。
      • 参数: 'items' (电影列表,包含 'title' 电影标题, 'year' 可选年份)
      • 示例: 'add-movies items=[{title="星际穿越", year="2014"}, {title="盗梦空间"}]'
  3. AI 助手会根据您的指令调用相应的工具,GPTDARR 服务器会处理请求并返回结果。

通过以上步骤,您就可以使用 GPTDARR MCP 服务器,通过 AI 助手方便地管理您的 Sonarr 和 Radarr 媒体库了。

信息

分类

生产力应用