Skills Guide

List project documents

VerifiedSafe

Lists all indexed project documents from the MAGS system. Displays them in a grouped tree structure with path and brief description. Useful for quickly browsing project documentation and identifying document locations.

Download and use
Sby Skills Guide Bot
DocumentationBeginner
6/2/2026
Claude Code
#documentation#project-management#document-index#listing

Recommended for

Claude CodeAuto documentation

Automated summary

Lists all indexed project documents grouped by folder with brief descriptions.

Strengths

  • Quick overview of all project documentation
  • Automatic grouping by folder for easy navigation
  • Clear display of paths and descriptions for each document

Limitations

  • Requires documents to be pre-indexed via /mags-init
  • Does not display document content (use /mags-docs-search instead)
When to use it

When you need a structured overview of all available documents in the project.

When not to use it

When you need to search for specific content within documents; use /mags-docs-search instead.

Security analysis

Safe
Quality score85/100

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

No concerns found

How this analysis is made

Examples

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

From the file to a first result

The download contains exactly the content displayed on this page. This copy may differ from the latest version in the source repository.

View the source and supporting files

This download contains SKILL.md only. Any scripts, references, templates and dependencies are not included. Get the required files from the source, preserving their directory structure, before continuing.

1. Download the file

Download SKILL.md

From the root of a test project, save the file as .skill-downloads/list-project-documents-mm78nn1r/SKILL.md, or use the command below. This folder is for inspecting the skill before installation.

Command for macOS/Linux or WSL: requires a POSIX shell and curl. On Windows without WSL, use the download button and create the folder manually.

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. Check prerequisites

Read SKILL.md before using it. If it references scripts or external services, inspect them and prepare the required access in your test environment.

No recognized prerequisites section in this file. This does not mean it is self-contained: libraries, tools and access requirements may be mentioned elsewhere in the content or source repository.

The platforms on this page are catalog indications. The paths below follow tool documentation; they do not prove this skill has been run in those tools. No minimum tool version is confirmed for this listing.

3. Load the skill

After inspection, copy the complete folder into your project using one of the commands below, then open a new tool session. The command stops if a folder with the same name already exists: compare the files before replacing it.

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 must already be installed. The local install/read procedure is checked with OpenSkills 1.5.0, which requires Node.js ≥ 20.6.0. Catalog slugs are not resolved automatically.

Official OpenSkills installation
openskills install './.skill-downloads/list-project-documents-mm78nn1r'

openskills read 'list-project-documents-mm78nn1r'

Reading should display the installed file content and its base directory. It does not run the skill or install its dependencies.

For an agent that reads AGENTS.md, then sync the index. This command changes AGENTS.md: review the diff before using it.

openskills sync

Manual method or another tool: attach SKILL.md to a conversation, or open it in an agent that can read files. Include any required supporting resources. No universal folder is recognized by every tool.

4. Try a first task

Use a short, synthetic input: an API endpoint, a small document or an interface brief. In a new conversation, attach the file or give the agent its path, then adapt this request:

Read .skill-downloads/list-project-documents-mm78nn1r/SKILL.md and apply its instructions to this example: [describe a test input]. Identify any missing files, dependencies or access. Produce the result requested by the skill without inventing data or running unreviewed scripts.

Expected result: output matching the skill instructions, or a precise list of missing prerequisites. A read confirmation alone does not validate a first use. If an external resource is unavailable, that path remains untested.

Related skills

Supabase Docs Authoring

Documentation

Write, edit, and review Supabase documentation content including guides, tutorials, reference docs, and partials. Follow style guides and MDX/TOML validation rules.

Claude CodeintermediateSafe 108,544
Skills Guide Bot

Create Architecture Decision Record

Documentation

Create a new Architecture Decision Record with sequential numbering, register it in the AgentDB graph, and link related ADRs.

Claude CodeintermediateSafe 69,659
Skills Guide Bot

Plan update with deep research

Documentation

Updates a plan document by launching parallel subagents to analyze a topic across all compiler passes, then consolidates findings into the plan doc.

Claude CodeadvancedSafe 248,015
Skills Guide Bot