Agent skill

Docs Audit

by mastra-ai in mastra-ai/mastra

Autonomous, report-only documentation review for Mastra docs.

Custom licenceAuto-check passed

Install Docs Audit

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

Project install by default; add -g for ~/.claude/skills/.

GitHub CLI
$ gh skill install mastra-ai/mastra docs-audit --agent claude-code

Project scope by default; add --scope user for a personal install. Needs GitHub CLI 2.90.0 or later (public preview).

Manual copy
$ git clone --depth 1 https://github.com/mastra-ai/mastra.git skills-src && mkdir -p .claude/skills && cp -r skills-src/.claude/skills/docs-audit .claude/skills/docs-audit && rm -rf skills-src

Use ~/.claude/skills/ instead of .claude/skills for a personal install. The folder must contain SKILL.md.

Claude Code skills documentation · loads skills from .claude/skills/

Facts

Skill name
docs-audit
GitHub stars
29k
Token cost
~3k tokens
SKILL.md length
1,552 words
Files
4 (incl. scripts, references)
Skills in repo
44
Repo updated
First seen
Licence
Custom licence

At a glance

Autonomous, report-only documentation review for Mastra docs.

  • Works in 8 steps: Determine the complete audit scope → Classify every page and map canonical… → Plan a bounded evidence pass → …
  • Auditing changed docs against source
  • SKILL.md covers Load first, Autonomous workflow, Rules and References, plus 1 more section
  • Runs Shell scripts from its folder; calls bash

What it does

Docs Audit is an agent skill from mastra-ai/mastra. Autonomous, report-only documentation review for Mastra docs. Use when auditing changed docs against source, validating contextual code examples or API coverage, checking canonical mastra-docs guidance, or running narrow deterministic checks.

Its SKILL.md is about 3k tokens, which your agent loads only when the skill is triggered. The skill folder holds 5 other files, including scripts and reference files (for example `references/AUDIT-REPORT.md`, `references/RUBRIC.md` and `scripts/run-checks.sh`).

It works with Mastra. The repository describes itself as: Mastra is the modern TypeScript framework for AI-powered applications and agents.

When your agent uses it

  • Auditing changed docs against source
  • Validating contextual code examples
  • Checking canonical mastra-docs guidance
  • Running narrow deterministic checks

Example prompts

  • “/docs-audit”

Requirements

  • A Bash shell

Workflow steps

8 steps, taken from the step headings in SKILL.md.

  1. Determine the complete audit scope
  2. Classify every page and map canonical guidance
  3. Plan a bounded evidence pass
  4. Establish source truth narrowly
  5. Verify every code block contextually
  6. Check page-specific completeness
  7. Run narrow deterministic checks
  8. Report and stop

What it can do on your machine

Read from SKILL.md and the folder at commit 4d0056f. It shows what the files ask for, not the result of running them.

  • Tool permissions

    Pre-approves nothing: there is no allowed-tools line, so your agent's usual permission prompts apply.

    From allowed-tools in the SKILL.md frontmatter.

  • Runs code

    Ships 1 file in scripts/ (Shell), which the agent can run.

    Shell commands in SKILL.md call:

    • bash

    From the folder's file list and the shell code blocks in SKILL.md.

  • Network

    No URLs in SKILL.md.

    From URLs in SKILL.md, links to its own repository left out.

  • Credentials

    Names no API keys, tokens, secrets or passwords.

    From names ending in _API_KEY, _TOKEN, _SECRET, _KEY or _PASSWORD in SKILL.md.

Context cost

Docs Audit loads about 3k tokens when it runs, and up to ~6k if it reads all its reference files. Until then it costs about 63 tokens; SKILL.md has 1,552 words of instructions outside code blocks.

Always · name and description, kept in context so the agent knows when to use it
~63
When it runs · the whole SKILL.md, loaded when a task matches
~3k
With references · SKILL.md plus every file in references/, read only if the agent opens them
~6k

Estimates: characters ÷ 4, the usual rule of thumb; real counts depend on the model's tokenizer. Scripts and assets cost tokens only if the agent reads them.

Safety

Auto-check passed

The automated check found no risky patterns in SKILL.md.

Automated static check — not a guarantee. Review scripts before installing. It scans the text of SKILL.md for risky patterns (piping downloads into a shell, reading credential files, hidden Unicode, destructive commands); the scripts in this folder are not scanned.

SKILL.md

Its licence (Custom licence) doesn't allow us to republish the file, so here is its outline and opening line. It has 1,552 words (~3,018 tokens).

“Audit Mastra documentation autonomously against source, the canonical mastra-docs guidance, and narrow deterministic checks. This skill is for report-only reviews. Do not edit documentation, ask the user to select jobs, or submit a fix plan unless the user separately requests…”

— opening of SKILL.md by mastra-ai, Custom licence
name
docs-audit

Read the full SKILL.md on GitHub

Files

SKILL.md and 3 other files (scripts, references) in .claude/skills/docs-audit of mastra-ai/mastra.

  • SKILL.md
  • references/AUDIT-REPORT.md
  • references/RUBRIC.md
  • scripts/run-checks.sh

Open the folder on GitHubat commit 4d0056f

Compare with similar skills

Docs Audit next to the 5 skills that share the most tags, products or categories with it. Stars are the repository's; “used in” counts other GitHub owners with a copy.

Docs Audit compared with similar skills
SkillStarsUsed inTokensAuto-checkLicenceRepo updated
Docs Audit this skillmastra-ai/mastra29k—~3kAutomated safety check: PassCustom licence
Pensieve Searcharkohut/pensieve1.4k—~8.2kAutomated safety check: PassApache-2.0
MastraLiorVainer/data-israel1302 repos~1.6kAutomated safety check: PassApache-2.0
Mastra File Agentsshadcn-labs/agentcn490—~2.4kAutomated safety check: PassMIT
Changelogratel-ai/ratel469—~1.6kAutomated safety check: PassMIT
Mastra Integrationhelloxz/znote104—~643Automated safety check: PassAGPL-3.0

Similar skills

  • Pensieve Search

    arkohut/pensieve

    Search the user's local Pensieve screenshot archive by text, app, or time range.

    1.4k GitHub stars~8.2k tokensUpdated 2 mo ago
    Data & AnalyticsAuto-check passed
  • Mastra

    LiorVainer/data-israel

    Comprehensive Mastra framework guide. An agent skill from LiorVainer/data-israel.

    130 GitHub starsUsed in 2 repos~1.6k tokens
    AI & LLM EngineeringAuto-check passed
  • Mastra File Agents

    shadcn-labs/agentcn

    Migrate Mastra code-based agents (agents built with new Agent(...) and registered in a Mastra({ agents }) map) to the file-based convention: one directory per agent under src/mastra/agents.

    490 GitHub stars~2.4k tokensUpdated 2 days ago
    Auto-check passed
  • Changelog

    ratel-ai/ratel

    Update per-package CHANGELOG.md files for a Ratel release. An agent skill from ratel-ai/ratel.

    469 GitHub stars~1.6k tokensUpdated 2 days ago
    DevelopmentAuto-check passed
  • Mastra Integration

    helloxz/znote

    Mastra AI framework integration guide for building TypeScript agents with skills, workflows, and memory

    104 GitHub stars~643 tokensUpdated 1 mo ago
    AI & LLM EngineeringAuto-check passed
  • Official

    Migrate TypeScript Mastra applications to Python with Pydantic AI and, only when needed, Pydantic AI Harness.

    20k GitHub stars~2k tokensUpdated today
    Agent WorkflowsAuto-check passed

More from mastra-ai/mastra

All 44 skills in this repo
  • Builder Smoke Test

    mastra-ai/mastra

    Smoke test the Agent Builder feature branch end-to-end against a hermetic project scaffolded by the skill (linked to the current worktree).

    29k GitHub stars~11k tokensUpdated today
    Auto-check: notes
  • Mastra Smoke Test

    mastra-ai/mastra

    Smoke test Mastra projects locally or deploy to staging/production.

    29k GitHub stars~4k tokensUpdated today
    Auto-check: notes
  • React Best Practices

    mastra-ai/mastra

    React performance optimization guidelines from Mastra Engineering.

    29k GitHub stars~1.9k tokensUpdated today
    Auto-check passed
  • Agent Prompt Quality Bar

    mastra-ai/mastra

    Universal quality bar and final audit rubric for any agent system prompt.

    29k GitHub stars~2k tokensUpdated today
    Auto-check passed
  • Coding Agent

    mastra-ai/mastra

    Authoring playbook for building agents that write, edit, review, or refactor code.

    29k GitHub stars~2.3k tokensUpdated today
    Auto-check passed
  • Content Writer Agent

    mastra-ai/mastra

    Authoring playbook for building agents that draft written content — blog posts, marketing copy, social media posts, newsletters, product descriptions, landing pages, or ad copy.

    29k GitHub stars~1.3k tokensUpdated today
    Auto-check passed

Works with

Questions about Docs Audit

What does Docs Audit do?

Autonomous, report-only documentation review for Mastra docs. Docs Audit is an agent skill from mastra-ai/mastra. Autonomous, report-only documentation review for Mastra docs.

When should I use Docs Audit?

Docs Audit fits situations like: auditing changed docs against source; validating contextual code examples; checking canonical mastra-docs guidance; running narrow deterministic checks.

How do I install Docs Audit in Claude Code?

Run `npx skills add mastra-ai/mastra --skill docs-audit -a claude-code`. Or copy the skill folder (.claude/skills/docs-audit in mastra-ai/mastra) into .claude/skills/docs-audit in your project. Claude Code loads it when a task matches its description.

How do I install Docs Audit in Codex?

Run `npx skills add mastra-ai/mastra --skill docs-audit -a codex`. Or copy the skill folder (.claude/skills/docs-audit in mastra-ai/mastra) into .agents/skills/docs-audit in your project. Codex loads it when a task matches its description.

Can I use Docs Audit in Cursor, Gemini CLI or GitHub Copilot?

Cursor, Gemini CLI, GitHub Copilot and OpenCode also load SKILL.md folders. With the skills CLI, run `npx skills add mastra-ai/mastra --skill docs-audit -a cursor` (or -a gemini-cli, github-copilot or opencode for the others). To copy it by hand, put the folder in .cursor/skills/docs-audit, .gemini/skills/docs-audit, .github/skills/docs-audit and .opencode/skills/docs-audit in your project.

What does Docs Audit need to run?

Going by SKILL.md and its folder, Docs Audit needs a shell for the scripts in its folder and the command-line tools its instructions call (bash). Our summary lists: A Bash shell.

Does Docs Audit access the network?

SKILL.md contains no URLs. Any network use would come from the scripts or tools the agent runs. This is read from the text; nothing was executed.

Is Docs Audit safe to install?

Our automated static check of SKILL.md found no risky patterns, such as piping downloads into a shell, reading credential files or hidden Unicode. It is not a guarantee. The check reads SKILL.md only: the scripts in the folder are not scanned, so read them before running anything.

What licence does Docs Audit use?

Docs Audit has a licence file (the repository's licence) that doesn't match a standard licence. Read it on GitHub before reusing the skill.

How many tokens does Docs Audit use?

About 3k tokens (SKILL.md is roughly 12k characters). Agents keep only the skill's name and description in context until a task matches; then they load SKILL.md in full. Its references folder adds about 3k tokens, read only when the agent opens those files.

What are the alternatives to Docs Audit?

Skills that share tags, products or a category with Docs Audit: Pensieve Search (arkohut/pensieve, 1.4k stars), Mastra (LiorVainer/data-israel, 130 stars), Mastra File Agents (shadcn-labs/agentcn, 490 stars) and Changelog (ratel-ai/ratel, 469 stars). The comparison table on this page puts their stars, adoption, token cost, safety result and licence side by side.

Who maintains Docs Audit?

mastra-ai (a GitHub organization) maintains it in mastra-ai/mastra, which has 28,655 GitHub stars. The repository holds 44 skills in this directory. The repository was last updated on October 9, 2026.

Source: mastra-ai/mastra on GitHub. Facts on this page come from the repository at the commit we read; the author's words are quoted as theirs.