npm uxloomstdioMITupdated 1mo ago
Your generator gave you 6 screens. UXLoom proves you're missing 9 states.
What can you do with uxloom?
UXLoom
Your generator gave you 6 screens. UXLoom proves you're missing 9 states.
AI generators (v0, Lovable, Figma Make, Claude) produce happy-path screens. UXLoom is the critic layer: it models user journeys as state machines, treats screens as nodes with state contracts, and mechanically proves what's missing before a line of production code exists โ unreachable screens, dead ends, missing error/empty/loading states, WCAG contrast failures, undersized touch targets, and labels that will overflow under localization.
Agent-native by design: the interface is an MCP server (works with Claude Code, Codex, and any MCP client), with Agent Skills included.
Deterministic by design: same input, byte-identical report โ benchmarked
(packages/bench) at 1.000 precision/recall on a seeded
defect catalog, SHA-256-stable across processes, 1000 screens in under 5ms.
That's what lets design completeness gate CI, where an LLM opinion can't.
Website: uxloom.dev ยท npm: uxloom ยท MCP registry: io.github.uxloom-dev/uxloom ยท

Packages
| Package | What it is |
|---|---|
@uxloom/journeygraph |
The open design-as-data format: journeys as state machines, screens as nodes with required states |
@uxloom/critics |
The validators: journey completeness, state coverage, WCAG contrast, touch targets, text expansion |
uxloom |
The MCP server + Agent Skills โ the interface agents use |
New here? Start with the Quickstart โ prerequisites, the Claude Code walkthrough, what to say to your agent, and troubleshooting.

Quick start (agents)
# Claude Code
claude mcp add uxloom -- npx -y uxloom
# Codex CLI
codex mcp add uxloom -- npx -y uxloom
The project file (uxloom.project.json) lives in your workspace and belongs
in git โ the design is data, versioned next to the code it specifies.
Quick start (humans & CI)
npx uxloom init # one-command setup: MCP config + agent skill + starter file
npx uxloom preview # live mocks (themed, commentable, EDITABLE in the browser)
npx uxloom export # shareable HTML โ plus --svg (Figma/Penpot import; add
# --manifest for the round-trip key) and --png (playwright)
npx uxloom check # design completeness โ exit 1 on errors, CI-ready
npx uxloom audit # implementation drift โ web AND native (Swift/Kotlin/
# Dart/Java markers); --live verifies the real DOM;
# --design <file|dir> audits a Figma/Penpot export vs the contract
npx uxloom diff # human-readable design diffs for PR review
Evidence-based design: every decision in the contract can carry its
rationale โ reasoning, rejected alternatives with pros/cons, sources,
confidence โ enforced by the critics once adopted, iterated through a
bounded design_review loop (max 3 rounds), and shown to stakeholders in
the preview's evidence panel (โ) and exports. The design doesn't just
validate; it argues its case.
Agent-addressable comments: a reviewer drops a pinned comment in the
preview and clicks "โ agent". The comment becomes a work item any Gen-AI
model can read with full context โ comment_context returns the pinned
layout block, the screen contract, the journey references, and the current
findings for that screen โ act on, and resolve back into the preview with
a note. One click from feedback to addressed.

CI-native: check and audit take --json, --sarif (GitHub code
scanning), and --github (inline PR annotations). Brownfield-ready:
--update-baseline freezes existing findings so only new drift blocks;
uxloom.config.json tunes thresholds to your accessibility bar. Full
documentation: uxloom.dev/docs.html.

Add it to CI and a happy-path-only design can never merge:
- run: npx uxloom check design/uxloom.project.json
Workflow (also shipped as a skill in packages/mcp-server/skills/):
project_init โ brief_start/brief_answer โ journey_define โ
screen_register โ project_validate โ fix โ repeat until zero errors โ
coverage_report.
Does it actually catch things?
tools/dogfood.mjs drives the real MCP server through three products, twice
each: screens as a happy-path generator hands them over, then repaired using
the validation report. Artifacts in examples/.
| Product | Generated (happy-path) | Repaired |
|---|---|---|
shopmweb โ e-commerce checkout (mWeb + Android) |
9 errors, 6 warnings | 0 / 0 |
taskflow โ SaaS signup/onboarding (web) |
1 error, 6 warnings | 0 / 0 |
ridenow โ ride booking (iOS + Android, offline-heavy) |
3 errors, 7 warnings | 0 / 0 |
Caught: an unreachable promo screen, dead-end verification states, five
undesigned payment/error states, a 2.4:1 contrast button, a 40px touch target
on Android, a checkout label that breaks in German, and three products' worth
of missing offline states. Zero errors and zero warnings is reachable
honestly โ screens declare documented exemptions where a baseline state
genuinely cannot apply, and contradictory exemptions are flagged.
Development
npm install
npm run typecheck
npm test
Status
Released and maintained: on npm and
the official MCP registry, with the benchmark scorecard published in every
GitHub release. The
JourneyGraph format (formatVersion: "0.1") may evolve until 1.0; releases
follow RELEASING.md โ every surface is drift-checked in CI.
License
MIT
Install
Add uxloom to your client. Pick the one you use.
claude mcp add uxloom -- npx -y uxloomcodex mcp add uxloom -- npx -y uxloomamp mcp add uxloom -- npx -y uxloom{
"mcpServers": {
"uxloom": {
"command": "npx",
"args": [
"-y",
"uxloom"
]
}
}
}Add to `claude_desktop_config.json`, then restart Claude Desktop.
{
"mcpServers": {
"uxloom": {
"command": "npx",
"args": [
"-y",
"uxloom"
]
}
}
}Add to `~/.cursor/mcp.json`, or `.cursor/mcp.json` for a single project.
code --add-mcp '{"name":"uxloom","command":"npx","args":["-y","uxloom"]}'Or add the block manually to `.vscode/mcp.json` under `servers`.
{
"mcpServers": {
"uxloom": {
"command": "npx",
"args": [
"-y",
"uxloom"
]
}
}
}Add to `~/.codeium/windsurf/mcp_config.json`.
{
"mcpServers": {
"uxloom": {
"command": "npx",
"args": [
"-y",
"uxloom"
]
}
}
}Add to `cline_mcp_settings.json` via the MCP Servers panel.
{
"mcpServers": {
"uxloom": {
"command": "npx",
"args": [
"-y",
"uxloom"
]
}
}
}Add to `~/.gemini/settings.json`.
{
"mcpServers": {
"uxloom": {
"type": "local",
"command": "npx",
"args": [
"-y",
"uxloom"
],
"tools": [
"*"
]
}
}
}Add to `~/.copilot/mcp-config.json`, or run `/mcp add` inside the CLI.
{
"context_servers": {
"uxloom": {
"command": {
"path": "npx",
"args": [
"-y",
"uxloom"
]
}
}
}
}Add to your Zed `settings.json`.
npx -y uxloomRun `goose configure`, choose **Add Extension โ Command-line Extension**, and paste this command.
Score
39 / 100
Incomplete
- Documentation21/25
- Maintenance25/25
- Trust16/20
- Capability0/15
- Install experience12/15
- Documents what it does and how to connect
- Has a resolvable package or endpoint
- Exposes at least one tool, prompt or resource
- README has substantive content
- Includes a code example
- Documents its configuration
- Mentions credentials or security posture
- Last commit 22 days ago
- Has a release history
- Repository is not archived
- Licensed MIT
- Namespace verified in the official MCP registry
- Claimed by its owner
- Published under an organisation
- 0 tool(s) documented
- Provides prompt templates
- Provides resources
- 12 documented install method(s)
- Published to a package registry
- Offers a hosted endpoint โ no local install
Version history
| Versions | Published |
|---|---|
| 0.13.0 | Aug 9, 2026 |
| 0.14.0Latest | Aug 9, 2026 |
| 0.12.0 | Aug 9, 2026 |
| 0.11.0 | Aug 9, 2026 |
| 0.10.1 | Aug 9, 2026 |
| 0.10.0 | Aug 9, 2026 |
| 0.9.1 | Aug 8, 2026 |
| 0.9.0 | Aug 8, 2026 |
| 0.8.0 | Aug 8, 2026 |
| 0.7.0 | Aug 8, 2026 |
| 0.6.1 | Aug 8, 2026 |
| 0.6.0 | Aug 8, 2026 |
| 0.5.0 | Jul 18, 2026 |
| 0.4.1 | Jul 18, 2026 |
| 0.4.0 | Jul 18, 2026 |
| 0.3.0 | Jul 18, 2026 |
| 0.1.3 | Jul 13, 2026 |
| 0.1.2 | Jul 13, 2026 |
| 0.1.1 | Jul 12, 2026 |