builder-smoke-test
Smoke test the Agent Builder feature branch end-to-end against a hermetic project scaffolded by the skill (linked to the current…
@mastra-aiInstall SkillDevelopment
Skill
/mastra-docs
Documentation guidelines for Mastra. Use this skill when creating, editing, moving, deleting, or reviewing Mastra documentation, sidebars, redirects, or docs components.
Claude Code
$ npx -y skills add mastra-ai/mastra --skill mastra-docs --agent claude-code
Codex
$ npx skills add mastra-ai/mastra --skill mastra-docs -a codex -y
Cursor
$ npx skills add mastra-ai/mastra --skill mastra-docs -a cursor -y
Gemini CLI
$ npx skills add mastra-ai/mastra --skill mastra-docs -a gemini-cli -y
GitHub Copilot
$ npx skills add mastra-ai/mastra --skill mastra-docs -a github-copilot -y
OpenCode
$ npx skills add mastra-ai/mastra --skill mastra-docs -a opencode -y
Windsurf
$ npx skills add mastra-ai/mastra --skill mastra-docs -a windsurf -y
SKILL.md
mastra-docs.SKILL.mdname: mastra-docs
description: Documentation guidelines for Mastra. Use this skill when creating, editing, moving, deleting, or reviewing Mastra documentation, sidebars, redirects, or docs components.
Mastra documentation guidelines
Follow the most specific `AGENTS.md` and use these references:
1. `references/STYLEGUIDE.md`: ISO 24495-1 plain-language principles, accuracy, links, code, and accessibility. 2. `references/INFORMATION_ARCHITECTURE.md`: Content families, canonical ownership, sidebars, and routes. 3. Choose the page guide:
- `references/DOC.md`: Pages under `/docs`.
- `references/GUIDE_INTEGRATION.md`: Pages under `/integrations`.
- `references/REFERENCE.md`: Pages under `/reference`.
4. `references/COMPONENTS.md`: Shared MDX components and llms-txt markup. 5. `references/DIAGRAM.md`: Mermaid diagram shapes, colors, layout, labels, and accessibility. 6. `references/AUTHORING_WORKFLOW.md`: Editing, moves, deletions, redirects, and verification. 7. `references/CHECKS.md`: The `pnpm check` command, rule IDs, JSON output, and inline `lint` comments for disabling rules.
To replace an existing diagram image with Mermaid, use the `docs-diagrams` skill.
Page templates
When creating a page, pick the template that matches the reader's question:
| Reader question | Template | Typical location | | -------------------------------------------------- | ---------------------------- | ---------------------------------------------- | | "What is this area, and which option fits?" | `templates/overview.md` | `/docs/<category>/overview` | | "What is this capability, and how do I set it up?" | `templates/concept.md` | `/docs/<category>/<feature>` | | "How do I accomplish this specific task?" | `templates/how-to.md` | `/docs/<category>/<task>` | | "What's the fastest way to see it working?" | `templates/quickstart.md` | `## Quickstart` in an overview or concept page | | "What does this API or command accept?" | `templates/reference-api.md` | `/reference/<category>/<api-or-command>` | | "How do I use Mastra with this product?" | `templates/integration.md` | `/integrations/<category>/<product>` |
1. Copy the template's skeleton into the new `.mdx` file and replace every `$PLACEHOLDER`. 2. Compare the result with the template's example page and with neighboring pages. Where the section has an established convention, follow it. 3. Remove optional sections the page doesn't need. 4. Before finishing, run `templates/CHECKLIST.md` and the template's own self-review checklist.
Templates set the starting shape, not a fixed form. Match the reader's task and the conventions of the current section.
Read more
name: mastra-docs description: Documentation guidelines for Mastra. Use this skill when creating, editing, moving, deleting, or reviewing Mastra documentation, sidebars, redirects, or docs components.
Mastra documentation guidelines
Follow the most specific `AGENTS.md` and use these references:
1. `references/STYLEGUIDE.md`: ISO 24495-1 plain-language principles, accuracy, links, code, and accessibility. 2. `references/INFORMATION_ARCHITECTURE.md`: Content families, canonical ownership, sidebars, and routes. 3. Choose the page guide:
- `references/DOC.md`: Pages under `/docs`.
- `references/GUIDE_INTEGRATION.md`: Pages under `/integrations`.
- `references/REFERENCE.md`: Pages under `/reference`.
4. `references/COMPONENTS.md`: Shared MDX components and llms-txt markup. 5. `references/DIAGRAM.md`: Mermaid diagram shapes, colors, layout, labels, and accessibility. 6. `references/AUTHORING_WORKFLOW.md`: Editing, moves, deletions, redirects, and verification. 7. `references/CHECKS.md`: The `pnpm check` command, rule IDs, JSON output, and inline `lint` comments for disabling rules.
To replace an existing diagram image with Mermaid, use the `docs-diagrams` skill.
Page templates
When creating a page, pick the template that matches the reader's question:
| Reader question | Template | Typical location | | -------------------------------------------------- | ---------------------------- | ---------------------------------------------- | | "What is this area, and which option fits?" | `templates/overview.md` | `/docs/<category>/overview` | | "What is this capability, and how do I set it up?" | `templates/concept.md` | `/docs/<category>/<feature>` | | "How do I accomplish this specific task?" | `templates/how-to.md` | `/docs/<category>/<task>` | | "What's the fastest way to see it working?" | `templates/quickstart.md` | `## Quickstart` in an overview or concept page | | "What does this API or command accept?" | `templates/reference-api.md` | `/reference/<category>/<api-or-command>` | | "How do I use Mastra with this product?" | `templates/integration.md` | `/integrations/<category>/<product>` |
1. Copy the template's skeleton into the new `.mdx` file and replace every `$PLACEHOLDER`. 2. Compare the result with the template's example page and with neighboring pages. Where the section has an established convention, follow it. 3. Remove optional sections the page doesn't need. 4. Before finishing, run `templates/CHECKLIST.md` and the template's own self-review checklist.
Templates set the starting shape, not a fixed form. Match the reader's task and the conventions of the current section.
Stats
29,474
Stars
3,092
Forks
Active
Maintenance
TypeScript
Language
Last commit
Created
Ships withmastra
Mastra is a framework for building AI-powered applications and agents with a modern TypeScript stack. It includes everything you need to go from early prototypes to production-ready applications.
29k33 skills
Stars on GitHub
Momentum
- stars in total
- 29.3k
Other skills on mastra.
@mastra-aiInstall Skilldebugging-difficult-bu…
Use early when debugging a medium or hard bug, especially when tests alone may not reveal the real runtime failure. Trigger this…
@mastra-aiInstall Skilldocs-audit
Autonomous, report-only documentation review for Mastra docs. Use when auditing changed docs against source, validating…
@mastra-aiInstall Skilldocs-diagrams
Convert existing docs diagram images to Mermaid, and author new Mermaid diagrams for Mastra docs. Use when replacing an…
@mastra-aiInstall Skille2e-tests-studio
REQUIRED when modifying any file in packages/playground-ui or packages/playground. Triggers on: React component…
@mastra-aiInstall Skilllabel-core-bugs
Review open mastra-ai/mastra GitHub issues, identify direct @mastra/core bugs, and apply the @mastra/core label. Use when…
@mastra-aiInstall SkillMore skills from other plugins.
Auto-invoked
brainstorming
You MUST use this before any creative work - creating features, building components, adding functionality, modifying behavior, or…
@obraInstall Skillask-matt
Ask which skill or flow fits your situation. A router over the skills in this repo.
@mattpocockInstall SkillAuto-invoked
Questions about mastra-docs.
- Which coding agents can use mastra-docs?
- mastra-docs installs in Claude Code, Codex, Cursor, Gemini CLI, GitHub Copilot, OpenCode and Windsurf with the skills CLI, using each agent's flag shown on this page. Flowy's auto-invocation, which fires a skill when your prompt matches, runs in Claude Code only.