ngx-oneforall-mcp 1.0.0 → 1.3.0
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 +153 -0
- package/package.json +1 -1
package/README.md
ADDED
|
@@ -0,0 +1,153 @@
|
|
|
1
|
+
# ngx-oneforall-mcp
|
|
2
|
+
|
|
3
|
+
Connect AI tools to **ngx-oneforall** documentation using the Model Context Protocol (MCP).
|
|
4
|
+
|
|
5
|
+
The MCP server gives AI assistants like Claude, Cursor, Windsurf, VS Code Copilot, and Antigravity **native knowledge** of all ngx-oneforall utilities — including correct import paths, API references, and usage examples.
|
|
6
|
+
|
|
7
|
+
---
|
|
8
|
+
|
|
9
|
+
## What is MCP?
|
|
10
|
+
|
|
11
|
+
MCP (Model Context Protocol) is a standard that lets AI tools connect to external knowledge sources. Instead of the AI guessing about your library, it can **look up real documentation** in real-time.
|
|
12
|
+
|
|
13
|
+
Without MCP, an AI might hallucinate:
|
|
14
|
+
```typescript
|
|
15
|
+
// ❌ Wrong import path
|
|
16
|
+
import { Draggable } from 'ngx-oneforall';
|
|
17
|
+
```
|
|
18
|
+
|
|
19
|
+
With MCP, the AI looks up the correct import:
|
|
20
|
+
```typescript
|
|
21
|
+
// ✅ Correct import path
|
|
22
|
+
import { DraggableDirective } from 'ngx-oneforall/directives/draggable';
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
---
|
|
26
|
+
|
|
27
|
+
## Installation
|
|
28
|
+
|
|
29
|
+
Install the MCP server globally or use it via `npx`:
|
|
30
|
+
|
|
31
|
+
```bash
|
|
32
|
+
npx ngx-oneforall-mcp
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
No additional dependencies are required in your Angular project.
|
|
36
|
+
|
|
37
|
+
---
|
|
38
|
+
|
|
39
|
+
## Setup by AI Tool
|
|
40
|
+
|
|
41
|
+
### Claude Desktop
|
|
42
|
+
|
|
43
|
+
Edit `~/Library/Application Support/Claude/claude_desktop_config.json` (macOS) or `%APPDATA%\Claude\claude_desktop_config.json` (Windows):
|
|
44
|
+
|
|
45
|
+
```json
|
|
46
|
+
{
|
|
47
|
+
"mcpServers": {
|
|
48
|
+
"ngx-oneforall": {
|
|
49
|
+
"command": "npx",
|
|
50
|
+
"args": ["-y", "ngx-oneforall-mcp"]
|
|
51
|
+
}
|
|
52
|
+
}
|
|
53
|
+
}
|
|
54
|
+
```
|
|
55
|
+
|
|
56
|
+
Restart Claude Desktop after saving.
|
|
57
|
+
|
|
58
|
+
### Cursor
|
|
59
|
+
|
|
60
|
+
Edit `.cursor/mcp.json` in your project root:
|
|
61
|
+
|
|
62
|
+
```json
|
|
63
|
+
{
|
|
64
|
+
"mcpServers": {
|
|
65
|
+
"ngx-oneforall": {
|
|
66
|
+
"command": "npx",
|
|
67
|
+
"args": ["-y", "ngx-oneforall-mcp"]
|
|
68
|
+
}
|
|
69
|
+
}
|
|
70
|
+
}
|
|
71
|
+
```
|
|
72
|
+
|
|
73
|
+
### Windsurf
|
|
74
|
+
|
|
75
|
+
Edit `~/.codeium/windsurf/mcp_config.json`:
|
|
76
|
+
|
|
77
|
+
```json
|
|
78
|
+
{
|
|
79
|
+
"mcpServers": {
|
|
80
|
+
"ngx-oneforall": {
|
|
81
|
+
"command": "npx",
|
|
82
|
+
"args": ["-y", "ngx-oneforall-mcp"]
|
|
83
|
+
}
|
|
84
|
+
}
|
|
85
|
+
}
|
|
86
|
+
```
|
|
87
|
+
|
|
88
|
+
### VS Code (GitHub Copilot)
|
|
89
|
+
|
|
90
|
+
Edit `.vscode/mcp.json` in your project root:
|
|
91
|
+
|
|
92
|
+
```json
|
|
93
|
+
{
|
|
94
|
+
"servers": {
|
|
95
|
+
"ngx-oneforall": {
|
|
96
|
+
"command": "npx",
|
|
97
|
+
"args": ["-y", "ngx-oneforall-mcp"]
|
|
98
|
+
}
|
|
99
|
+
}
|
|
100
|
+
}
|
|
101
|
+
```
|
|
102
|
+
|
|
103
|
+
### Antigravity
|
|
104
|
+
|
|
105
|
+
Configure your Antigravity agent settings:
|
|
106
|
+
|
|
107
|
+
```json
|
|
108
|
+
{
|
|
109
|
+
"mcpServers": {
|
|
110
|
+
"ngx-oneforall": {
|
|
111
|
+
"command": "npx",
|
|
112
|
+
"args": ["-y", "ngx-oneforall-mcp"]
|
|
113
|
+
}
|
|
114
|
+
}
|
|
115
|
+
}
|
|
116
|
+
```
|
|
117
|
+
|
|
118
|
+
---
|
|
119
|
+
|
|
120
|
+
## Available Tools
|
|
121
|
+
|
|
122
|
+
Once configured, your AI assistant can use these tools automatically:
|
|
123
|
+
|
|
124
|
+
| Tool | What it does |
|
|
125
|
+
|------|-------------|
|
|
126
|
+
| `get_utility_docs` | Returns full documentation for any utility by name |
|
|
127
|
+
| `search_utilities` | Searches utilities by keyword across names, descriptions, and docs |
|
|
128
|
+
| `list_utilities` | Lists all utilities, optionally filtered by category |
|
|
129
|
+
| `get_import_path` | Returns the exact TypeScript import statement for a utility |
|
|
130
|
+
|
|
131
|
+
---
|
|
132
|
+
|
|
133
|
+
## Example Usage
|
|
134
|
+
|
|
135
|
+
After setup, just ask your AI assistant naturally:
|
|
136
|
+
|
|
137
|
+
- *"How do I use the draggable directive from ngx-oneforall?"*
|
|
138
|
+
- *"What validators does ngx-oneforall provide?"*
|
|
139
|
+
- *"Show me the import path for the time-ago pipe"*
|
|
140
|
+
- *"What signals are available for reactive routing?"*
|
|
141
|
+
|
|
142
|
+
The AI will automatically call the MCP server to look up accurate documentation and provide correct answers.
|
|
143
|
+
|
|
144
|
+
---
|
|
145
|
+
|
|
146
|
+
## Resources
|
|
147
|
+
|
|
148
|
+
The MCP server also exposes resources that AI tools can read directly:
|
|
149
|
+
|
|
150
|
+
| Resource | URI |
|
|
151
|
+
|----------|-----|
|
|
152
|
+
| Structured index | `ngx-oneforall://llms.txt` |
|
|
153
|
+
| Per-utility docs | `ngx-oneforall://docs/{category}/{utility}` |
|