Our review
Validates project documentation by running checks on frontmatter, required sections, cross-references, and freshness, with an optional deep mode that also detects version conflicts, ensures memory-doc consistency, validates ADR structure, and checks module completeness.
Strengths
- Catches structural issues and inconsistencies in documentation
- Offers two validation levels (standard and deep) tailored to needs
- Can automatically fix identified errors after user approval
- Includes advanced checks such as memory-doc consistency and ADR structure
Limitations
- Relies on MAGS tools and specific project structure
- Deep mode may be slower on large projects
- Does not verify factual accuracy or writing quality of content
Use this skill when you need to ensure project documentation adheres to defined standards and is up-to-date before a release or review.
Avoid using it for ad-hoc writing or when documentation does not yet follow a defined validation schema.
Security analysis
SafeThe skill uses only MCP documentation tools (validate_docs, get_doc, update_doc) and asks for user confirmation before modifying documents. It does not execute shell commands, access external networks, or handle sensitive data.
No concerns found
Examples
/mags-docs-validatename: mags-docs-validate description: Validate project documentation version: 1.0.0 user-invocable: true allowed-tools:
- mcp__mags_mags__mags_validate_docs
- mcp__mags_mags__mags_get_doc
- mcp__mags_mags__mags_update_doc
MAGS Docs Validate
Run validation checks on all project documents.
Usage
/mags-docs-validate
Steps
-
Ask the user: "Standard validation or deep validation?"
- Standard — checks frontmatter, required sections, cross-references, freshness
- Deep — all standard checks plus: version conflict detection, memory-doc consistency, ADR structure validation, and module completeness checks
If deep: call
mags_validate_docswithdeep: true. If standard (or no preference): callmags_validate_docswith default parameters. -
Display results grouped by severity:
== Document Validation == Errors (must fix): - docs/architecture/overview.md: Missing required section "Tech Stack" - docs/rules/backend.md: Broken internal link to ../api/auth.md Warnings (should fix): - docs/modules/auth.md: No code examples found - docs/changelog/changes.md: Last updated over 30 days ago Passed: <N>/<total> documents are healthy -
If there are errors, ask: "Would you like me to fix the errors?"
-
If yes, read each problematic doc with
mags_get_doc, fix the issues, and callmags_update_doc.
Related commands:
| Command | Description |
|---------|-------------|
| /mags-docs | List all project documents |
| /mags-docs-search <query> | Search across all documents |
API Documentation Generator
Documentation
Automatically generates OpenAPI/Swagger API documentation.
Technical Writer
Documentation
Writes clear technical documentation following top style guides.
Pivot Decision Framework
Documentation
Documents a strategic pivot or persevere decision with evidence, analysis, and rationale. Use when evaluating whether to change direction on a product, feature, or strategy based on market feedback.