@unframed/mcp 0.0.0-stage → 1.0.0-rc.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 +52 -2
- package/data.json +2342 -0
- package/dist/data.js +7 -0
- package/dist/data.js.map +1 -0
- package/dist/index.js +7 -0
- package/dist/index.js.map +1 -0
- package/dist/server.js +76 -0
- package/dist/server.js.map +1 -0
- package/dist/validate.js +328 -0
- package/dist/validate.js.map +1 -0
- package/package.json +45 -4
package/README.md
CHANGED
|
@@ -1,3 +1,53 @@
|
|
|
1
|
-
#
|
|
1
|
+
# @unframed/mcp
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
[](https://www.npmjs.com/package/@unframed/mcp)
|
|
4
|
+
|
|
5
|
+
An [MCP](https://modelcontextprotocol.io) server for [Unframed](https://p-db.github.io/unframed-ui/). Your AI coding tool starts it on its own and uses it to look up the real components, instead of guessing, and to check the code it writes.
|
|
6
|
+
|
|
7
|
+
| Tool | What it does |
|
|
8
|
+
|---|---|
|
|
9
|
+
| `list_components` | Every component, with a summary, its tags and what to import |
|
|
10
|
+
| `get_component` | One component's examples and full API: attributes, properties, events, slots, parts, CSS custom properties |
|
|
11
|
+
| `validate_usage` | Checks code that uses Unframed: unknown tags, attributes and events, invalid values, `disabled="false"`, missing labels. Each problem comes with its line and a fix. Reads HTML, JSX, Vue, Angular, Svelte and Lit templates. |
|
|
12
|
+
|
|
13
|
+
It works offline: everything it knows ships in the package, generated from the same sources as the docs.
|
|
14
|
+
|
|
15
|
+
## Setup
|
|
16
|
+
|
|
17
|
+
Install it in your project, so it matches the Unframed version you use:
|
|
18
|
+
|
|
19
|
+
```bash
|
|
20
|
+
npm install -D @unframed/mcp
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
Then add it to your assistant. Commit the config file, so your whole team gets it.
|
|
24
|
+
|
|
25
|
+
**Claude Code**
|
|
26
|
+
|
|
27
|
+
```bash
|
|
28
|
+
claude mcp add unframed --scope project -- npx unframed-mcp
|
|
29
|
+
```
|
|
30
|
+
|
|
31
|
+
**Cursor**: `.cursor/mcp.json`
|
|
32
|
+
|
|
33
|
+
```json
|
|
34
|
+
{ "mcpServers": { "unframed": { "command": "npx", "args": ["unframed-mcp"] } } }
|
|
35
|
+
```
|
|
36
|
+
|
|
37
|
+
**VS Code**: `.vscode/mcp.json`
|
|
38
|
+
|
|
39
|
+
```json
|
|
40
|
+
{ "servers": { "unframed": { "type": "stdio", "command": "npx", "args": ["unframed-mcp"] } } }
|
|
41
|
+
```
|
|
42
|
+
|
|
43
|
+
Other assistants: start `npx unframed-mcp` as a stdio MCP server.
|
|
44
|
+
|
|
45
|
+
To try it without installing, use `npx -y @unframed/mcp` as the command instead. It runs the latest version, which may not match yours.
|
|
46
|
+
|
|
47
|
+
In Claude Code, the [Unframed plugin](https://p-db.github.io/unframed-ui/docs/ai-assistants) includes the server and the skill.
|
|
48
|
+
|
|
49
|
+
## Use it
|
|
50
|
+
|
|
51
|
+
Ask for what you need, like "add a sign-up form with Unframed". The assistant finds the components, reads their API, writes the code and checks it with `validate_usage` before showing it to you.
|
|
52
|
+
|
|
53
|
+
**[Documentation](https://p-db.github.io/unframed-ui/)** · **[GitHub](https://github.com/P-DB/unframed-ui)**
|