ai-readme-mcp 0.4.0 → 0.4.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +11 -10
- package/package.json +1 -1
- package/docs/templates/basic.md +0 -55
package/README.md
CHANGED
|
@@ -66,9 +66,7 @@ This MCP (Model Context Protocol) server automates the entire workflow:
|
|
|
66
66
|
|
|
67
67
|
---
|
|
68
68
|
|
|
69
|
-
## 🚀
|
|
70
|
-
|
|
71
|
-
### Installation
|
|
69
|
+
## 🚀 Installation
|
|
72
70
|
|
|
73
71
|
**Option 1: Using npx (Recommended)**
|
|
74
72
|
|
|
@@ -263,11 +261,13 @@ Add to `claude_desktop_config.json`:
|
|
|
263
261
|
}
|
|
264
262
|
```
|
|
265
263
|
|
|
266
|
-
|
|
264
|
+
---
|
|
265
|
+
|
|
266
|
+
## Create Your First AI_README
|
|
267
267
|
|
|
268
268
|
You have two main approaches to create and populate AI_README files:
|
|
269
269
|
|
|
270
|
-
|
|
270
|
+
### Option 1: Automated Initialization (Recommended)
|
|
271
271
|
|
|
272
272
|
Use the `init_ai_readme` tool to automatically scan and populate empty AI_README files:
|
|
273
273
|
|
|
@@ -306,7 +306,7 @@ Or more explicitly:
|
|
|
306
306
|
- When `get_context_for_file` detects empty AI_README files
|
|
307
307
|
- To batch-process multiple empty AI_README files
|
|
308
308
|
|
|
309
|
-
|
|
309
|
+
### Option 2: Manual Creation
|
|
310
310
|
|
|
311
311
|
Create and write AI_README.md files yourself:
|
|
312
312
|
|
|
@@ -340,7 +340,9 @@ Write tests alongside source files
|
|
|
340
340
|
- Update as your project evolves
|
|
341
341
|
- Use AI to help maintain it
|
|
342
342
|
|
|
343
|
-
|
|
343
|
+
---
|
|
344
|
+
|
|
345
|
+
## Multi-Level AI_README (Not Just for Monorepos!)
|
|
344
346
|
|
|
345
347
|
**The power of this tool is multi-level documentation** - not just for monorepos, but for **any project** that wants to organize conventions by module or feature.
|
|
346
348
|
|
|
@@ -690,9 +692,8 @@ Validate all AI_README.md files in your project for quality and token efficiency
|
|
|
690
692
|
|
|
691
693
|
We're actively working on new features:
|
|
692
694
|
|
|
693
|
-
- **
|
|
694
|
-
- **
|
|
695
|
-
- **VSCode Extension** - Visual interface for managing AI_README files
|
|
695
|
+
- **Auto-populate Empty AI_README** - Automatically generate AI_README content when `get_context_for_file` detects empty files, reducing manual initialization steps
|
|
696
|
+
- **Enhanced Tool Triggering** - Improve tool descriptions and prompts to ensure AI assistants trigger tools at the right moments with better precision and reliability
|
|
696
697
|
- **CI/CD Integration** - GitHub Actions for automated README validation
|
|
697
698
|
|
|
698
699
|
Want to contribute? Check out our [Contributing Guide](./CONTRIBUTING.md)!
|
package/package.json
CHANGED
package/docs/templates/basic.md
DELETED
|
@@ -1,55 +0,0 @@
|
|
|
1
|
-
# {{PROJECT_NAME}}
|
|
2
|
-
|
|
3
|
-
Brief description of this module or component.
|
|
4
|
-
|
|
5
|
-
## Architecture
|
|
6
|
-
|
|
7
|
-
- **Type:** [Library/Service/Application/Component]
|
|
8
|
-
- **Language:** [TypeScript/JavaScript/Python/Java/Go/Rust/etc]
|
|
9
|
-
- **Framework:** [React/Vue/Django/Spring/Gin/etc]
|
|
10
|
-
|
|
11
|
-
## Directory Structure
|
|
12
|
-
|
|
13
|
-
- Main entry: [path]
|
|
14
|
-
- Core logic: [path]
|
|
15
|
-
- Utilities: [path]
|
|
16
|
-
|
|
17
|
-
## Coding Conventions
|
|
18
|
-
|
|
19
|
-
### File Naming
|
|
20
|
-
- [snake_case/camelCase/PascalCase/kebab-case]
|
|
21
|
-
|
|
22
|
-
### Code Style
|
|
23
|
-
- Formatting: [Prettier/Black/gofmt/rustfmt/etc]
|
|
24
|
-
- Linting: [ESLint/Pylint/golangci-lint/Clippy/etc]
|
|
25
|
-
|
|
26
|
-
### Important Patterns
|
|
27
|
-
- Key architectural patterns or design decisions
|
|
28
|
-
- Project-specific best practices
|
|
29
|
-
- Common patterns to follow
|
|
30
|
-
|
|
31
|
-
## Testing
|
|
32
|
-
|
|
33
|
-
- **Framework:** [Jest/Pytest/JUnit/Go testing/etc]
|
|
34
|
-
- **Run Command:** [command]
|
|
35
|
-
- **Coverage Target:** [percentage or "not enforced"]
|
|
36
|
-
|
|
37
|
-
## Dependencies
|
|
38
|
-
|
|
39
|
-
### Key Libraries
|
|
40
|
-
- [Library name] - Purpose and why used
|
|
41
|
-
- [Library name] - Purpose and why used
|
|
42
|
-
|
|
43
|
-
## Development Workflow
|
|
44
|
-
|
|
45
|
-
- Installation: [command]
|
|
46
|
-
- Dev mode: [command]
|
|
47
|
-
- Build: [command]
|
|
48
|
-
- Run: [command]
|
|
49
|
-
|
|
50
|
-
## Important Notes
|
|
51
|
-
|
|
52
|
-
- Critical information AI should know
|
|
53
|
-
- Security considerations
|
|
54
|
-
- Performance considerations
|
|
55
|
-
- Known limitations or gotchas
|