@godxjp/ui-mcp 0.18.0 → 0.19.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 +66 -29
- package/dist/index.js +518 -76
- package/dist/index.js.map +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -4,16 +4,20 @@ Model Context Protocol server for [`@godxjp/ui`](https://github.com/godx-jp/godx
|
|
|
4
4
|
Gives **Claude Code**, **Codex CLI**, **Cursor**, **Cline**, **Continue**, or any
|
|
5
5
|
MCP-aware agent live access to:
|
|
6
6
|
|
|
7
|
-
-
|
|
7
|
+
- 80+ component catalog (props, types, defaults, examples)
|
|
8
8
|
- 14 shared prop-vocabulary types (`SizeProp`, `ColorProp`, `LoadingProp`, …)
|
|
9
|
-
- 48 design tokens
|
|
10
|
-
-
|
|
11
|
-
-
|
|
12
|
-
-
|
|
13
|
-
redesign / output / brandkit / stitch / imagegen-mobile /
|
|
14
|
-
-
|
|
9
|
+
- 48 design tokens across the primitive / semantic / component tiers
|
|
10
|
+
- 41 cardinal rules from `CLAUDE.md`
|
|
11
|
+
- 9 canonical copy-paste-ready patterns (sign-up, settings, data-table, …)
|
|
12
|
+
- 15 design skills, each tagged by **audience** — 12 taste-family (taste / soft / minimalist /
|
|
13
|
+
brutalist / gpt-tasteskill / redesign / output / brandkit / stitch / imagegen-mobile /
|
|
14
|
+
imagegen-web / image-to-code) + the consumer build guides (`design-to-page`,
|
|
15
|
+
`compose-a-screen`) + the core `component-discipline` contract
|
|
16
|
+
- 23 anti-AI-tell patterns to AVOID + their fixes
|
|
15
17
|
- 50+ redesign-audit checks across 9 categories
|
|
16
18
|
- heuristic JSX linter (raw HTML / wrong vocab / banned default fonts / …)
|
|
19
|
+
- a consumer namespace (`list_consumer_skills` / `route_consumer_task` / `get_consumer_skill`)
|
|
20
|
+
that hides core library-maintenance skills, plus `draft_bug_report` for filing library bugs
|
|
17
21
|
|
|
18
22
|
**Token-efficient design:** discovery tools return small metadata; agents
|
|
19
23
|
drill into ONE section at a time via `get_skill_section`. Average
|
|
@@ -55,7 +59,7 @@ npx @godxjp/ui-mcp
|
|
|
55
59
|
}
|
|
56
60
|
```
|
|
57
61
|
|
|
58
|
-
Restart Claude Code. The
|
|
62
|
+
Restart Claude Code. The 21 tools appear under `mcp__godx_ui__*`.
|
|
59
63
|
|
|
60
64
|
### Codex CLI
|
|
61
65
|
|
|
@@ -138,13 +142,18 @@ Total: ~3 KB. Versus naive "give me everything about @godxjp/ui" = 50+ KB.
|
|
|
138
142
|
|
|
139
143
|
---
|
|
140
144
|
|
|
141
|
-
## Tools (
|
|
145
|
+
## Tools (21)
|
|
146
|
+
|
|
147
|
+
> **Building an app with @godxjp/ui?** Start with `list_consumer_skills` / `route_consumer_task`
|
|
148
|
+
> (the Consumer namespace below) — they hide library-maintenance material. The data tools
|
|
149
|
+
> (`get_component`, `get_tokens`, `get_rule`, `get_vocab`, `get_pattern`, `lint_jsx`) serve both
|
|
150
|
+
> audiences.
|
|
142
151
|
|
|
143
152
|
### Discovery (small responses — start here)
|
|
144
153
|
|
|
145
154
|
| Tool | Returns | Size |
|
|
146
155
|
| ---------------------- | ------------------------------------------------------------ | ------ |
|
|
147
|
-
| `list_skills` |
|
|
156
|
+
| `list_skills` | 15 design skills (audience-tagged) + section ids | ~1 KB |
|
|
148
157
|
| `list_primitives` | All components, grouped + tagline. Optional `group` filter. | ~3 KB |
|
|
149
158
|
| `list_patterns` | 7 canonical patterns + taglines | ~500 B |
|
|
150
159
|
| `list_anti_ai_tells` | 20+ AI-tell patterns. Optional `category` filter. | ~2 KB |
|
|
@@ -157,7 +166,7 @@ Total: ~3 KB. Versus naive "give me everything about @godxjp/ui" = 50+ KB.
|
|
|
157
166
|
| `get_skill_section` | ONE section of ONE skill | ~2 KB |
|
|
158
167
|
| `get_component` | Full API for one component | ~2 KB |
|
|
159
168
|
| `get_pattern` | Full code snippet for one pattern | ~3 KB |
|
|
160
|
-
| `get_rule` | One cardinal rule (or all
|
|
169
|
+
| `get_rule` | One cardinal rule (or all 41) | ~500 B / ~10 KB |
|
|
161
170
|
| `get_vocab` | One vocab type (or all 14) | ~500 B / ~3 KB |
|
|
162
171
|
| `get_tokens` | Tokens (optionally by category) | ~5 KB |
|
|
163
172
|
|
|
@@ -169,6 +178,15 @@ Total: ~3 KB. Versus naive "give me everything about @godxjp/ui" = 50+ KB.
|
|
|
169
178
|
| `suggest_primitive` | Use case → recommended primitive + rationale | ~500 B |
|
|
170
179
|
| `search_components` | Fuzzy-search by name / tagline / prop | ~1 KB |
|
|
171
180
|
|
|
181
|
+
### Consumer namespace (app-dev surface — core skills hidden)
|
|
182
|
+
|
|
183
|
+
| Tool | Returns | Size |
|
|
184
|
+
| ---------------------- | ---------------------------------------------------------------------- | ------ |
|
|
185
|
+
| `list_consumer_skills` | Design skills for building WITH @godxjp/ui (consumer/both only) | ~1 KB |
|
|
186
|
+
| `route_consumer_task` | Natural-language task → consumer skill+section (never core) | ~300 B |
|
|
187
|
+
| `get_consumer_skill` | One section of one consumer skill; refuses core-only skills | ~2 KB |
|
|
188
|
+
| `draft_bug_report` | Drafts a GitHub issue body + a `gh issue create` command for a lib bug | ~1 KB |
|
|
189
|
+
|
|
172
190
|
### Lint (one-shot critique)
|
|
173
191
|
|
|
174
192
|
| Tool | Returns | Size |
|
|
@@ -177,26 +195,45 @@ Total: ~3 KB. Versus naive "give me everything about @godxjp/ui" = 50+ KB.
|
|
|
177
195
|
|
|
178
196
|
---
|
|
179
197
|
|
|
180
|
-
##
|
|
198
|
+
## Consumer vs Core — who each skill is for
|
|
181
199
|
|
|
182
|
-
|
|
200
|
+
Every skill carries an **audience** tag:
|
|
183
201
|
|
|
184
|
-
-
|
|
202
|
+
- **`consumer`** — you're building an APP that imports `@godxjp/ui`. Reach these via
|
|
203
|
+
`list_consumer_skills` / `route_consumer_task` / `get_consumer_skill`.
|
|
204
|
+
- **`core`** — you're building/maintaining `@godxjp/ui` ITSELF (the library, its docs, this
|
|
205
|
+
catalog). Hidden from the consumer tools so an app-dev never trips over them. The full core
|
|
206
|
+
discipline lives in the repo's `.claude/skills/` (see that folder's `README.md`).
|
|
207
|
+
- **`both`** — universal (e.g. `taste`, `output`, `redesign`).
|
|
185
208
|
|
|
186
|
-
|
|
187
|
-
|
|
188
|
-
|
|
189
|
-
|
|
190
|
-
|
|
191
|
-
|
|
192
|
-
|
|
193
|
-
|
|
194
|
-
|
|
195
|
-
|
|
196
|
-
|
|
197
|
-
|
|
|
198
|
-
|
|
|
199
|
-
| `
|
|
209
|
+
> Found a `@godxjp/ui` bug, or a rule you literally cannot follow because the library is wrong?
|
|
210
|
+
> **Don't hand-roll a fake workaround.** Call `draft_bug_report` to generate a detailed issue body
|
|
211
|
+
>
|
|
212
|
+
> - a `gh issue create --repo godx-jp/godxjp-ui …` command, file it, then mark any minimal local
|
|
213
|
+
> workaround with `// TODO(godxui#<n>)`. See `design-to-page/report-bug` or `compose-a-screen/report-bug`.
|
|
214
|
+
|
|
215
|
+
## Skills bundled (15)
|
|
216
|
+
|
|
217
|
+
Taste family synthesised from [Leonxlnx/taste-skill](https://github.com/Leonxlnx/taste-skill);
|
|
218
|
+
consumer/core guides are framework-native.
|
|
219
|
+
|
|
220
|
+
| Skill | Audience | When to use |
|
|
221
|
+
| ---------------------- | -------- | ------------------------------------------------------------ |
|
|
222
|
+
| `taste` | both | Default — production app screen baseline |
|
|
223
|
+
| `soft` | consumer | Premium agency / Awwwards-tier ($150k brief) |
|
|
224
|
+
| `minimalist` | consumer | Editorial workspace (Notion-like) — warm monochrome + bento |
|
|
225
|
+
| `brutalist` | consumer | Data-heavy dashboards, declassified-blueprint feel |
|
|
226
|
+
| `gpt-tasteskill` | consumer | Long-scroll marketing, GSAP ScrollTrigger choreography |
|
|
227
|
+
| `redesign` | both | Auditing + upgrading EXISTING project |
|
|
228
|
+
| `output` | both | Always — bans `// ...` / `// TODO` patterns |
|
|
229
|
+
| `brandkit` | consumer | Brand identity boards before screens |
|
|
230
|
+
| `stitch` | consumer | Generate DESIGN.md for Google Stitch / similar generators |
|
|
231
|
+
| `imagegen-mobile` | consumer | Pre-code phase — mobile app screen mockups |
|
|
232
|
+
| `imagegen-web` | consumer | Pre-code phase — landing page section images |
|
|
233
|
+
| `image-to-code` | consumer | Visual brief → working frontend code |
|
|
234
|
+
| `design-to-page` | consumer | A Claude Design handoff → a real page in YOUR app |
|
|
235
|
+
| `compose-a-screen` | consumer | A new screen from a written brief, via real primitives |
|
|
236
|
+
| `component-discipline` | core | International-standards hard contract (building the library) |
|
|
200
237
|
|
|
201
238
|
---
|
|
202
239
|
|
|
@@ -233,7 +270,7 @@ Synthesised from [Leonxlnx/taste-skill](https://github.com/Leonxlnx/taste-skill)
|
|
|
233
270
|
| `godx-ui://prop-vocabulary` | JSON | Shared vocab |
|
|
234
271
|
| `godx-ui://tokens` | JSON | All tokens |
|
|
235
272
|
| `godx-ui://tokens/{category}` | JSON | Tokens by category |
|
|
236
|
-
| `godx-ui://rules` | Markdown | All
|
|
273
|
+
| `godx-ui://rules` | Markdown | All 41 rules |
|
|
237
274
|
| `godx-ui://rules/{number}` | Markdown | One rule |
|
|
238
275
|
| `godx-ui://patterns` | JSON | Pattern index |
|
|
239
276
|
| `godx-ui://patterns/{name}` | Markdown | One pattern |
|