Skip to main content
skill CX Codex

mastra-docs — Claude Code skill for Mastra documentation

The mastra-docs Claude Code skill sets guidelines for Mastra documentation. It activates when creating or reviewing pages, sidebars, redirects, and documentation components.

Apache-2.0 165 installs ★ 29,724 updated 2026-11-14

Install into Claude Code · Skills CLI (Vercel) All methods and platforms ↓
npx skills add mastra-ai/mastra --skill mastra-docs -a claude-code
Open on GitHub

What mastra-docs does

mastra-docs guides the creation, editing, moving, deletion, and review of Mastra documentation. Its scope includes pages, sidebars, redirects, and documentation components.

The skill points to references for style, information architecture, page types, MDX components, diagrams, and editing workflows. For a new page, it maps the reader’s question to a template, then calls for comparison with examples and nearby pages. Templates provide a starting structure, not a fixed form.

Run pnpm check to check documentation rules; inline lint comments can disable individual rules. Replacing a diagram image with Mermaid uses the separate docs-diagrams skill.

What it helps with

  • create a Mastra documentation page from a suitable template
  • choose a route and content family for a new page
  • move a page and handle its redirects
  • check documentation components and rules

Example prompts for the agent

  • Create a Mastra page explaining how to set up a feature, using the appropriate template.
  • Review the Mastra docs and run pnpm check.
  • Move this documentation page and handle its redirects.

How to install mastra-docs

1Skills CLI (Vercel)

npx skills add mastra-ai/mastra --skill mastra-docs -a claude-code

2Manually: put the files in place

~/.claude/skills/mastra-docs/SKILL.md

Copy the whole skill folder; for one project use .claude/skills/mastra-docs/

Step by step, with commands for each platform: How to install skills in Claude Code: five ways

Questions about mastra-docs

How do I install mastra-docs in Claude Code?

Run npx skills add mastra-ai/mastra --skill mastra-docs -a claude-code. The skill file is at ~/.claude/skills/mastra-docs/SKILL.md.

What does mastra-docs do?

It provides guidelines for creating and reviewing Mastra documentation, including pages, sidebars, redirects, and components. It also helps select a page template based on the reader’s task.

How does mastra-docs choose a page template?

Templates correspond to reader questions. For example, templates/how-to.md is for a specific task, while templates/reference-api.md covers an API or command.

Source text

SKILL.md · Apache-2.0
---
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.

© mastra-ai · Apache-2.0 · mastra-ai/mastra

Similar skills

All skills for Writing and docs →

From the same set6

Project sponsors

Companies that keep this analytics open