Mux docs discovery
Mux publishes its entire documentation as agent-ready markdown, auto-generated from the same source as the real docs site. For any Mux question, fetch the relevant page and answer from it — never answer Mux API questions from memory, because API shapes and guidance change.
Workflow
- Route — try these in order and stop at the first hit. The order is cost-ordered: each step reads fewer tokens than the next.
- If the
muxCLI is installed, runmux docs find "<topic>" --agent— it searches the docs index CLI-side and returns only the matching page URLs, so you never read an index into context. (Checkmux docs --help; older versions lack it.) - Construct the URL from a known pattern: the tables below (collections, Robots
robots-<task>.md, API references) cover most topics. - Fetch the smallest collection index for the topic area (a few dozen lines).
- Fetch https://www.mux.com/llms.txt — the master index of every docs page — only when the steps above fail.
- If the
- Fetch ONE page — the page's markdown version: append
.mdto its URL (e.g.https://www.mux.com/docs/guides/start-live-streaming.md). Only add an API reference bundle when you need exact request/response shapes; do not fetch extra pages "for context." - Answer from the fetched content and cite the page URL.
Never fetch https://www.mux.com/llms-full.txt. It is the entire documentation in a single file and will flood the context window; every page in it is reachable individually through the steps above.
Collection indexes
| Collection | URL |
|---|---|
| Core concepts | https://www.mux.com/docs/core.txt |
| Video: upload, encode, manage assets | https://www.mux.com/docs/guides/video.txt |
| Uploader: handle user uploads | https://www.mux.com/docs/guides/uploader.txt |
| Player: embed video playback | https://www.mux.com/docs/guides/player.txt |
| Data: playback quality and analytics | https://www.mux.com/docs/guides/data.txt |
| Data integrations: third-party player monitoring | https://www.mux.com/docs/guides/data-integrations.txt |
| Framework integrations and SDKs | https://www.mux.com/docs/integrations.txt |
| Example implementations | https://www.mux.com/docs/examples.txt |
| Pricing and billing | https://www.mux.com/docs/pricing.txt |
Mux Robots (AI video workflows)
Robots — Mux's AI-powered video workflows — don't have their own collection index; their guides are part of the video collection and the master llms.txt index. Start here:
| Resource | URL |
|---|---|
| Robots overview | https://www.mux.com/docs/guides/robots.md |
| Robots directives reference | https://www.mux.com/docs/guides/robots-directives.md |
Task-specific guides follow the pattern https://www.mux.com/docs/guides/robots-<task>.md, where <task> is one of: summarize, moderate, generate-chapters, ask-questions, find-key-moments, find-scenes, find-best-thumbnails, translate-captions, translate-audio, generate-premium-captions, edit-captions, generate-engagement-insights.
API references and specs
For exact endpoint, parameter, and webhook shapes, prefer these over prose guides:
| Resource | URL |
|---|---|
| Video API reference | https://www.mux.com/docs/api-reference/video.txt |
| Data API reference | https://www.mux.com/docs/api-reference/data.txt |
| System API reference | https://www.mux.com/docs/api-reference/system.txt |
| Full API spec (OpenAPI JSON) | https://www.mux.com/api-spec.json |
| Webhook spec (JSON) | https://www.mux.com/webhook-spec.json |
| Mux Player web component API | https://raw.githubusercontent.com/muxinc/elements/refs/heads/main/packages/mux-player/REFERENCE.md |
| Mux Player React component API | https://raw.githubusercontent.com/muxinc/elements/refs/heads/main/packages/mux-player-react/REFERENCE.md |
All of these resources are also discoverable from the docs site itself: every docs page links to "Docs for LLMs" (https://www.mux.com/docs/core/llms-txt), the canonical page describing Mux's llms.txt files and machine-readable bundles. If this skill's URL lists ever drift from reality, that page is the source of truth.
Self-healing
If a docs URL 404s, the docs have likely been reorganized. Do not give up after one 404: run mux docs find "<topic>" --agent (or fetch https://www.mux.com/llms.txt and search it) to get the page's current URL.
Staying in sync
- This skill is distributed from the
muxinc/skillsrepository and ships embedded in themuxCLI. Updating the CLI (brew upgrade mux/npm update -g @mux/cli) updates the embedded skills, andmux skills updaterefreshes all local copies (including~/.claude/skills) to match the installed version. For skills decoupled from CLI releases, install themux@muxClaude Code plugin or pull directly from https://github.com/muxinc/skills. - The CLI embeds only skill instruction files, never docs content — always fetch docs live using the workflow above. Check
mux skills --helpfor what the installed version offers.
Guardrails
- Cite the docs page URL you answered from.
- If the network is unavailable, say you could not verify against current docs — never guess API request/response shapes from memory.