@microbuild/mcp 0.1.0 → 0.1.1
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 +33 -16
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -2,6 +2,8 @@
|
|
|
2
2
|
|
|
3
3
|
Model Context Protocol (MCP) server for Microbuild components. Enables AI agents like VS Code Copilot to discover, understand, and generate code using the **Copy & Own** distribution model.
|
|
4
4
|
|
|
5
|
+
[](https://www.npmjs.com/package/@microbuild/mcp)
|
|
6
|
+
|
|
5
7
|
## What is MCP?
|
|
6
8
|
|
|
7
9
|
The [Model Context Protocol](https://modelcontextprotocol.io) is an open standard that enables AI assistants to securely access external data sources and tools. This MCP server exposes the Microbuild component library to AI agents.
|
|
@@ -16,9 +18,6 @@ Microbuild uses the **Copy & Own** distribution model (similar to shadcn/ui):
|
|
|
16
18
|
- ✅ No breaking changes from upstream updates
|
|
17
19
|
- ✅ Works offline after installation
|
|
18
20
|
|
|
19
|
-
⚠️ **IMPORTANT:** `@microbuild/cli` is **NOT published to npm**.
|
|
20
|
-
You must clone `microbuild-ui-packages` locally and use the CLI from there.
|
|
21
|
-
|
|
22
21
|
## Features
|
|
23
22
|
|
|
24
23
|
- 📦 **Component Discovery** - List all available Microbuild components
|
|
@@ -29,14 +28,35 @@ You must clone `microbuild-ui-packages` locally and use the CLI from there.
|
|
|
29
28
|
|
|
30
29
|
## Installation
|
|
31
30
|
|
|
32
|
-
### For VS Code Copilot
|
|
31
|
+
### For VS Code Copilot (Recommended — via npx)
|
|
32
|
+
|
|
33
|
+
The MCP server is published on npm. No local build required.
|
|
34
|
+
|
|
35
|
+
Add to your VS Code `settings.json` or `.vscode/mcp.json`:
|
|
36
|
+
|
|
37
|
+
```json
|
|
38
|
+
{
|
|
39
|
+
"mcp": {
|
|
40
|
+
"servers": {
|
|
41
|
+
"microbuild": {
|
|
42
|
+
"command": "npx",
|
|
43
|
+
"args": ["@microbuild/mcp@latest"]
|
|
44
|
+
}
|
|
45
|
+
}
|
|
46
|
+
}
|
|
47
|
+
}
|
|
48
|
+
```
|
|
49
|
+
|
|
50
|
+
Reload VS Code window.
|
|
51
|
+
|
|
52
|
+
### For VS Code Copilot (Local build)
|
|
53
|
+
|
|
54
|
+
For development within the monorepo:
|
|
33
55
|
|
|
34
|
-
1.
|
|
56
|
+
1. Build the MCP server:
|
|
35
57
|
|
|
36
58
|
```bash
|
|
37
|
-
|
|
38
|
-
pnpm install
|
|
39
|
-
pnpm build
|
|
59
|
+
pnpm build:mcp
|
|
40
60
|
```
|
|
41
61
|
|
|
42
62
|
2. Add to your VS Code `settings.json` or `.vscode/mcp.json`:
|
|
@@ -236,8 +256,6 @@ Once configured, you can ask Copilot:
|
|
|
236
256
|
|
|
237
257
|
The AI agent will provide CLI commands that you can run to install components.
|
|
238
258
|
|
|
239
|
-
⚠️ **Note:** The CLI commands use local paths, not npx. You must run them from the microbuild-ui-packages directory.
|
|
240
|
-
|
|
241
259
|
## Development
|
|
242
260
|
|
|
243
261
|
```bash
|
|
@@ -276,7 +294,7 @@ pnpm typecheck
|
|
|
276
294
|
│ │ - get_rbac_pattern │ │
|
|
277
295
|
│ └──────────────────────────────────┘ │
|
|
278
296
|
│ ┌──────────────────────────────────┐ │
|
|
279
|
-
│ │ Component Registry (
|
|
297
|
+
│ │ Component Registry (embedded) │ │
|
|
280
298
|
│ │ - Metadata & Categories │ │
|
|
281
299
|
│ │ - Dependencies │ │
|
|
282
300
|
│ │ - File mappings │ │
|
|
@@ -284,13 +302,12 @@ pnpm typecheck
|
|
|
284
302
|
└─────────────────────────────────────────┘
|
|
285
303
|
│
|
|
286
304
|
┌────────────────▼────────────────────────┐
|
|
287
|
-
│
|
|
288
|
-
│
|
|
289
|
-
│
|
|
290
|
-
│ - Copies source to user project │
|
|
305
|
+
│ @microbuild/cli (npm) │
|
|
306
|
+
│ npx @microbuild/cli@latest add <comp> │
|
|
307
|
+
│ - Fetches source from GitHub CDN │
|
|
291
308
|
│ - Transforms imports │
|
|
292
309
|
│ - Resolves dependencies │
|
|
293
|
-
│
|
|
310
|
+
│ - Copies to user project │
|
|
294
311
|
└─────────────────────────────────────────┘
|
|
295
312
|
```
|
|
296
313
|
|
package/package.json
CHANGED