mcpField
M
mux-video

mux-video

github.com/muxinc开发2220 次安装2 天前更新
代码仓库

关于 mux-video

mux-video 是用于查找和查询 Mux 机器可读文档的技能,供回答 Mux 相关问题时使用。它指导 Agent 定位单个相关 Markdown 页面、核对最新 API 说明并引用来源,而非凭记忆作答。

主要功能

  1. 01按顺序发现文档
  2. 02获取精简的 Markdown 页面
  3. 03链接 API 参考与规范
  4. 04要求引用来源网址
  5. 05文档不可用时避免猜测

适用场景

  1. 01核实最新 Mux API 细节
  2. 02查找 Mux 视频工作流指南
  3. 03基于引用文档回答问题
  4. 04文档网址变更时重新定位

安装

复制下面的命令,在终端中运行。

$npx skills add https://github.com/muxinc/skills --skill mux-video

安装后在 Claude Code 中输入/mux-video确认已加载。

详细介绍

Mux 文档发现

Mux 将其全部文档发布为适合 Agent 使用的 Markdown,这些文档由与实际文档站点相同的源自动生成。对于任何 Mux 相关问题,请获取相关页面并据此作答 — 切勿凭记忆回答 Mux API 问题,因为 API 结构和指南会不断变化。

工作流

  1. 路由 — 按以下顺序尝试,首次命中后停止。 此顺序按成本排列:每一步读取的令牌数都少于下一步。
    1. 如果已安装 mux CLI,请运行 mux docs find "<topic>" --agent — 它会在 CLI 端搜索文档索引,只返回匹配页面的 URL,因此无需将索引读入上下文。(检查 mux docs --help;较旧版本不支持此命令。)
    2. 根据已知模式构造 URL:下方的表格(集合、Robots robots-<task>.md、API 参考)涵盖了大多数主题。
    3. 获取对应主题领域中最小的集合索引(几十行)。
    4. 仅当上述步骤均未找到结果时,才获取 https://www.mux.com/llms.txt — 所有文档页面的主索引。
  2. 获取一个页面 — 获取该页面的 Markdown 版本:在其 URL 后追加 .md(例如 https://www.mux.com/docs/guides/start-live-streaming.md)。只有在需要精确的请求/响应结构时才添加 API 参考合集;不要为了“了解背景”而获取额外页面。
  3. 根据获取的内容作答,并引用页面 URL。

切勿获取 https://www.mux.com/llms-full.txt。 它将全部文档放在一个文件中,会占满上下文窗口;其中的每个页面都可以通过上述步骤单独访问。

集合索引

集合URL
核心概念https://www.mux.com/docs/core.txt
视频:上传、编码、管理资源https://www.mux.com/docs/guides/video.txt
上传器:处理用户上传https://www.mux.com/docs/guides/uploader.txt
播放器:嵌入视频播放https://www.mux.com/docs/guides/player.txt
数据:播放质量和分析https://www.mux.com/docs/guides/data.txt
数据集成:第三方播放器监控https://www.mux.com/docs/guides/data-integrations.txt
框架集成和 SDKhttps://www.mux.com/docs/integrations.txt
示例实现https://www.mux.com/docs/examples.txt
定价和计费https://www.mux.com/docs/pricing.txt

Mux Robots(AI 视频工作流)

Robots — Mux 的 AI 驱动视频工作流 — 已在 v1 API(/robots/v1)上正式发布。在 @mux/ts 16+ 中,client.robots 调用 v1;client.robotsV0 和 /robots/v0 已弃用,仍处于 Beta 阶段。请从此处开始:

资源URL
Robots 集合索引(工作流、指令、迁移指南)https://www.mux.com/docs/guides/robots.txt
Robots 概览https://www.mux.com/docs/guides/robots.md
Robots 指令参考https://www.mux.com/docs/guides/robots-directives.md
支持的语言https://www.mux.com/docs/guides/robots-supported-languages.md
从 Beta(v0)迁移到 v1https://www.mux.com/docs/guides/robots-migrate-to-v1.md

特定任务的指南遵循 https://www.mux.com/docs/guides/robots-<task>.md 模式,其中 <task> 可以是:analyze-structure、summarize、generate-chapters、generate-contextual-text、ask-questions、find-key-moments、find-best-thumbnails、generate-engagement-insights、moderate、generate-premium-captions、edit-captions、translate-captions、translate-audio。对于场景,请使用 analyze-structure。

迁移指南遵循 https://www.mux.com/docs/guides/robots-migrate-<topic>-to-v1.md 模式,其中 <topic> 可以是 directives、webhooks 或 typescript-sdk。

API 参考和规范

如需准确了解端点、参数和 Webhook 的结构,请优先参考以下内容,而非文字指南:

资源URL
Video API 参考https://www.mux.com/docs/api-reference/video.txt
Data API 参考https://www.mux.com/docs/api-reference/data.txt
System API 参考https://www.mux.com/docs/api-reference/system.txt
Robots v1 API 参考(完整规范中的 /robots/v0 路径已弃用,属于 Beta)https://www.mux.com/docs/api-reference/robots.txt
完整 API 规范(OpenAPI JSON)https://www.mux.com/api-spec.json
Webhook 规范(JSON)https://www.mux.com/webhook-spec.json
Mux Player Web 组件 APIhttps://raw.githubusercontent.com/muxinc/elements/refs/heads/main/packages/mux-player/REFERENCE.md
Mux Player React 组件 APIhttps://raw.githubusercontent.com/muxinc/elements/refs/heads/main/packages/mux-player-react/REFERENCE.md

所有这些资源也都可以从文档网站中找到:每个文档页面都链接到“Docs for LLMs”(https://www.mux.com/docs/core/llms-txt),这是介绍 Mux 的 llms.txt 文件和机器可读资源包的权威页面。如果本技能列出的 URL 与实际情况不符,请以该页面为准。

自我修复

如果文档 URL 返回 404,说明文档可能已重新整理。不要遇到一次 404 就放弃:运行 mux docs find "<topic>" --agent(或获取 https://www.mux.com/llms.txt 并搜索),以查找页面的当前 URL。

保持同步

  • 本技能由 muxinc/skills 仓库分发,并内置于 mux CLI 中。更新 CLI(brew upgrade mux / npm update -g @mux/cli)会更新内置技能;运行 mux skills update 会刷新所有本地副本(包括 ~/.claude/skills),使其与已安装版本保持一致。对于与 CLI 版本发布周期脱钩的技能,请安装 mux@mux Claude Code 插件,或直接从 https://github.com/muxinc/skills 获取。
  • CLI 仅内置技能说明文件,不包含文档内容——请始终按照上述工作流实时获取文档。运行 mux skills --help 查看已安装版本提供的功能。

防护措施

  • 引用所依据的文档页面 URL。
  • 如果网络不可用,请说明无法对照当前文档进行验证——切勿凭记忆猜测 API 请求/响应结构。

评论

支持 Markdown