Agent Skills
› terryso/open-agent-sdk-swift
› bmad-index-docs
bmad-index-docs
GitHub扫描指定目录下的文件和子目录，读取内容生成简要描述，并创建或更新index.md文件以建立文档索引。
Trigger Scenarios
用户请求创建或更新文件夹的文档索引
需要整理和列出目录下所有文件的链接
Install
npx skills add terryso/open-agent-sdk-swift --skill bmad-index-docs -g -y
SKILL.md
Frontmatter
{
"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"
}
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
Version History
- 0.12.0 Current 2026-07-24 22:36
