index-docs

A command for scanning a project's documentation files and maintaining a hierarchical index in docs/index.md.

In plain words
What is it for?
Finding Markdown and text files, adding missing entries, checking broken links, and organizing documentation by folder.
Why use it?
It helps keep the central documentation list complete and its links accurate as files change.

Command for Claude Code

Install

Getting it into your agent

One page per mod, every tool's command on it. A separate URL per tool would split the same page into five that compete with each other.

agentmods
npx agentmods add commands/cakemail/cakemail-api-documentation-mcp/index-docs
Clone the repo
git clone --depth 1 https://github.com/cakemail/cakemail-api-documentation-mcp

Made for: Claude Code.

Per session 0 Only the description is in the session, so the agent can decide to use it. The body loads when it is invoked.
When invoked 1,229 The whole file, excluding the scripts and references it only reads on demand.
Security scan A 0 findings. Scan, not verified.
Origin 98% copy Near-identical to another mod in the catalogue.
Token cost

What it costs to keep this loaded

Counted locally with the o200k_base tokenizer, which is exact for GPT models; Claude uses its own tokenizer and its counts differ. Treat this as one consistent yardstick across the catalogue rather than a bill. Prices are per million input tokens.

ModelPer sessionOnce invoked
Fable 5 $0.00000 $0.01229
Opus 5 $0.00000 $0.00615
Sonnet 5 $0.00000 $0.00246
Haiku 4.5 $0.00000 $0.00123

Measured 2d ago against content hash b2e6a000355f, method: parsed. Prices are Anthropic first-party input rates as of 2026-08-30, from the pricing page.

Security

Grade A, and why

index-docs scanned grade A with 0 findings against 26 rules in 11 categories — prompt injection, anti-refusal, data exfiltration, privilege escalation, supply chain, agent snooping, system-prompt leakage, SSRF and excessive agency — measured 2d ago.

A static scan of the body, not an audit. Every finding is printed with the line that produced it so you can judge whether it matters here. A mod is markdown that instructs an agent; that is exactly why what it instructs is worth reading.

Nothing flagged

None of the 26 patterns this scan looks for appear in this file: no shell pipes, no recursive deletes, no credential paths, no hidden text, no instruction-override or anti-refusal phrasing, no agent-config snooping. That is not a guarantee, it is the absence of the things that are checkable.

Origin

This is a copy

98% identical to index-docs — 2 lines differ, which has more behind it and is treated as the original. This page carries a canonical link to it rather than competing with it.

.claude/commands/BMad/tasks/index-docs.md · 180 lines

How it starts

The opening of the file, as written. The whole thing — 180 lines — stays where its author put it; the contents beside it link to each section on GitHub.

/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

Read the full file on GitHub · 180 lines

Changes

What this file has done since we first saw it

Hashed on every crawl. A supply-chain change to an agent config is a question of when, not whether, so the history is kept rather than the latest state alone.

  1. 2d ago First seen · 180 lines · 0 tokens per session scan A b2e6a000355f

Subscribe to this mod's changes

index-docs is a command published in the GitHub repository cakemail/cakemail-api-documentation-mcp (0 stars, last pushed 11mo ago), licensed MIT. It costs nothing until one of its globs matches a file; then it loads 1,229 tokens. A static security scan graded it A with 0 findings. It is 98% identical to index-docs, differing in 2 lines, and is treated as a copy.