使用说明(简要版,便于快速上手):
-
项目简介
- 该仓库实现了一个可运行的 MCP 服务器,核心职责是向 MCP 客户端提供上下文信息和功能,包括对 VidCap YouTube API 的资源访问、工具注册与执行,以及提示模板的渲染能力。服务器支持多种传输协议(stdio、流式 HTTP、SSE),并具备会话管理、能力声明和安全性考量。
-
主要功能点
- MCP 核心能力:支持按照 MCP 规范处理请求与响应(JSON-RPC 形式),贯穿资源、工具、提示等能力的注册、执行与渲染。
- 资源与工具:内置 YouTube 相关的 MCP 工具集合(例如获取视频信息、获取媒体格式、字幕/摘要/截图、评论、搜索等),并通过统一的工具注册接口暴露给 LLM 客户端使用。
- VidCap API 集成:对 VidCap YouTube API 的代理访问,依赖 API Key(VIDCAP_API_KEY)进行鉴权访问。
- 多传输支持:默认 STDIO 传输,亦可通过 HTTP 流式传输、SSE 等接入客户端。
- 会话与上下文管理:通过会话 ID 管理 MCP 会话,支持重新连接、会话清理和请求上下文传递。
- 安全与配置:提供 API Key 上下文中间件、基于环境变量和全局配置的配置加载,以及日志系统。
-
安装步骤
- 克隆仓库并安装依赖
- 复制环境变量,设置 VIDCAP_API_KEY 为你的 VidCap API Key
- 启动开发服务器(STDIO):
- npm run dev:server
- 或以 HTTP 传输启动: npm run dev:server:http
- 访问调试与 Inspector(如有需要)
- 如要在生产环境运行,请执行打包后启动生产服务器
-
服务器配置(MCP 客户端需要的 JSON 配置示例说明)
- 配置目标:将本 MCP 服务器注册到 MCP 客户端,以便客户端通过指定命令启动服务器并建立连接。
- 配置字段说明(基于仓库实现的实际信息,方便直接应用):
- serverName(服务器名称,唯一标识)
- command(启动命令)
- args(命令参数列表)
- env(环境变量,如 API Key 等)
- transport(传输方式,通常为 stdio,HTTP 也可选)
- 下面给出一个示例描述,实际请按需填充你的 API Key: { "serverName": "vidcap-youtube-api", "command": "npx", "args": ["vidcap-mcp-server"], "env": { "VIDCAP_API_KEY": "your_api_key_here" }, "transport": "stdio" }
- 注释说明:上述示例用于 MCP 客户端的服务器注册配置,客户端不需要包含本段内容在代码中,仅用于说明需要提供的连接信息。若使用 GUI/工具管理器,请在相应配置界面填写相应字段即可。
-
基本使用方法
- 启动后,客户端(如 Claude、Cline、Claude Code 等)即可通过 MCP 接口向 VidCap YouTube API 工具发起请求,获取视频信息、媒体格式、字幕、摘要、截图、评论以及全面的搜索结果。
- 若需要在 Claude Desktop/Code 中进行集成,请使用服务器名称 vidcap-youtube-api,通过配置中的命令和环境变量初始化并连接即可。
- 常见运维:设置 DEBUG、VIDCAP_API_KEY,检查服务器日志与 MCP Inspector(如启用)。
-
重要注意
- MCP 客户端在启动时需要知道服务器的启动命令及参数,确保服务器能被正确启动并暴露 MCP 接口。
- 若使用 HTTP 传输,请按 README 指定的主机/端口/路径进行配置,并确保 API Key 安全地传输。
-
进一步参考
- 该仓库包含完整的工具注册、CLI、测试用例、以及对 VidCap YouTube API 的扩展实现,适合作为 MCP 服务器的模板和样例,便于在自有数据源或外部 API 上进行定制化扩展。
信息
分类
AI与计算