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
02/06/2026
Claude Code
#documentation#project-management#document-index#listing

Recommandé pour

Synthèse automatique

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é

Comment cette analyse est faite

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."

Du fichier au premier essai

Le téléchargement contient exactement le contenu affiché sur cette fiche. Cette copie peut différer de la dernière version du dépôt source.

Consulter la source et ses fichiers annexes

Ce téléchargement contient uniquement SKILL.md. Les scripts, références, modèles et dépendances éventuels ne sont pas inclus. Récupérez les fichiers nécessaires depuis la source en conservant leur arborescence avant de poursuivre.

1. Télécharger le fichier

Télécharger SKILL.md

Depuis la racine d’un projet de test, enregistrez le fichier sous .skill-downloads/list-project-documents-mm78nn1r/SKILL.md, ou utilisez la commande suivante. Ce dossier sert à examiner la skill avant son installation.

Commande pour macOS/Linux ou WSL : un shell POSIX et curl sont nécessaires. Sous Windows sans WSL, utilisez le bouton de téléchargement et créez le dossier manuellement.

mkdir -p '.skill-downloads/list-project-documents-mm78nn1r' && curl --fail --show-error --location 'https://skills-guides.com/api/skills/list-project-documents-mm78nn1r/download' --output '.skill-downloads/list-project-documents-mm78nn1r/SKILL.md.part' && mv '.skill-downloads/list-project-documents-mm78nn1r/SKILL.md.part' '.skill-downloads/list-project-documents-mm78nn1r/SKILL.md'

2. Vérifier les prérequis

Lisez SKILL.md avant de l’utiliser. Si le fichier cite des scripts ou services externes, examinez-les et préparez les accès nécessaires dans votre environnement de test.

Aucune section de prérequis reconnue dans ce fichier. Cela ne signifie pas qu’il est autonome : les bibliothèques, outils et accès peuvent être cités ailleurs dans le contenu ou dans le dépôt source.

Les plateformes de la fiche sont des indications du catalogue. Les chemins ci-dessous suivent la documentation des outils ; ils ne prouvent pas que cette skill y a été exécutée. Aucune version minimale de ces outils n’est attestée pour cette fiche.

3. Charger la skill

Après vérification, copiez le dossier complet dans le projet avec l’une des commandes ci-dessous, puis ouvrez une nouvelle session de l’outil. La commande s’arrête si un dossier du même nom existe déjà : comparez les fichiers avant de le remplacer.

Claude Code
test -f '.skill-downloads/list-project-documents-mm78nn1r/SKILL.md' && test -s '.skill-downloads/list-project-documents-mm78nn1r/SKILL.md' && mkdir -p '.claude/skills' && test ! -e '.claude/skills/mags-docs' && cp -R '.skill-downloads/list-project-documents-mm78nn1r' '.claude/skills/mags-docs'

OpenSkills

OpenSkills doit déjà être installé. La procédure locale install/read est contrôlée avec OpenSkills 1.5.0, qui exige Node.js ≥ 20.6.0. Aucun slug du catalogue n’est résolu automatiquement.

Installation officielle d’OpenSkills
openskills install './.skill-downloads/list-project-documents-mm78nn1r'

openskills read 'list-project-documents-mm78nn1r'

La lecture doit afficher le contenu du fichier installé et son dossier de base. Elle ne lance ni la skill ni ses dépendances.

Pour un agent qui lit AGENTS.md, synchronisez ensuite l’index. Cette commande modifie AGENTS.md : relisez le diff avant de l’utiliser.

openskills sync

Mode manuel ou autre outil : joignez SKILL.md à une conversation, ou ouvrez-le dans un agent capable de lire les fichiers. Ajoutez les ressources annexes nécessaires. Il n’existe pas de dossier universel reconnu par tous les outils.

4. Faire un premier essai

Utilisez une entrée courte et fictive : un endpoint d’API, un petit document ou un brief d’interface. Dans une nouvelle conversation, joignez le fichier ou donnez son chemin à l’agent, puis adaptez cette demande :

Lis .skill-downloads/list-project-documents-mm78nn1r/SKILL.md et applique ses instructions à cet exemple : [décrire une entrée de test]. Indique les fichiers, dépendances ou accès qui manquent. Produis le résultat demandé par la skill sans inventer de données ni exécuter de script non examiné.

Résultat attendu : une sortie correspondant aux instructions de la skill, ou une liste précise des prérequis manquants. Une simple confirmation de lecture ne valide pas le premier usage. Si une ressource externe est indisponible, ce parcours reste à tester.

Skills similaires