You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: MOTIVATION.md
+24-25Lines changed: 24 additions & 25 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,10 +1,10 @@
1
1
# Motivation: Why This Exists
2
2
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.
4
4
5
5
---
6
6
7
-
## The Problem (Validated by Research)
7
+
## The Problem
8
8
9
9
### Industry Pain Points
10
10
@@ -32,10 +32,10 @@
32
32
33
33
| Feature | Why It Matters |
34
34
|---------|----------------|
35
-
|**Pattern Frequency Detection**| "97% use inject(), 3% constructor" — AI knows the consensus |
|**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.). |
58
58
59
59
---
60
60
61
61
## Key Learnings (From Building This)
62
62
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.
64
64
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.
66
66
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.
68
68
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.
|`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) |
105
105
106
106
107
107
@@ -133,8 +133,6 @@ AGENTS.md tells the AI what you *want*. We show what you *actually do*—and sur
133
133
134
134
> **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.
135
135
136
-
File watcher auto-enabled by default. Disable with `WATCH_FILES=false`.
137
-
138
136
---
139
137
140
138
## Setup
@@ -183,7 +181,6 @@ Or if installed globally:
183
181
|----------|---------|-------------|
184
182
|`EMBEDDING_PROVIDER`|`transformers`| Set to `openai` to use OpenAI's API (faster, lighter) or `transformers` for local (private, free). |
185
183
|`OPENAI_API_KEY`| - | Required if provider is `openai`. |
186
-
|`WATCH_FILES`|`true`| Set to `false` to disable the file watcher. |
187
184
188
185
**Why use OpenAI?**
189
186
-**Faster**: No need to download/run local 100MB+ models.
@@ -213,15 +210,15 @@ We stay focused. Here's what we deliberately exclude:
213
210
|**Specialized patterns are Angular-only**| MVP | React/Vue specialists are planned. The pluggable architecture makes this extensible. |
214
211
|**Single repo**| MVP | Multi-repo (Nx workspaces) planned. For now, point it at one repo at a time. |
215
212
|**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. |
217
214
|**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. |
218
215
219
216
220
217
---
221
218
222
219
## Why This Exists
223
220
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
0 commit comments