Lister les documents du projet

VérifiéSûr

Liste tous les documents de projet indexés par le système MAGS. Les affiche dans une arborescence groupée avec le chemin et une brève description. Utile pour parcourir rapidement la documentation du projet et localiser les documents.

Spar Skills Guide Bot
DocumentationDébutant
11002/06/2026
Claude Code
#documentation#project-management#document-index#listing

Recommandé pour

Notre avis

Liste tous les documents indexés d'un projet en les regroupant par dossier et en affichant leur description.

Points forts

  • Vision d'ensemble rapide de la documentation du projet
  • Regroupement automatique par dossier pour une navigation aisée
  • Affichage clair des chemins et descriptions de chaque document

Limites

  • Nécessite que les documents soient préalablement indexés via /mags-init
  • Ne permet pas d'afficher le contenu des documents (utiliser /mags-docs-search)
Quand l'utiliser

Lorsque vous avez besoin d'un aperçu structuré de tous les documents disponibles dans le projet.

Quand l'éviter

Lorsque vous recherchez un document spécifique par contenu ou mot-clé ; préférez alors /mags-docs-search.

Analyse de sécurité

Sûr
Score qualité85/100

The skill only lists and retrieves documents using designated tools, with no destructive or exfiltrating actions.

Aucun point d'attention détecté

Exemples

List all project documents
/mags-docs
Show documentation overview
Show all project documents grouped by folder

name: mags-docs description: List all project documents version: 1.0.0 user-invocable: true allowed-tools:

  • mcp__mags_mags__mags_list_docs
  • mcp__mags_mags__mags_get_doc

MAGS Docs

List all indexed project documents.

Usage

/mags-docs

Related Commands

| Command | Purpose | |---------|---------| | /mags-docs-create <template> | Create a new document from template | | /mags-docs-validate | Run document validation checks | | /mags-docs-search <query> | Search across all documents |

Steps

  1. Call mags_list_docs to get all documents.
  2. Display as a grouped tree:
    == Project Documents ==
    
    architecture/
      overview.md          Project architecture overview
      tech-stack.md        Technology stack details
    
    rules/
      coding-standards.md  Coding conventions and rules
      backend.md           Backend development rules
    
    changelog/
      changes.md           Running changelog
    
    Total: <N> documents
    
  3. Show the path and a brief description (first line or title) for each doc.
  4. If no documents are found, say: "No indexed documents found. Run /mags-init to scan your docs/ directory or scaffold new documents from templates."
Skills similaires