Mastra Docs Agent Skill
Documentation guidelines for Mastra. This skill should be used when writing or editing documentation for Mastra. Triggers on tasks involving documentation creation or updates.
Install
one command, takes just this skill from the repositorynpx skills add https://github.com/mastra-ai/mastra --skill mastra-docsWhat comes with it
27 622 bytes besides the instructionThe instruction itself
3 sections, as written by the authorMastra Documentation Guidelines
Use this skill when you create or update Mastra docs. Keep the docs clear and consistent. Follow the most specific AGENTS.md for the area you change. After making your changes to the docs and sidebars, run the linters to check your work.
Styleguides
Start with references/STYLEGUIDE.md for all docs. Then use the guide that matches the content:
- references/DOC.md: General docs that do not fit the categories below
- Choose the right guide for the file's content:
- references/GUIDE_QUICKSTART.md: Quickstarts that help readers get working fast with a specific library or framework
- references/GUIDE_TUTORIAL.md: Tutorials that teach readers how to build something with Mastra
- references/GUIDE_INTEGRATION.md: Integration guides for using Mastra with an external library or ecosystem
- references/GUIDE_DEPLOYMENT.md: Deployment guides for shipping a Mastra app to a platform
- references/REFERENCE.md: Reference and API docs
Linting
Use these tools to keep docs consistent:
- oxfmt: Formats docs code, Markdown, config, and style files through the docs-local config.
- oxfmt-mdx: Formats MDX through the docs-local custom parser so admonitions, JSX expressions, and fenced code blocks remain supported.
- remark: Checks markdown issues like heading levels, list styles, and formatting consistency. This is the middle layer.
- vale: Checks grammar, style, and wording. This is the top layer.
- In order to use Vale, you must download the Vale binary and install
mdx2vastglobally.pnpm run vale:download,npm install -g mdx2vast.
Run these commands in docs/:
- pnpm run format: Format docs files with oxfmt and docs-local oxfmt-mdx
- pnpm run format:check: Check docs formatting with oxfmt and docs-local oxfmt-mdx
- pnpm run lint:remark: Check MDX with Remark
- pnpm run lint:vale:ai: Check prose with Vale using the error alert level
- pnpm run validate: Check frontmatter values and if all sidebars are valid
- pnpm run generate-vercel-redirects: Generate vercel.json redirects after editing vercel.redirects.json
Other skills for the same job
different authors, same section of the catalogue
Guide users through a structured workflow for co-authoring documentation. Use when user wants to write documentation, proposals, technical specs, decision docs, or similar structured content. This workflow helps users efficiently transfer context, refine content through iteration, and verify the doc works for readers. Trigger when user mentions writing docs, creating proposals, drafting specs, or similar documentation tasks.
Automatically creates user-facing changelogs from git commits by analyzing commit history, categorizing changes, and transforming technical commits into clear, customer-friendly release notes. Turns hours of manual changelog writing into minutes of automated generation.
Use when implementing any feature or bugfix, before writing implementation code
Use when you have a spec or requirements for a multi-step task, before touching code
Use when creating new skills, editing existing skills, or verifying skills work before deployment
Use when writing or improving README files. Not all READMEs are the same — provides templates and guidance matched to your audience and project type.
| Remove signs of AI-generated writing from text. Use when editing or reviewing text to make it sound more natural and human-written. Based on Wikipedia's inflated symbolism, promotional language, superficial -ing analyses, vague attributions, em dash overuse, rule of three, AI vocabulary words, negative parallelisms, and excessive conjunctive phrases.
Official Opentrons Protocol API for OT-2 and Flex robots. Use when writing protocols specifically for Opentrons hardware with full access to Protocol API v2 features. Best for production Opentrons protocols, official API compatibility. For multi-vendor automation or broader equipment control use pylabrobot.
How to use it
Take mastra-ai/mastra-docs from the repository into ~/.claude/skills for personal
use, or into .claude/skills inside a project.
The agent identifies a skill by the name field in its header. Two skills with the
same name cannot sit side by side — one of them will be ignored.
The instructions reference npm.
Without those the skill loads but fails at the first command.