ai-readme-mcp 0.4.2 → 0.4.3
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 +7 -4
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -20,9 +20,9 @@ When working with AI assistants (like Claude, GPT, or other AI coding tools), yo
|
|
|
20
20
|
|
|
21
21
|
- ❌ **Inconsistent code style** - AI generates code that doesn't match your project's conventions
|
|
22
22
|
- ❌ **Repeated instructions** - You have to tell the AI the same rules over and over
|
|
23
|
-
- ❌ **Team inconsistency** - Different team members get different AI outputs
|
|
23
|
+
- ❌ **Team inconsistency** - Different team members get different AI outputs, leading to fragmented code quality
|
|
24
24
|
- ❌ **Context loss** - AI forgets your project's specific patterns and best practices
|
|
25
|
-
- ❌ **
|
|
25
|
+
- ❌ **No single source of truth** - Team conventions exist in Slack messages, PRs, and people's heads, not in a format AI can use
|
|
26
26
|
|
|
27
27
|
## 💡 The Solution
|
|
28
28
|
|
|
@@ -32,13 +32,15 @@ Think of it as:
|
|
|
32
32
|
- 📖 A "style guide" that AI reads before writing code
|
|
33
33
|
- 🎓 An "onboarding document" that teaches AI your project's conventions
|
|
34
34
|
- 🔧 A "configuration file" for AI behavior in your codebase
|
|
35
|
+
- 🤝 A **"team contract"** that ensures every developer's AI assistant follows the same standards
|
|
35
36
|
|
|
36
37
|
### How It Works
|
|
37
38
|
|
|
38
39
|
1. **Create** `AI_README.md` files in your project (root or specific directories)
|
|
39
40
|
2. **Document** your conventions: coding standards, architecture patterns, naming rules, testing requirements
|
|
40
|
-
3. **
|
|
41
|
-
4. **
|
|
41
|
+
3. **Commit to git** - Share conventions with your entire team
|
|
42
|
+
4. **AI reads it automatically** before making changes - ensuring every team member's AI follows the same rules
|
|
43
|
+
5. **Keep it in sync** - AI can update the README as your project evolves
|
|
42
44
|
|
|
43
45
|
### What This MCP Server Does
|
|
44
46
|
|
|
@@ -58,6 +60,7 @@ This MCP (Model Context Protocol) server automates the entire workflow:
|
|
|
58
60
|
|
|
59
61
|
- 🔍 **Automatic Discovery** - Scan and index all AI_README.md files in your project
|
|
60
62
|
- 🎯 **Smart Context Routing** - Find relevant README content based on file paths
|
|
63
|
+
- 🤝 **Team Consistency** - Every team member's AI assistant reads the same conventions from git, ensuring uniform code quality
|
|
61
64
|
- 🚀 **Guided Initialization** - `init_ai_readme` tool scans for empty files and guides AI through population
|
|
62
65
|
- 🔄 **Update & Sync** - AI can both read and update AI_README files
|
|
63
66
|
- ✅ **Validation & Quality** - Ensure README consistency with token limits and structure checks
|