mcp-adr-analysis-server 2.14.1 → 2.14.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 +56 -41
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -7,7 +7,7 @@
|
|
|
7
7
|
[](https://www.typescriptlang.org/)
|
|
8
8
|
[](https://github.com/tosin2013/mcp-adr-analysis-server/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22)
|
|
9
9
|
|
|
10
|
-
> **
|
|
10
|
+
> **Architectural analysis for intelligent development workflows.** 64 MCP tools for drift detection, content safety, and decision memory — powered by your host LLM via CE-MCP directives.
|
|
11
11
|
|
|
12
12
|
## What is MCP?
|
|
13
13
|
|
|
@@ -15,12 +15,12 @@ The **Model Context Protocol (MCP)** is an open standard that enables seamless i
|
|
|
15
15
|
|
|
16
16
|
## TL;DR
|
|
17
17
|
|
|
18
|
-
**What:** MCP server
|
|
19
|
-
**Who:** AI coding assistants (Claude, Cline, Cursor), enterprise architects, development teams
|
|
20
|
-
**Why:** Get immediate architectural insights
|
|
21
|
-
**How:** `npm install -g mcp-adr-analysis-server` →
|
|
18
|
+
**What:** MCP server providing architectural decision analysis, drift detection, content safety, and ADR management
|
|
19
|
+
**Who:** AI coding assistants (Claude, Cline, Cursor, Windsurf), enterprise architects, development teams
|
|
20
|
+
**Why:** Get immediate architectural insights — no external API key required in CE-MCP mode
|
|
21
|
+
**How:** `npm install -g mcp-adr-analysis-server` → Add to your MCP client → Start analyzing
|
|
22
22
|
|
|
23
|
-
**Key Features:** Tree-sitter AST analysis • Security content masking •
|
|
23
|
+
**Key Features:** Tree-sitter AST analysis • Security content masking • Drift detection • CE-MCP orchestration directives • Deployment readiness validation
|
|
24
24
|
|
|
25
25
|
<details>
|
|
26
26
|
<summary><b>Key Terms</b></summary>
|
|
@@ -29,9 +29,10 @@ The **Model Context Protocol (MCP)** is an open standard that enables seamless i
|
|
|
29
29
|
| -------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
30
30
|
| **ADR** | **Architectural Decision Record** — A document that captures an important architectural decision along with its context, alternatives considered, and consequences. |
|
|
31
31
|
| **MCP** | **Model Context Protocol** — An open standard enabling AI assistants to connect to external tools and data sources. |
|
|
32
|
+
| **CE-MCP** | **Claude-Enriched MCP** — Execution mode where tools return orchestration directives for the host LLM instead of making their own AI calls. Default since v2.14. |
|
|
32
33
|
| **Tree-sitter** | An incremental parsing library that provides AST (Abstract Syntax Tree) analysis for 50+ languages. Used for semantic code understanding, extracting function signatures, and identifying architectural patterns. |
|
|
33
34
|
| **Session & Tool-Usage Tracker** | Project-local tracking of session intents, tool executions, and ADR registrations, with keyword-scored retrieval over JSON snapshots. Supports workflow continuity and tool-usage evidence — not a graph database. |
|
|
34
|
-
| **Smart Code Linking** |
|
|
35
|
+
| **Smart Code Linking** | Discovery of code files related to ADRs and architectural decisions, using keyword extraction and ripgrep search. |
|
|
35
36
|
| **ADR Aggregator** | Optional SaaS integration for syncing and sharing ADR context across teams (`ADR_AGGREGATOR_API_KEY`). |
|
|
36
37
|
|
|
37
38
|
</details>
|
|
@@ -42,12 +43,12 @@ The **Model Context Protocol (MCP)** is an open standard that enables seamless i
|
|
|
42
43
|
|
|
43
44
|
## ✨ Core Capabilities
|
|
44
45
|
|
|
45
|
-
|
|
46
|
+
🔄 **Drift Detection** - Validate ADR decisions against live code and infrastructure evidence
|
|
47
|
+
🛡️ **Content Safety** - Detect and mask secrets, PII, and sensitive content automatically
|
|
48
|
+
🧠 **Decision Memory** - Session & tool-usage tracking with keyword-scored retrieval
|
|
46
49
|
🏗️ **Technology Detection** - Identify any tech stack and architectural patterns
|
|
47
50
|
📋 **ADR Management** - Generate, suggest, and maintain Architectural Decision Records
|
|
48
|
-
🔗 **Smart Code Linking** -
|
|
49
|
-
🛡️ **Security & Compliance** - Detect and mask sensitive content automatically
|
|
50
|
-
🧪 **TDD Integration** - Two-phase Test-Driven Development with validation
|
|
51
|
+
🔗 **Smart Code Linking** - Discovery of code files related to ADRs and decisions
|
|
51
52
|
🚀 **Deployment Readiness** - Zero-tolerance test validation with hard blocking
|
|
52
53
|
|
|
53
54
|
📖 **[View Full Capabilities →](docs/explanation/index.md)** · 📜 **[Release policy →](RELEASES.md)** · 🗒️ **[Changelog →](CHANGELOG.md)**
|
|
@@ -94,11 +95,10 @@ curl -sSL https://raw.githubusercontent.com/tosin2013/mcp-adr-analysis-server/ma
|
|
|
94
95
|
|
|
95
96
|
📖 **[Detailed Installation Guide →](docs/tutorials/01-first-steps.md)** | **[RHEL Setup →](scripts/install-rhel.sh)**
|
|
96
97
|
|
|
97
|
-
## ⚡ Quick Setup (
|
|
98
|
+
## ⚡ Quick Setup (2 Steps)
|
|
98
99
|
|
|
99
|
-
1. **
|
|
100
|
-
2. **
|
|
101
|
-
3. **Configure Client**: Add to Claude Desktop, Cline, Cursor, or Windsurf
|
|
100
|
+
1. **Install**: `npm install -g mcp-adr-analysis-server`
|
|
101
|
+
2. **Configure Client**: Add to Claude Desktop, Cline, Cursor, or Windsurf — no API key required
|
|
102
102
|
|
|
103
103
|
```json
|
|
104
104
|
{
|
|
@@ -106,15 +106,15 @@ curl -sSL https://raw.githubusercontent.com/tosin2013/mcp-adr-analysis-server/ma
|
|
|
106
106
|
"adr-analysis": {
|
|
107
107
|
"command": "mcp-adr-analysis-server",
|
|
108
108
|
"env": {
|
|
109
|
-
"PROJECT_PATH": "/path/to/your/project"
|
|
110
|
-
"OPENROUTER_API_KEY": "your_key_here",
|
|
111
|
-
"EXECUTION_MODE": "full"
|
|
109
|
+
"PROJECT_PATH": "/path/to/your/project"
|
|
112
110
|
}
|
|
113
111
|
}
|
|
114
112
|
}
|
|
115
113
|
}
|
|
116
114
|
```
|
|
117
115
|
|
|
116
|
+
That's it. The server runs in **CE-MCP mode** by default — your host LLM (Claude, GPT, etc.) executes the analysis using orchestration directives returned by the tools. No external API key needed.
|
|
117
|
+
|
|
118
118
|
> **Claude Desktop users:** Save this JSON to `~/Library/Application Support/Claude/claude_desktop_config.json` (macOS) or `%APPDATA%\Claude\claude_desktop_config.json` (Windows).
|
|
119
119
|
|
|
120
120
|
<details>
|
|
@@ -130,7 +130,9 @@ curl -sSL https://raw.githubusercontent.com/tosin2013/mcp-adr-analysis-server/ma
|
|
|
130
130
|
</details>
|
|
131
131
|
|
|
132
132
|
<details>
|
|
133
|
-
<summary><b>
|
|
133
|
+
<summary><b>Optional: OpenRouter Full Mode (legacy)</b></summary>
|
|
134
|
+
|
|
135
|
+
If you want the server to make its own AI calls (bypassing the host LLM), add an OpenRouter API key:
|
|
134
136
|
|
|
135
137
|
```json
|
|
136
138
|
{
|
|
@@ -140,7 +142,27 @@ curl -sSL https://raw.githubusercontent.com/tosin2013/mcp-adr-analysis-server/ma
|
|
|
140
142
|
"env": {
|
|
141
143
|
"PROJECT_PATH": "/path/to/your/project",
|
|
142
144
|
"OPENROUTER_API_KEY": "your_key_here",
|
|
143
|
-
"EXECUTION_MODE": "full"
|
|
145
|
+
"EXECUTION_MODE": "full"
|
|
146
|
+
}
|
|
147
|
+
}
|
|
148
|
+
}
|
|
149
|
+
}
|
|
150
|
+
```
|
|
151
|
+
|
|
152
|
+
Sign up at [OpenRouter.ai/keys](https://openrouter.ai/keys). This mode is **not recommended** — CE-MCP produces equivalent results using your existing host LLM context.
|
|
153
|
+
|
|
154
|
+
</details>
|
|
155
|
+
|
|
156
|
+
<details>
|
|
157
|
+
<summary><b>Optional: ADR Aggregator integration</b></summary>
|
|
158
|
+
|
|
159
|
+
```json
|
|
160
|
+
{
|
|
161
|
+
"mcpServers": {
|
|
162
|
+
"adr-analysis": {
|
|
163
|
+
"command": "mcp-adr-analysis-server",
|
|
164
|
+
"env": {
|
|
165
|
+
"PROJECT_PATH": "/path/to/your/project",
|
|
144
166
|
"ADR_AGGREGATOR_API_KEY": "agg_your_key_here"
|
|
145
167
|
}
|
|
146
168
|
}
|
|
@@ -156,16 +178,15 @@ Get your API key at [adraggregator.com](https://adraggregator.com)
|
|
|
156
178
|
|
|
157
179
|
### Execution Modes
|
|
158
180
|
|
|
159
|
-
| | **Full Mode**
|
|
160
|
-
| ------------------------ |
|
|
161
|
-
| **Requires API key?** | Yes (`OPENROUTER_API_KEY`)
|
|
162
|
-
| **Returns** |
|
|
163
|
-
| **Set via** | `EXECUTION_MODE=full`
|
|
164
|
-
| **Best for** |
|
|
165
|
-
| **
|
|
166
|
-
| **Unavailable Features** | — | AI execution, confidence scores, Smart Code Linking, web research |
|
|
181
|
+
| | **CE-MCP (default)** | **Full Mode (legacy)** | **Prompt-Only** |
|
|
182
|
+
| ------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ----------------------------------------------------------------- |
|
|
183
|
+
| **Requires API key?** | No | Yes (`OPENROUTER_API_KEY`) | No |
|
|
184
|
+
| **Returns** | Orchestration directives for the host LLM to execute | Server-side AI analysis results | Prompts you can paste into any AI chat |
|
|
185
|
+
| **Set via** | Default (no env var needed) | `EXECUTION_MODE=full` | `EXECUTION_MODE=prompt-only` |
|
|
186
|
+
| **Best for** | All users — recommended | Legacy workflows with dedicated API budget | Offline exploration |
|
|
187
|
+
| **Tools available** | All 64 tools with annotated MCP metadata | All 64 tools | Analysis prompts, templates, local file operations, ADR discovery |
|
|
167
188
|
|
|
168
|
-
**
|
|
189
|
+
**What are CE-MCP directives?** When a tool is called, it returns a structured orchestration directive that tells your host LLM what to analyze, what data to gather, and how to format results. The host LLM (e.g. Claude in Claude Desktop, or GPT in Cursor) executes the directive using its existing context window. This means **zero additional API costs** and **better results** because the LLM already has your conversation context.
|
|
169
190
|
|
|
170
191
|
## 🚀 Usage Examples
|
|
171
192
|
|
|
@@ -177,7 +198,7 @@ Just ask your MCP client in natural language — no code required:
|
|
|
177
198
|
|
|
178
199
|
> "Check this codebase for security issues and provide masking recommendations"
|
|
179
200
|
|
|
180
|
-
**The server returns
|
|
201
|
+
**The server returns structured analysis and orchestration directives** that your host LLM executes in context.
|
|
181
202
|
|
|
182
203
|
<details>
|
|
183
204
|
<summary><b>Programmatic Usage (Advanced)</b></summary>
|
|
@@ -203,7 +224,6 @@ const relatedCode = await findRelatedCode(
|
|
|
203
224
|
'We will implement JWT authentication with Express middleware',
|
|
204
225
|
'/path/to/project',
|
|
205
226
|
{
|
|
206
|
-
useAI: true, // AI-powered keyword extraction
|
|
207
227
|
useRipgrep: true, // Fast text search
|
|
208
228
|
maxFiles: 10, // Limit results
|
|
209
229
|
includeContent: true, // Include file contents
|
|
@@ -231,14 +251,14 @@ const relatedCode = await findRelatedCode(
|
|
|
231
251
|
## 🛠️ Technology Stack
|
|
232
252
|
|
|
233
253
|
**Runtime:** Node.js 20+ • **Language:** TypeScript • **Framework:** MCP SDK • **Testing:** Vitest (~49% statements, enforced floor)
|
|
234
|
-
**Search:** [ripgrep](https://github.com/BurntSushi/ripgrep) (fast recursive text search) + fast-glob (file matching) • **AI Integration:**
|
|
254
|
+
**Search:** [ripgrep](https://github.com/BurntSushi/ripgrep) (fast recursive text search) + fast-glob (file matching) • **AI Integration:** CE-MCP orchestration directives (host LLM) • **Code Analysis:** [tree-sitter](https://tree-sitter.github.io/tree-sitter/) (incremental code parser) + Smart Code Linking
|
|
235
255
|
|
|
236
256
|
📖 **[Technical Details →](docs/explanation/server-architecture.md)** | **[CE-MCP Migration Playbook →](docs/how-to-guides/ce-mcp-migration-playbook.md)**
|
|
237
257
|
|
|
238
258
|
## 📁 Project Structure
|
|
239
259
|
|
|
240
260
|
```
|
|
241
|
-
src/tools/ #
|
|
261
|
+
src/tools/ # 64 MCP tools with annotated metadata
|
|
242
262
|
docs/adrs/ # Architectural Decision Records
|
|
243
263
|
tests/ # ~49% statement coverage, floor enforced in CI
|
|
244
264
|
.github/ # CI/CD automation
|
|
@@ -331,7 +351,7 @@ Then open `http://localhost:8080` in your browser. Markdown documentation lives
|
|
|
331
351
|
**Common Issues:**
|
|
332
352
|
|
|
333
353
|
- **RHEL Systems**: Use special installer script
|
|
334
|
-
- **Tools return
|
|
354
|
+
- **Tools return directives instead of results**: This is expected in CE-MCP mode — your host LLM executes the directives. For server-side execution, set `EXECUTION_MODE=full` + `OPENROUTER_API_KEY`
|
|
335
355
|
- **Module not found**: Run `npm install && npm run build`
|
|
336
356
|
- **Permission denied**: Check file permissions and project path
|
|
337
357
|
|
|
@@ -363,12 +383,7 @@ We welcome contributions! Whether you're fixing bugs, adding features, or improv
|
|
|
363
383
|
|
|
364
384
|
### 🗺️ Roadmap
|
|
365
385
|
|
|
366
|
-
Work is tracked in GitHub milestones, and milestone membership is what marks an issue as
|
|
367
|
-
admitted:
|
|
368
|
-
|
|
369
|
-
- [**Release & docs foundation**](https://github.com/tosin2013/mcp-adr-analysis-server/milestone/1) — shipped as v2.6.20
|
|
370
|
-
- [**v3.0**](https://github.com/tosin2013/mcp-adr-analysis-server/milestone/2) — tool registry consolidation and the CI safety net
|
|
371
|
-
- [**v3.1**](https://github.com/tosin2013/mcp-adr-analysis-server/milestone/3) — work gated on the tool-surface decision in [ADR-023](docs/adrs/adr-023-tool-surface-scope.md)
|
|
386
|
+
Work is tracked in [GitHub milestones](https://github.com/tosin2013/mcp-adr-analysis-server/milestones), and milestone membership is what marks an issue as admitted.
|
|
372
387
|
|
|
373
388
|
Architectural direction lives in [`docs/adrs/`](docs/adrs/README.md); release cadence is in
|
|
374
389
|
[`RELEASES.md`](RELEASES.md).
|
|
@@ -407,4 +422,4 @@ MIT License - see [LICENSE](LICENSE) file for details.
|
|
|
407
422
|
|
|
408
423
|
**Built with ❤️ by [Tosin Akinosho](https://github.com/tosin2013) for AI-driven architectural analysis**
|
|
409
424
|
|
|
410
|
-
_Empowering AI assistants with
|
|
425
|
+
_Empowering AI assistants with drift detection, content safety, and decision memory via CE-MCP orchestration directives._
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "mcp-adr-analysis-server",
|
|
3
3
|
"mcpName": "io.github.tosin2013/mcp-adr-analysis-server",
|
|
4
|
-
"version": "2.14.
|
|
4
|
+
"version": "2.14.3",
|
|
5
5
|
"description": "MCP server for analyzing Architectural Decision Records and project architecture",
|
|
6
6
|
"main": "dist/src/index.js",
|
|
7
7
|
"type": "module",
|