使用说明

项目简介

本项目是一个基于 Model Context Protocol (MCP) 的服务器实现,旨在为 LLM 应用提供访问 YouTube 视频信息的能力。通过此服务器,LLM 可以搜索 YouTube 视频、获取视频文字稿以及生成视频摘要。

主要功能点

  • 视频搜索: 通过关键词搜索 YouTube 视频,返回视频标题、频道和 ID 信息。
  • 文字稿获取: 读取指定 YouTube 视频的文字稿。
  • 视频摘要: 基于视频文字稿生成简要摘要。

安装步骤

  1. 安装 Bun: 确保已安装 Bun JavaScript 运行时环境。
  2. 获取代码: 克隆或下载此 GitHub 仓库的代码。
  3. 安装依赖: 在仓库根目录下,运行命令 'bun install' 安装项目依赖。
  4. 配置 GCP API 密钥和 OAuth 2.0 凭据:
    • 前往 Google Cloud Console 创建或选择现有项目。
    • 启用 YouTube Data API v3
    • 创建 API 密钥
    • 创建 OAuth 2.0 客户端 ID (选择 "Web 应用" 类型),并将授权重定向 URI 配置为 'http://localhost:3000/oauth2callback' 和 'http://localhost:3001/oauth2callback'。
    • 将下载的 gcp-oauth.keys.json 文件放置到项目根目录。此文件包含 API 密钥以及 OAuth 2.0 客户端 ID 和密钥等凭据。

服务器配置

MCP 客户端需要配置以下服务器信息才能连接到 YouTube MCP 服务器。在 MCP 客户端的服务器配置中,填写以下 JSON 对象:

{
  "serverName": "servers/youtube",
  "command": "bun",
  "args": ["run", "index.ts"]
}
  • 'serverName': 服务器名称,固定为 "servers/youtube"。
  • 'command': 启动服务器的命令,这里使用 "bun"。
  • 'args': 命令参数,包括 "run" 和入口文件 "index.ts"。

基本使用方法

  1. 启动服务器: 在仓库根目录下,运行命令 'bun run index.ts' 启动 YouTube MCP 服务器。
  2. 客户端连接: 在 MCP 客户端中,添加并配置上述服务器信息,建立与 YouTube MCP 服务器的连接。
  3. 工具和资源: 通过 MCP 客户端,您可以:
    • 使用 'ListToolsRequest' 查看服务器提供的工具,包括 "search" (视频搜索) 和 "createSummary" (视频摘要)。
    • 使用 'CallToolRequest' 调用工具,例如:
      • 搜索视频:'{"name": "search", "arguments": {"query": "您的搜索关键词"}}'
      • 生成摘要:'{"name": "createSummary", "arguments": {"videoId": "视频ID"}}'
    • 使用 'ReadResourceRequest' 读取资源,例如获取视频文字稿:'{"uri": "youtube:///视频ID"}' (将 "视频ID" 替换为实际的 YouTube 视频 ID)。
  4. OAuth 认证 (首次使用): 首次使用文字稿相关功能时,服务器可能会提示进行 OAuth 认证。请运行 'bun run auth' 命令,并按照终端提示在浏览器中完成 YouTube 账号授权。授权成功后,服务器将保存 Token,后续操作无需重复授权。

注意: 文字稿功能可能需要 OAuth 认证才能正常使用。请确保已完成 OAuth 认证流程。

信息

分类

网页与API