Getting Started
pudge-ui works by feeding design specs to your coding agent. There are two ways to use it.
With MCP (Recommended)
If your tool supports MCP (Claude Code, Cursor, etc.), add pudge-ui as an MCP server:
{
"mcpServers": {
"pudge-ui": {
"command": "npx",
"args": ["-y", "pudge-ui-mcp"]
}
}
} Then ask your agent:
"Build me a push button using pudge-ui specs" The MCP server serves foundation context + component specs automatically.
Manual (Copy & Paste)
No MCP? No problem. Copy the specs directly into your LLM context:
- Copy foundation files — Start with tokens, materials, and depth model.
- Copy component spec — Browse the component gallery, find the component you need, and use the "Copy spec for LLM" button.
- Paste into your LLM — Include both foundation + component spec in your prompt.
Prompt Templates
For best results, use structured prompts. See the For LLMs guide for templates and tips.
Foundation Overview
The foundation consists of 9 specification files that define the design system's rules:
| File | Purpose |
|---|---|
| tokens.md | Color, spacing, typography, radius, motion, shadow values |
| materials.md | 6 material recipes with full CSS |
| depth-model.md | Shadow stack rules, press interactions, glow effects |
| philosophy.md | Core design principles |
| naming.md | Class naming conventions |
| layout.md | Grid and spacing system |
| theme.md | Dark/light mode token sets |
| canvas.md | Canvas rendering specs for animated components |
| accessibility.md | ARIA patterns and keyboard navigation |