使用说明

项目简介

youtube MCP server 是一个基于 Model Context Protocol (MCP) 构建的后端服务,旨在为大型语言模型(LLM)客户端提供 YouTube 视频研究能力。它通过 MCP 协议与客户端通信,提供工具 (Tools) 和 Prompt 模板 (Prompts),使 LLM 能够调用 YouTube 搜索和信息提取功能。

主要功能点

  • YouTube 视频搜索工具 (Tool): 提供 'youtube-research' 工具,允许用户根据主题搜索 YouTube 平台上的相关视频,包括短视频和长视频。该工具会返回搜索到的视频标题、URL、时长和字幕信息。
  • YouTube 搜索词生成 Prompt (Prompt): 提供 'youtube-search-terms' Prompt,可以根据用户给定的主题生成更专业的 YouTube 搜索关键词,辅助用户进行更有效的视频搜索。

安装步骤

  1. 环境准备: 确保已安装 Python 3.7+ 和 uv (或 pip)。uv 是一个更快的 Python 包安装和依赖管理工具,推荐使用。

    # 如果没有 uv,请先安装 uv
    # 参考 uv 官方文档 https://astral.sh/uv
  2. 克隆仓库: 将 GitHub 仓库克隆到本地。

    git clone https://github.com/danhilse/youtube
    cd youtube
  3. 安装依赖: 使用 uv 或 pip 安装项目依赖。

    uv sync  # 推荐使用 uv
    # 或使用 pip
    # pip install -r requirements.txt
  4. 配置 YouTube API 密钥:

    • 前往 Google Cloud Console 创建或选择一个项目。
    • 启用 YouTube Data API v3。
    • 创建 API 密钥。
    • 在项目根目录下创建 '.env' 文件,并添加以下内容,将 'YOUR_YOUTUBE_API_KEY' 替换为您获得的 API 密钥。
      YOUTUBE_API_KEY=YOUR_YOUTUBE_API_KEY

服务器配置

要将 youtube MCP server 集成到 MCP 客户端(例如 Claude),您需要配置客户端以连接到此服务器。以下是配置示例,以 Claude Desktop 客户端为例。

配置信息 (JSON 格式):

{
  "mcpServers": {
    "youtube": {
      "command": "uv",
      "args": [
        "--directory",
        "/path/to/youtube",  //  请替换为 youtube 仓库的本地路径
        "run",
        "youtube"
      ]
    }
  }
}

参数说明:

  • '"youtube"': 服务器名称,在客户端中用于标识该服务器。
  • '"command": "uv"': 启动服务器的命令。这里使用 'uv run youtube',假设您已安装 uv 并希望使用 uv 运行项目。如果您使用 pip,并且直接运行 'server.py' 文件,可以将 command 修改为 '"command": "python"',并相应修改 'args'。
  • '"args"': 传递给启动命令的参数列表。
    • '"--directory", "/path/to/youtube"': 指定 youtube 仓库的本地路径。请务必将 '/path/to/youtube' 替换为您实际的仓库路径。
    • '"run"': uv 的子命令,用于运行 Python 包或模块。
    • '"youtube"': 要运行的 Python 模块名,对应 'src/youtube/init.py' 中定义的 'main()' 入口点。

根据不同的运行方式,'command' 和 'args' 可能需要调整。 例如,如果直接使用 Python 运行 'server.py' 文件,配置可能如下:

{
  "mcpServers": {
    "youtube": {
      "command": "python",
      "args": [
        "/path/to/youtube/src/youtube/server.py" // 请替换为 server.py 文件的实际路径
      ]
    }
  }
}

请根据您的实际环境和运行方式选择合适的配置,并将配置信息添加到 MCP 客户端的配置文件中(例如 Claude Desktop 的 'claude_desktop_config.json')。

基本使用方法

  1. 启动服务器: 根据配置,启动 youtube MCP server。例如,在仓库根目录下运行 'uv run youtube' 或 'python src/youtube/server.py'。

  2. 在 MCP 客户端中使用: 在配置好 MCP 服务器的客户端(如 Claude)中,您应该能够:

    • 调用 'youtube-research' 工具,输入您感兴趣的主题,让 Claude 搜索 YouTube 并提供视频信息和字幕摘要。
    • 使用 'youtube-search-terms' Prompt,输入主题,获取更专业的 YouTube 搜索建议,以便更精确地搜索视频。

具体使用方式取决于 MCP 客户端的功能和界面。请参考您使用的 MCP 客户端的文档,了解如何调用 MCP 服务器提供的工具和 Prompt。

信息

分类

网页与API