mcpField
B
bmad-index-docs

bmad-index-docs

github.com/bmad-code-orgDocuments54.7k259 installsUpdated 1w ago
Repository

About bmad-index-docs

A skill that creates or updates `index.md` for a target directory by scanning its contents, grouping files, and writing concise descriptions based on their contents. It is for users organizing documentation directories.

Key features

  1. 01Scan files and subdirectories
  2. 02Group files by type or purpose
  3. 03Write content-based descriptions
  4. 04Create or update index.md
  5. 05Sort entries and use relative paths

Use cases

  1. 01Creating an index for a documentation folder
  2. 02Updating directory listings after files change

Install

Copy the command and run it in a terminal.

$npx skills add https://github.com/bmad-code-org/bmad-method --skill bmad-index-docs

After installing, type/bmad-index-docsin Claude Code to confirm it loaded.

Details

From the project README

Index Docs

Goal: Generate or update an index.md to reference all docs in a target folder.

EXECUTION

Step 1: Scan Directory
  • List all files and subdirectories in the target location
Step 2: Group Content
  • Organize files by type, purpose, or subdirectory
Step 3: Generate Descriptions
  • Read each file to understand its actual purpose and create brief (3-10 word) descriptions based on the content, not just the filename
Step 4: Create/Update Index
  • Write or update index.md with organized file listings

OUTPUT FORMAT

# Directory Index

## Files

- **[filename.ext](./filename.ext)** - Brief description
- **[another-file.ext](./another-file.ext)** - Brief description

## Subdirectories

### subfolder/

- **[file1.ext](./subfolder/file1.ext)** - Brief description
- **[file2.ext](./subfolder/file2.ext)** - Brief description

### another-folder/

- **[file3.ext](./another-folder/file3.ext)** - Brief description

HALT CONDITIONS

  • HALT if target directory does not exist or is inaccessible
  • HALT if user does not have write permissions to create index.md

VALIDATION

  • Use relative paths starting with ./
  • Group similar files together
  • Read file contents to generate accurate descriptions - don't guess from filenames
  • Keep descriptions concise but informative (3-10 words)
  • Sort alphabetically within groups
  • Skip hidden files (starting with .) unless specified

Comments

Markdown supported