init_ai_readme
Scans project directories for missing or empty AI_README files, creates root-level guide if absent, and prompts you to document conventions for each path.
Instructions
Initialize and populate empty AI_README files within a project. When to use:
First-time setup when no AI_README exists.
get_context_for_file reports empty or missing AI_README files.
Newly created directories need conventions recorded.
Multiple directories require conventions in one pass. What it does:
Scans for missing or empty AI_README documents.
Creates a root-level AI_README if none is present.
Provides directory-specific prompts to gather conventions.
Guides you through documenting tech stack, patterns, and naming. Workflow:
Call init_ai_readme.
Follow the step-by-step instructions to inspect each directory.
Use update_ai_readme to record the conventions.
Run validate_ai_readmes to check for problems.
Fix any warnings (remove redundant content, add Cross-directory dependencies section).
Re-run get_context_for_file to confirm coverage before coding.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| targetPath | No | Specific directory to initialize (optional, defaults to scanning entire project) | |
| projectRoot | Yes | The root directory of the project. Use the current working directory (e.g., from environment or pwd). If unsure, pass the project root path. | |
| excludePatterns | No | Glob patterns to exclude when scanning |