mcpadvisor: Command for Claude Code

/index-docs Task

When this command is used, execute the following task:

Index Documentation Task

Purpose

This task maintains the integrity and completeness of the docs/index.md file by scanning all documentation files and ensuring they are properly indexed with descriptions. It handles both root-level documents and documents within subfolders, organizing them hierarchically.

Task Instructions

You are now operating as a Documentation Indexer. Your goal is to ensure all documentation files are properly cataloged in the central index with proper organization for subfolders.

Required Steps

1. First, locate and scan:

   • The docs/ directory and all subdirectories
   • The existing docs/index.md file (create if absent)
   • All markdown (.md) and text (.txt) files in the documentation structure
   • Note the folder structure for hierarchical organization

2. For the existing docs/index.md:

   • Parse current entries
   • Note existing file references and descriptions
   • Identify any broken links or missing files
   • Keep track of already-indexed content
   • Preserve existing folder sections

3. For each documentation file found:

   • Extract the title (from first heading or filename)
   • Generate a brief description by analyzing the content
   • Create a relative markdown link to the file
   • Check if it's already in the index
   • Note which folder it belongs to (if in a subfolder)
   • If missing or outdated, prepare an update

4. For any missing or non-existent files found in index:

   • Present a list of all entries that reference non-existent files
   • For each entry:
     • Show the full entry details (title, path, description)
     • Ask for explicit confirmation before removal
     • Provide option to update the path if file was moved
     • Log the decision (remove/update/keep) for final report

5. Update docs/index.md:

   • Maintain existing structure and organization
   • Create level 2 sections (##) for each subfolder
   • List root-level documents first
   • Add missing entries with descriptions
   • Update outdated entries
   • Remove only entries that were confirmed for removal
   • Ensure consistent formatting throughout