Get the FREE Ultimate OpenClaw Setup Guide →

mags-help

npx machina-cli add skill doancan/mags/mags-help --openclaw
Files (1)
SKILL.md
2.8 KB

MAGS Help

Display a complete quick-reference of everything MAGS offers.

Steps

1. Display the reference

Present the following reference card directly (no tool calls needed for this step):

== MAGS Quick Reference ==

SLASH COMMANDS (10)
  /mags-help              Show this reference card
  /mags-init              Initialize MAGS for your project
  /mags-status            Project dashboard (docs health, memory, next steps)
  /mags-docs              List all project documents
  /mags-docs-create <t>   Create document from template
  /mags-docs-validate     Run document validation checks
  /mags-docs-search <q>   Search across all documents
  /mags-changelog         Generate changelog from git history
  /mags-setup             Recommend Claude Code configuration
  /mags-legacy            Initialize MAGS for a legacy/brownfield project

AUTO-ACTIVATING SKILLS (7)
  These activate automatically when Claude detects a relevant context:
  - doc-management        Creating or editing project documentation
  - memory-guidance       Storing decisions, conventions, or session context
  - claude-md-management  Working with CLAUDE.md configuration
  - testing-strategy      Planning tests, coverage targets, test pyramid
  - security-review       Security audits, OWASP, threat modeling
  - infrastructure        DevOps, CI/CD, containers, monitoring
  - api-lifecycle         API design, versioning, deprecation

AGENTS (2)
  - doc-sync-validator    Checks if documentation matches actual code
  - setup-recommender     Recommends plugins, skills, and hooks for your stack

HOOKS (1 — automatic, no action needed)
  - SessionStart          Loads project summary on startup

2. Show quick start

Call mags_list_docs to check if any documents exist.

If no documents exist, show:

QUICK START
  1. /mags-init           → Scan docs or scaffold from templates
  2. Tell Claude a decision → "We use JWT for auth" — auto-saved to memory
  3. /mags-status         → See your project dashboard

If documents exist, show:

QUICK START
  You're all set! Try:
  → /mags-status          See project dashboard
  → /mags-docs-validate   Check documentation health
  → "What's next?"        Get recommended next steps

3. Link to full documentation

End with:

DOCUMENTATION
  → Getting Started:      docs/getting-started.md
  → Commands Reference:   docs/commands-reference.md
  → Skills Reference:     docs/skills-reference.md
  → MCP Tools Reference:  docs/tools-reference.md
  → Configuration:        docs/configuration.md

Do not take any further action unless the user asks.

Source

git clone https://github.com/doancan/mags/blob/main/skills/mags-help/SKILL.mdView on GitHub

Overview

Displays a complete quick-reference of all MAGS offerings, including SLASH COMMANDS, AUTO-ACTIVATING SKILLS, AGENTS, and HOOKS. This helps teams quickly understand capabilities and plan setup without digging through docs.

How This Skill Works

The skill presents a static reference card for immediate visibility of MAGS components. It uses the mags_list_docs tool to check for existing project documents and tailors the quick-start flow accordingly, guiding users from a reference to initialization, validation, or documentation links.

When to Use It

  • Onboarding a new team member to MAGS capabilities.
  • Quickly audit available MAGS commands, skills, and hooks before a sprint.
  • Verifying that project documents exist and are up-to-date.
  • Guiding project setup with quick-start paths based on doc presence.
  • Referencing full documentation links to plan customization.

Quick Start

  1. Step 1: Display the MAGS Quick Reference card directly (no tool calls needed).
  2. Step 2: Run mags_list_docs to see if project documents exist and tailor the flow.
  3. Step 3: Review the DOCUMENTATION links for Getting Started and Reference guides.

Best Practices

  • Keep the quick-reference card up to date with the latest SLASH COMMANDS, SKILLS, AGENTS, and HOOKS.
  • Cross-check the listed commands against the current MAGS version before sharing.
  • Use mags_list_docs in Step 2 to tailor onboarding and setup flows.
  • Combine mags-help with the full documentation pages for deeper learning.
  • Regularly validate the reference during releases or config changes.

Example Use Cases

  • A new developer runs mags-help at first login to view all commands.
  • During onboarding, a team uses the reference to map out agents and hooks they will enable.
  • A project lead confirms docs exist by calling mags_list_docs as part of a quick-start check.
  • An engineer uses the documentation links to plan CLAUDE.md and config steps.
  • An ops engineer reviews the skills listed as auto-activating to verify coverage.

Frequently Asked Questions

Add this skill to your agents
Sponsor this space

Reach thousands of developers