Skip to content

Commit 94f3f13

Browse files
committed
feat(mcp, docs) Remove file watcher triggering full reindex on every change. Improve docs
1 parent 226ce47 commit 94f3f13

6 files changed

Lines changed: 54 additions & 391 deletions

File tree

CHANGELOG.md

Lines changed: 14 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,13 @@
11
# Changelog
22

3+
## 1.2.1 (2025-12-07)
4+
5+
### Removed
6+
7+
- File watcher feature removed (will be reintroduced with incremental indexing support)
8+
9+
---
10+
311
## 1.2.0 (2025-12-06)
412

513
### Added
@@ -14,15 +22,11 @@
1422
- `topUsed` array shows usage ratios (e.g., `@mycompany/ui: 847` vs `primeng: 3`)
1523
- Exposes tsconfig paths so AI can identify internal vs external imports
1624

17-
- **Enhanced `get_indexing_status`**: Now includes file watcher stats and pending changes
18-
- Shows `pendingChanges` count (files changed since last index)
19-
- Provides actionable hints for re-indexing decisions
20-
21-
- **`incrementalOnly` option for `refresh_index`**: API ready for Phase 2 incremental indexing
25+
- **`incrementalOnly` option for `refresh_index`**: API ready for incremental indexing
2226

2327
### Changed
2428

25-
- **Framework-agnostic architecture clarified**: Works on ANY project, Angular as first specialized analyzer
29+
- **Framework-agnostic architecture**: Works on ANY project, Angular as first specialized analyzer
2630
- Generic analyzer supports 32 file extensions (JS, TS, Python, Java, Go, Rust, etc.)
2731
- Angular patterns (inject, signals, standalone) are specialized intelligence, not a requirement
2832

@@ -33,22 +37,19 @@
3337

3438
- **Indexer now forwards patterns generically**: Keeps core framework-agnostic
3539

36-
- README updated with correct "works on any project" messaging
37-
38-
3940
---
4041

4142
## 1.1.0 (2025-12-05)
4243

4344
### Added
44-
- **Testing framework detection**: Detects Jest, Jasmine/Karma, Vitest, Cypress, Playwright from actual code patterns (not just package.json)
45-
- **Golden Files**: Surfaces files that demonstrate all team patterns together—one file for AI to mimic
45+
- **Testing framework detection**: Detects Jest, Jasmine/Karma, Vitest, Cypress, Playwright from actual code patterns
46+
- **Golden Files**: Surfaces files that demonstrate all team patterns together
4647
- **Wrapper recommendations**: Exposes library wrapper detection in `get_team_patterns` response
4748
- **Test utilities tracking**: Detects ng-mocks, MSW, Testing Library usage
4849

4950
### Changed
50-
- Framework-agnostic indexer: Pattern detection moved into framework analyzers, indexer just forwards
51-
- Test files now parsed for pattern detection (`parseTests: true`)
51+
- Framework-agnostic indexer: Pattern detection moved into framework analyzers
52+
- Test files now parsed for pattern detection
5253

5354
### Removed
5455
- `get_analyzer_info` tool: Provided no user value—pure implementation details that wasted context window
@@ -67,8 +68,3 @@ Initial release.
6768
- LanceDB vector storage
6869
- Auto-indexes on startup
6970
- No API keys required, runs 100% locally
70-
71-
**Known limitations:**
72-
73-
- Angular only (React/Vue analyzers not yet implemented)
74-
- Full re-index on every restart (no incremental indexing yet)

MOTIVATION.md

Lines changed: 24 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
# Motivation: Why This Exists
22

3-
> **TL;DR**: AI coding assistants are smart but generic. They don't know YOUR codebase's patterns. This MCP gives them that context.
3+
> **TL;DR**: AI coding assistants are smart but generic. They don't know YOUR codebase's patterns, conventions, or context. This MCP gives them that context.
44
55
---
66

7-
## The Problem (Validated by Research)
7+
## The Problem
88

99
### Industry Pain Points
1010

@@ -32,10 +32,10 @@
3232

3333
| Feature | Why It Matters |
3434
|---------|----------------|
35-
| **Pattern Frequency Detection** | "97% use inject(), 3% constructor" AI knows the consensus |
36-
| **Internal Library Discovery** | "Use @company/ui-toolkit not primeng directly" wrapper detection |
35+
| **Pattern Frequency Detection** | "97% use inject(), 3% constructor" - AI knows the consensus |
36+
| **Internal Library Discovery** | "Use @company/ui-toolkit not primeng directly" - wrapper detection |
3737
| **Golden Files** | Real examples showing patterns in context, not isolated snippets |
38-
| **Testing Framework Detection** | "Write Jest tests, not Jasmine" detected from actual spec files |
38+
| **Testing Framework Detection** | "Write Jest tests, not Jasmine" - detected from actual spec files |
3939

4040
### Complementary Positioning
4141

@@ -54,41 +54,40 @@ We're honest about what we don't solve:
5454
| **Pattern frequency ≠ pattern quality** | 97% usage could be technical debt. We show consensus, not correctness. |
5555
| **Stale index risk** | Manual re-indexing required. Lazy indexing planned (Phase 1.6). |
5656
| **Framework coverage** | Angular-specialized now. React/Vue analyzers extensible. |
57-
| **LLM context placement** | We provide data. LLM/client determines how to use it. |
57+
| **LLM context placement** | We provide structured data. How the AI uses it depends on the client (Cursor, Claude, etc.). |
5858

5959
---
6060

6161
## Key Learnings (From Building This)
6262

63-
1. **Statistical detection isn't enough** Saying "97% use inject()" is useless if AI doesn't see HOW to use it. Golden Files with real examples solved this.
63+
1. **Statistical detection isn't enough** - Saying "97% use inject()" is useless if AI doesn't see HOW to use it. Golden Files with real examples solved this.
6464

65-
2. **Complementary, not replacement** We work WITH AGENTS.md, not against it. Different layers of context.
65+
2. **Complementary, not replacement** - We work WITH AGENTS.md, not against it. Different layers of context.
6666

67-
3. **Simplicity beats completeness** Dropped features that added complexity without clear value (dependency graphs, violation detection). Focus on core patterns.
67+
3. **Simplicity beats completeness** - Dropped features that added complexity without clear value (dependency graphs, violation detection). Focus on core patterns.
6868

69-
4. **Human-led, not autonomous** Research shows autonomous agents fail 65-85% of the time. We optimize for human+AI collaboration.
69+
4. **Human-led, not autonomous** - Research shows autonomous agents have ~30-35% success rate on multi-step tasks ([Thoughtworks Technology Radar](https://www.thoughtworks.com/radar), arXiv papers). We optimize for human+AI collaboration.
7070

7171
---
7272

73-
## Claim Validation Status
73+
## Sources
7474

75-
| Claim | Evidence | Status |
76-
|-------|----------|--------|
77-
| "63.3% cite lack of context" | Stack Overflow 2024 Survey | ✅ Cited |
78-
| "AI doubles code churn" | GitClear 2024 Report | ✅ Cited |
79-
| "97% inject() usage" | Pattern detection on indexed enterprise codebase | ✅ Validated |
80-
| "Reduces AI corrections" | 5-use-case methodology planned | ⏳ In Progress |
81-
| "X% token reduction" | To be measured | ⏳ Pending |
75+
### Industry Research
8276

83-
---
77+
1. [Stack Overflow 2024 Developer Survey - AI Section](https://survey.stackoverflow.co/2024/ai) - 65,000+ respondents
78+
2. [GitClear 2024 AI Code Quality Report](https://www.gitclear.com/) - Code churn analysis
79+
3. [DORA State of DevOps 2024](https://dora.dev/research/2024/dora-report/) - Code churn as quality metric
80+
4. [Anthropic MCP](https://modelcontextprotocol.io/) - Protocol specification
8481

85-
## Sources
82+
### Academic Papers (arxiv)
83+
84+
5. [Grounded AI for Code Review](https://arxiv.org/abs/2510.10290) - "Every AI-generated comment must be anchored to deterministic signals"
85+
6. [Code Digital Twin](https://arxiv.org/abs/2503.07967) - "Tacit knowledge is embedded in developer experience, not code"
86+
7. [CACE: Context-Aware Eviction](https://arxiv.org/abs/2506.18796) - Multi-factor file scoring for context efficiency
87+
88+
### Internal Validation
8689

87-
1. [Stack Overflow 2024 Developer Survey - AI Section](https://survey.stackoverflow.co/2024/ai) — 65,000+ respondents
88-
2. [GitClear 2024 AI Code Quality Report](https://www.gitclear.com/) — Code churn analysis
89-
3. [DORA State of DevOps 2024](https://dora.dev/research/2024/dora-report/) — Code churn as quality metric
90-
4. [Anthropic MCP](https://modelcontextprotocol.io/) — Protocol specification
91-
5. Internal validation on enterprise Angular medium-sized codebase
90+
8. Enterprise Angular codebase (611 files): inject 98%, Jest 74%, wrapper detection working
9291

9392
---
9493

README.md

Lines changed: 4 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -100,8 +100,8 @@ AGENTS.md tells the AI what you *want*. We show what you *actually do*—and sur
100100
| `search_codebase` | Semantic + keyword hybrid search |
101101
| `get_codebase_metadata` | Project structure + patterns summary |
102102
| `get_style_guide` | Style guide content lookup |
103-
| `get_indexing_status` | Index state + file watcher status + pending changes |
104-
| `refresh_index` | Re-index (supports `incrementalOnly: true` for faster updates) |
103+
| `get_indexing_status` | Index state and progress |
104+
| `refresh_index` | Re-index the codebase (supports `incrementalOnly: true` for Phase 2) |
105105

106106

107107

@@ -133,8 +133,6 @@ AGENTS.md tells the AI what you *want*. We show what you *actually do*—and sur
133133

134134
> **Current focus**: JS/TS codebases with Angular as the primary specialized analyzer. The architecture is designed to be language-agnostic with pluggable analyzers—that's the mid-term vision.
135135
136-
File watcher auto-enabled by default. Disable with `WATCH_FILES=false`.
137-
138136
---
139137

140138
## Setup
@@ -183,7 +181,6 @@ Or if installed globally:
183181
|----------|---------|-------------|
184182
| `EMBEDDING_PROVIDER` | `transformers` | Set to `openai` to use OpenAI's API (faster, lighter) or `transformers` for local (private, free). |
185183
| `OPENAI_API_KEY` | - | Required if provider is `openai`. |
186-
| `WATCH_FILES` | `true` | Set to `false` to disable the file watcher. |
187184

188185
**Why use OpenAI?**
189186
- **Faster**: No need to download/run local 100MB+ models.
@@ -213,15 +210,15 @@ We stay focused. Here's what we deliberately exclude:
213210
| **Specialized patterns are Angular-only** | MVP | React/Vue specialists are planned. The pluggable architecture makes this extensible. |
214211
| **Single repo** | MVP | Multi-repo (Nx workspaces) planned. For now, point it at one repo at a time. |
215212
| **Pattern frequency ≠ correctness** | By design | We show team consensus, not "right" patterns. 97% inject() usage doesn't mean inject() is correct—it means that's what your team does. Combine with AGENTS.md for intent. |
216-
| **Index goes stale** | MVP | Re-index manually with `refresh_index` or restart the MCP. File watcher catches most changes, but major refactors need a full re-index. Lazy incremental indexing planned. |
213+
| **Index goes stale** | MVP | Re-index manually with `refresh_index` or restart the MCP. Incremental indexing planned for Phase 2. |
217214
| **First index can be slow** | Depends | Uses local embeddings by default (downloads ~100MB model). Use `EMBEDDING_PROVIDER=openai` for faster startup if privacy isn't a concern. |
218215

219216

220217
---
221218

222219
## Why This Exists
223220

224-
📄 **[Motivation](./MOTIVATION.md)** The research and pain points that led to this
221+
📄 **[Motivation](./MOTIVATION.md)** - The research and pain points that led to this
225222

226223
## License
227224

0 commit comments

Comments
 (0)