Index Docs

Generates or updates an index.md to reference all docs in the folder.

You say
Install this skill Read the source first Free Written by bmad-code-org · unverified publisher
Context cost
400 tokensestimated from the bundle, loaded when it triggers
Bundle
1 file · 1.6 kBtext throughout, nothing executable
Licence
MITfree to use
Last change
no release on file
Servers it uses
Noneruns standalone

What it does

Generates or updates an index.md to reference all docs in the folder. Use if user requests to create or update an index of all files in a specific folder

Installed, it changes the agent in these ways.

What this skill changes about the agent is not written down here yet. The listing was collected from its source, and the description is in its own SKILL.md.

Workflow

Runs a procedure end to end.

content

The skill itself

This is the whole product. A skill is instructions the model reads, so there is nothing behind the listing you cannot see first — the front matter loads with every session, and the body below it loads when the skill triggers.

SKILL.md1.6 kB · 67 lines
--- name: bmad-index-docs description: 'Generates or updates an index.md to reference all docs in the folder. Use if user requests to create or update an index of all files in a specific folder' ---
6# Index Docs
7
8**Goal:** Generate or update an index.md to reference all docs in a target folder.
9
10
11## EXECUTION
12
13### Step 1: Scan Directory
14
15- List all files and subdirectories in the target location
16
17### Step 2: Group Content
18
19- Organize files by type, purpose, or subdirectory
20
21### Step 3: Generate Descriptions
22
23- Read each file to understand its actual purpose and create brief (3-10 word) descriptions based on the content, not just the filename
24
25### Step 4: Create/Update Index
26
27- Write or update index.md with organized file listings
28
29
30## OUTPUT FORMAT
31
32```markdown
33# Directory Index
34
35## Files
36
37- **[filename.ext](./filename.ext)** - Brief description
38- **[another-file.ext](./another-file.ext)** - Brief description
39
40## Subdirectories
41
42### subfolder/
43
44- **[file1.ext](./subfolder/file1.ext)** - Brief description
45- **[file2.ext](./subfolder/file2.ext)** - Brief description
46
47### another-folder/
48
49- **[file3.ext](./another-folder/file3.ext)** - Brief description
50```
51
52
53## HALT CONDITIONS
54
55- HALT if target directory does not exist or is inaccessible
56- HALT if user does not have write permissions to create index.md
57
58
59## VALIDATION
60
61- Use relative paths starting with ./
62- Group similar files together
63- Read file contents to generate accurate descriptions - don't guess from filenames
64- Keep descriptions concise but informative (3-10 words)
65- Sort alphabetically within groups
66- Skip hidden files (starting with .) unless specified
67
In the file
SKILL.md239 words
Files1
LicenceMIT
Why you can read it

Nothing in a skill executes. The client loads the text and the model follows it, so a skill can be audited the way a runbook is — by reading it.

What it costs in context

Skills are not billed by the call. They are paid for in context: every token the instructions occupy is a token your code, your diff and your conversation cannot use. Here is what this one takes and when it takes it.

≈50
always loaded
The name and description, so the model knows the skill exists and when to reach for it.
350
on trigger
The instruction body, read only when the skill fires.
0.20%
of a 200k window
Ten skills this size would take about 2% of the window before you open a file.
050k100k150k200k context window

400 tokens, estimated from the bundle at four bytes to the token, held for the rest of the session once it triggers. Small enough to keep loaded permanently without thinking about it.

Servers bill, skills cost

A server charges by the month. A skill charges once per session, in context, and then keeps charging it for as long as the session lives.

Before and after

The same question, put to the same model twice: once as it comes, and once with these instructions loaded.

No worked example has been published for this skill yet.

Adoption
Installsnone yet
Ratingno reviews yet

The procedure it runs

The procedure has not been published here. It is in the skill’s own SKILL.md, which its author has not sent to the marketplace yet.

Prose, not code

These steps are written for a model to follow, not executed by a runtime. It can still be told to skip one, and it will say so when it does.

Servers it uses

None. This skill calls no MCP servers at all.

Everything it needs is in the instructions, so it works in a project with nothing connected — the model reads the file and changes how it works with what it can already reach.

It writes no files and reaches no network. All it changes is how the model reasons and writes.

What it asks for
Writes filesno
Network accessno

Read from the allowed-tools line of this skill’s own SKILL.md. A skill grants no permissions of its own — it can only ask for tools your client already has.

What it will not do

Every skill is narrow, and the useful ones say where they stop. These are the jobs this one is the wrong tool for.

What this skill is not for has not been published here. Nothing is implied by that: it is a section the author has not filled in.

What is in the bundle

1 file, 1.6 kB on disk. A bundle is text throughout: the instructions the model reads, plus the templates it fills in.

  • SKILL.md1.6 kB
What is not in it

No dependencies and nothing executable: a skill is text the agent reads, so the bundle is 1 file you can review in full before installing. The MIT licence covers the templates and examples as well as the instructions.

Install

Installing copies the bundle into your project. Nothing runs at install time — the files sit on disk until the model reads them.

# Index Docs · 400 tokens when loaded npx mcprush@latest skill add bmad-code-org/index-docs

Writes to .claude/skills/index-docs/ in the current project. Add --global to put it in your home directory instead, for every project.

Which clients pick it up on their own

A skill is a folder of text. A client with a skills folder reads it without being told; everywhere else the same text works, it is just handed to the model rather than found.

Claude Code.claude/skills/
Claude Desktop
ChatGPT
Cursor.cursor/skills/
VS Code.github/skills/
Codex CLI.agents/skills/
Gemini CLI.gemini/skills/
Grok.grok/skills/
Zed.agents/skills/
Windsurf.windsurf/skills/
Agent SDK.claude/skills/
HTTP / API
This release
Versionnot versioned
Publishedno release date on file
PriceFree
Referencebmad-code-org/index-docs

Versions

Its author publishes no version number, so there is nothing here to pin to: what you install is the folder as it stands today. Instructions change more often than APIs do — a skill can be rewritten entirely without anything it depends on moving.

v
  • No earlier releases have been published to the marketplace.
Pinning

Nothing to pin to: this skill carries no version number of its own. What you install is what the folder holds on the day you install it.

Reviews

no reviews yet · no installs yet

Nobody has reviewed this skill yet. The rating is the mean of the reviews written here, so there is none until somebody writes the first.

Who can post

Only accounts that have had the skill installed for fourteen days, so a review is written after living with it rather than after reading it. Publishers may reply once.

Publisher
Servers0