ai-readme-mcp 0.1.0 → 0.2.0

package/README.md

@@ -10,20 +10,27 @@
 
 AI_README MCP Server is a Model Context Protocol (MCP) server that automatically manages and syncs AI_README.md files across your projects. It enables AI assistants to intelligently read and update relevant context documentation when modifying code.
 
-## ✨ Features
+### Why AI_README?
+
+When working with AI assistants on code projects, **consistency and quality matter**. This tool helps teams:
 
-### Available Now
+- **🤝 Standardize AI interactions** - Ensure all team members and AI assistants follow the same coding standards, conventions, and best practices
+- **📈 Improve AI output quality** - By providing clear, structured context, AI generates more accurate and consistent code that matches your project's style
+- **🎯 Maintain consistency across teams** - When multiple developers use AI assistants, AI_README ensures everyone gets the same guidelines and standards
+- **⚡ Save time on onboarding** - New team members and AI assistants instantly understand project conventions without lengthy explanations
+- **🔄 Keep documentation in sync** - AI can automatically update README files as the project evolves, maintaining up-to-date documentation
 
-- 🔍 **Automatic Discovery** - Scan and index all AI_README.md files in your project (Phase 1)
-- 🎯 **Smart Context Routing** - Find relevant README content based on file paths (Phase 1)
-- 🔄 **Update & Sync** - AI can both read and update AI_README files (Phase 2)
-- 📦 **Easy Integration** - Works seamlessly with Claude Code and other MCP clients
-- 🧪 **Well Tested** - 36 unit tests, 100% passing
+Think of it as a **"style guide and context manager for AI"** - ensuring every AI interaction in your project follows your team's standards and produces high-quality, consistent output.
+
+## ✨ Features
 
-### Coming Soon
+- 🔍 **Automatic Discovery** - Scan and index all AI_README.md files in your project
+- 🎯 **Smart Context Routing** - Find relevant README content based on file paths
+- 🔄 **Update & Sync** - AI can both read and update AI_README files
+- ✅ **Validation & Quality** - Ensure README consistency with token limits and structure checks
+- 📝 **Template System** - Initialize new AI_README files from templates
+- 📦 **Easy Integration** - Works seamlessly with Cursor, Claude Code, and other MCP clients
 
-- ✅ **Validation & Health Checks** - Ensure README consistency and integrity (Phase 3)
-- 🎬 **Watch Mode** - Auto-sync changes to README files (Phase 4)
 
 ## 🚀 Quick Start
 
@@ -433,44 +440,16 @@ Update an AI_README.md file with specified operations.
 }
 ```
 
-## 🗺️ Development Roadmap
-
-### Phase 0: Initial Setup ✅ COMPLETED
-- [x] Project structure
-- [x] TypeScript configuration
-- [x] Build tooling (tsup)
-- [x] Testing setup (Node.js native test runner)
-- [x] Basic type definitions
-
-### Phase 1: MVP (Core Features) ✅ COMPLETED
-- [x] Implement AIReadmeScanner
-- [x] Implement ContextRouter
-- [x] Create `discover_ai_readmes` tool
-- [x] Create `get_context_for_file` tool
-- [x] Write comprehensive tests (26 tests, all passing)
-- [x] MCP server integration
-- [x] Documentation and templates
-
-### Phase 2: Update & Sync ✅ COMPLETED
-- [x] Implement ReadmeUpdater
-- [x] Create `update_ai_readme` tool
-- [x] Support 5 operation types (append, prepend, replace, insert-after, insert-before)
-- [x] Write comprehensive tests (36 tests total, all passing)
-
-### Phase 3: Validation & Quality 📋 NEXT
-- [ ] Implement ReadmeValidator
-- [ ] Create `validate_ai_readmes` tool
-- [ ] Health check functionality
-
-### Phase 4: Advanced Features
-- [ ] Watch mode for auto-sync
-- [ ] Performance optimization and caching
-- [ ] VSCode Extension
-
-### Phase 5: Distribution
-- [ ] Publish to npm registry
-- [ ] Add npx support for easier installation
-- [ ] CI/CD pipeline for automated releases
+## 🚀 What's Next
+
+We're actively working on new features:
+
+- **Watch Mode** - Auto-sync changes when AI_README files are modified
+- **Performance Optimization** - Caching and incremental updates
+- **VSCode Extension** - Visual interface for managing AI_README files
+- **CI/CD Integration** - GitHub Actions for automated README validation
+
+Want to contribute? Check out our [Contributing Guide](./CONTRIBUTING.md)!
 
 ## 🤝 Contributing
 
@@ -493,4 +472,4 @@ This project is licensed under the MIT License - see the [LICENSE](LICENSE) file
 
 ---
 
-**Status:** 🚧 In Development | **Version:** 0.1.0 | **Last Updated:** 2025-11-05
+**Status:** ✅ Published | **Version:** 0.2.0 | **Last Updated:** 2025-11-07

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ai-readme-mcp",
-  "version": "0.1.0",
+  "version": "0.2.0",
   "description": "MCP server for managing AI_README.md files in projects",
   "type": "module",
   "bin": {