mcp-adr-analysis-server 2.1.22 → 2.1.28
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 +63 -1
- package/dist/.tsbuildinfo +1 -1
- package/dist/src/index.d.ts.map +1 -1
- package/dist/src/index.js +370 -0
- package/dist/src/index.js.map +1 -1
- package/dist/src/tools/adr-aggregator-tools.d.ts +185 -0
- package/dist/src/tools/adr-aggregator-tools.d.ts.map +1 -0
- package/dist/src/tools/adr-aggregator-tools.js +872 -0
- package/dist/src/tools/adr-aggregator-tools.js.map +1 -0
- package/dist/src/tools/analyze-gaps-tool.d.ts +57 -0
- package/dist/src/tools/analyze-gaps-tool.d.ts.map +1 -0
- package/dist/src/tools/analyze-gaps-tool.js +727 -0
- package/dist/src/tools/analyze-gaps-tool.js.map +1 -0
- package/dist/src/tools/tool-catalog.d.ts +1 -1
- package/dist/src/tools/tool-catalog.d.ts.map +1 -1
- package/dist/src/tools/tool-catalog.js +382 -0
- package/dist/src/tools/tool-catalog.js.map +1 -1
- package/dist/src/tools/tool-dispatcher.d.ts.map +1 -1
- package/dist/src/tools/tool-dispatcher.js +4 -0
- package/dist/src/tools/tool-dispatcher.js.map +1 -1
- package/dist/src/types/adr-aggregator.d.ts +692 -0
- package/dist/src/types/adr-aggregator.d.ts.map +1 -0
- package/dist/src/types/adr-aggregator.js +8 -0
- package/dist/src/types/adr-aggregator.js.map +1 -0
- package/dist/src/types/index.d.ts +3 -2
- package/dist/src/types/index.d.ts.map +1 -1
- package/dist/src/types/memory-entities.d.ts +48 -48
- package/dist/src/utils/adr-aggregator-client.d.ts +177 -0
- package/dist/src/utils/adr-aggregator-client.d.ts.map +1 -0
- package/dist/src/utils/adr-aggregator-client.js +396 -0
- package/dist/src/utils/adr-aggregator-client.js.map +1 -0
- package/dist/src/utils/config.d.ts +3 -0
- package/dist/src/utils/config.d.ts.map +1 -1
- package/dist/src/utils/config.js +13 -0
- package/dist/src/utils/config.js.map +1 -1
- package/dist/src/utils/git-remote-detector.d.ts +67 -0
- package/dist/src/utils/git-remote-detector.d.ts.map +1 -0
- package/dist/src/utils/git-remote-detector.js +194 -0
- package/dist/src/utils/git-remote-detector.js.map +1 -0
- package/package.json +3 -3
package/README.md
CHANGED
|
@@ -38,7 +38,6 @@ The Model Context Protocol enables seamless integration between AI assistants an
|
|
|
38
38
|
|
|
39
39
|
📖 **[View Full Capabilities →](docs/explanation/)**
|
|
40
40
|
|
|
41
|
-
|
|
42
41
|
## 📦 Quick Installation
|
|
43
42
|
|
|
44
43
|
```bash
|
|
@@ -75,6 +74,29 @@ curl -sSL https://raw.githubusercontent.com/tosin2013/mcp-adr-analysis-server/ma
|
|
|
75
74
|
}
|
|
76
75
|
```
|
|
77
76
|
|
|
77
|
+
<details>
|
|
78
|
+
<summary><b>With ADR Aggregator (Optional)</b></summary>
|
|
79
|
+
|
|
80
|
+
```json
|
|
81
|
+
{
|
|
82
|
+
"mcpServers": {
|
|
83
|
+
"adr-analysis": {
|
|
84
|
+
"command": "mcp-adr-analysis-server",
|
|
85
|
+
"env": {
|
|
86
|
+
"PROJECT_PATH": "/path/to/your/project",
|
|
87
|
+
"OPENROUTER_API_KEY": "your_key_here",
|
|
88
|
+
"EXECUTION_MODE": "full",
|
|
89
|
+
"ADR_AGGREGATOR_API_KEY": "agg_your_key_here"
|
|
90
|
+
}
|
|
91
|
+
}
|
|
92
|
+
}
|
|
93
|
+
}
|
|
94
|
+
```
|
|
95
|
+
|
|
96
|
+
Get your API key at [adraggregator.com](https://adraggregator.com)
|
|
97
|
+
|
|
98
|
+
</details>
|
|
99
|
+
|
|
78
100
|
📖 **[Full Configuration Guide →](docs/reference/mcp-client-config.md)** | **[Client Setup →](docs/reference/environment-config.md)**
|
|
79
101
|
|
|
80
102
|
## 🚀 Usage Examples
|
|
@@ -174,6 +196,46 @@ export FIRECRAWL_BASE_URL="http://localhost:3000"
|
|
|
174
196
|
|
|
175
197
|
📖 **[Firecrawl Setup Guide →](docs/reference/environment-config.md#firecrawl-configuration)**
|
|
176
198
|
|
|
199
|
+
## 🌐 ADR Aggregator Integration (Optional)
|
|
200
|
+
|
|
201
|
+
**Sync your ADRs to [adraggregator.com](https://adraggregator.com) for cross-team visibility, governance dashboards, and organizational knowledge graphs.**
|
|
202
|
+
|
|
203
|
+
```bash
|
|
204
|
+
# Set your API key (get one at adraggregator.com)
|
|
205
|
+
export ADR_AGGREGATOR_API_KEY="agg_your_key_here"
|
|
206
|
+
```
|
|
207
|
+
|
|
208
|
+
### Available Tools
|
|
209
|
+
|
|
210
|
+
| Tool | Description | Tier |
|
|
211
|
+
| ------------------------- | ---------------------------------- | ---- |
|
|
212
|
+
| `sync_to_aggregator` | Push local ADRs to platform | Free |
|
|
213
|
+
| `get_adr_context` | Pull ADR context from platform | Free |
|
|
214
|
+
| `get_staleness_report` | Get ADR governance/health reports | Free |
|
|
215
|
+
| `get_adr_templates` | Retrieve domain-specific templates | Free |
|
|
216
|
+
| `get_adr_diagrams` | Get Mermaid diagrams for ADRs | Pro+ |
|
|
217
|
+
| `validate_adr_compliance` | Validate ADR implementation | Pro+ |
|
|
218
|
+
| `get_knowledge_graph` | Cross-repository knowledge graph | Team |
|
|
219
|
+
|
|
220
|
+
### Workflow for New Repos
|
|
221
|
+
|
|
222
|
+
```bash
|
|
223
|
+
# 1. Analyze codebase for implicit architectural decisions
|
|
224
|
+
suggest_adrs(analysisType: 'implicit_decisions')
|
|
225
|
+
|
|
226
|
+
# 2. Generate ADR files from suggestions
|
|
227
|
+
generate_adr_from_decision(decisionData)
|
|
228
|
+
|
|
229
|
+
# 3. Save ADRs to docs/adrs/
|
|
230
|
+
|
|
231
|
+
# 4. (Optional) Sync to adraggregator.com
|
|
232
|
+
sync_to_aggregator(full_sync: true)
|
|
233
|
+
```
|
|
234
|
+
|
|
235
|
+
**Benefits:** Cross-team visibility • Staleness alerts • Compliance tracking • Organization-wide knowledge graph
|
|
236
|
+
|
|
237
|
+
📖 **[ADR Aggregator Guide →](https://adraggregator.com/docs)**
|
|
238
|
+
|
|
177
239
|
## 🔧 Development
|
|
178
240
|
|
|
179
241
|
```bash
|