@refineui/mcp 0.1.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 +69 -0
- package/lib/chunk-BIQ6ODHB.js +1522 -0
- package/lib/index.d.ts +34 -0
- package/lib/index.js +24 -0
- package/lib/server.d.ts +2 -0
- package/lib/server.js +413 -0
- package/package.json +48 -0
package/README.md
ADDED
|
@@ -0,0 +1,69 @@
|
|
|
1
|
+
# @refineui/mcp
|
|
2
|
+
|
|
3
|
+
MCP server for [RefineUI](https://ui.pelagornis.com) — search docs, fetch component pages, read design rules, and browse token categories from MCP-compatible agents.
|
|
4
|
+
|
|
5
|
+
## Install
|
|
6
|
+
|
|
7
|
+
```bash
|
|
8
|
+
bun add -d @refineui/mcp
|
|
9
|
+
# or
|
|
10
|
+
npm install -D @refineui/mcp
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
## MCP configuration
|
|
14
|
+
|
|
15
|
+
Add to your MCP host config:
|
|
16
|
+
|
|
17
|
+
```json
|
|
18
|
+
{
|
|
19
|
+
"mcpServers": {
|
|
20
|
+
"refineui": {
|
|
21
|
+
"command": "bunx",
|
|
22
|
+
"args": ["@refineui/mcp"]
|
|
23
|
+
}
|
|
24
|
+
}
|
|
25
|
+
}
|
|
26
|
+
```
|
|
27
|
+
|
|
28
|
+
From the monorepo after build:
|
|
29
|
+
|
|
30
|
+
```json
|
|
31
|
+
{
|
|
32
|
+
"mcpServers": {
|
|
33
|
+
"refineui": {
|
|
34
|
+
"command": "node",
|
|
35
|
+
"args": ["/absolute/path/to/refineui/packages/mcp/lib/server.js"]
|
|
36
|
+
}
|
|
37
|
+
}
|
|
38
|
+
}
|
|
39
|
+
```
|
|
40
|
+
|
|
41
|
+
## Tools
|
|
42
|
+
|
|
43
|
+
| Tool | Description |
|
|
44
|
+
|------|-------------|
|
|
45
|
+
| `search_docs` | Keyword search across docs (optional category filter) |
|
|
46
|
+
| `get_doc_page` | Fetch a page by slug (`components/button`, …) |
|
|
47
|
+
| `list_components` | All component doc pages |
|
|
48
|
+
| `list_foundations` | All foundation doc pages |
|
|
49
|
+
| `get_llm_index` | Full `llm.txt` content |
|
|
50
|
+
| `get_design_rules` | Full `DESIGN.md` (Stitch alpha) |
|
|
51
|
+
| `list_tokens` | Token categories + semantic text roles |
|
|
52
|
+
| `get_index_meta` | Embedded index generation metadata |
|
|
53
|
+
| `run_doctor` | Read-only RefineUI workspace diagnostics (via `@refineui/doctor`) |
|
|
54
|
+
|
|
55
|
+
## Resources
|
|
56
|
+
|
|
57
|
+
- `refineui://llm.txt` — machine-readable docs index
|
|
58
|
+
- `refineui://DESIGN.md` — Stitch-compatible design identity
|
|
59
|
+
- `refineui://design-rules` — alias of `DESIGN.md`
|
|
60
|
+
|
|
61
|
+
## Development
|
|
62
|
+
|
|
63
|
+
```bash
|
|
64
|
+
bun run build:index # regenerate docs index from ../../docs
|
|
65
|
+
bun run build
|
|
66
|
+
bun run start # stdio MCP server
|
|
67
|
+
```
|
|
68
|
+
|
|
69
|
+
Requires Node.js ≥ 20.
|