uxui-principles
Server Configuration
Describes the environment variables required to run the server.
| Name | Required | Description | Default |
|---|---|---|---|
| UXUI_API_KEY | No | Optional. Principles Library API key from uxuiprinciples.com/developers. Turns on pro mode: full guides, AI prompts and the audit_interface tool. |
Instructions
Guidance the server publishes about itself, which clients place ahead of the tool catalog so the model reads it before choosing anything.
Provides 195 research-backed UX/UI principles, 12 UX smells (anti-patterns) with fix recipes, and 12 user-flow checklists (onboarding, forms, pricing, checkout, navigation and more), in English and Spanish.
Use search_principles / list_principles / get_principle to ground UI decisions in evidence. Use detect_smell or suggest_fix when a UI has a described problem. Use get_flow / generate_checklist before designing or shipping a known flow.
All tools are read-only. get_principle carries the citations behind each principle. Free mode: the full guide bodies, the 600+ AI prompts, audit_interface and check_requirements need UXUI_API_KEY set to a Principles Library key (uxuiprinciples.com/en/developers). Everything else runs offline from the bundled dataset.
After generating or changing a screen, call check_requirements with the flow, the components, the actions (flag the consequential and automated ones) and the states you implemented; fix every rule it reports as fail before you finish.
Capabilities
Features and capabilities supported by this server
Protocol revision2025-11-25
| Capability | Details |
|---|---|
| tools | {} |
Tools
Functions exposed to the LLM to take actions
| Name | Description |
|---|---|
| get_principleA | Get one UX/UI principle by slug: title, code, part, difficulty, summary, the bibliographic citations behind it (author, title, year, url) and the link to the full guide on uxuiprinciples.com. With UXUI_API_KEY set (pro mode) the full guide body comes back in |
| search_principlesA | Search the 195 UX/UI principles by free text, part, difficulty or tags. Returns the matching principles with slug, title, code, part name and summary, plus the total count. Use it to find which principles apply to a design question before calling get_principle. |
| list_principlesA | List the 195 UX/UI principles, optionally one part at a time. Returns principle summaries (slug, title, code, part name, summary), the total count and the list of part ids. Use it to browse the catalogue or to learn the part ids for search_principles. |
| get_principle_promptsA | Get the ready-to-use AI prompts attached to one principle (prompts to apply, audit or refactor an interface against it). With UXUI_API_KEY set (pro mode) the prompt texts come back in |
| get_smellA | Get one UX smell (interface anti-pattern) by id: name, tagline, symptoms, the Nielsen heuristic it breaks, a step-by-step fix recipe with a time estimate, the related principles and an audit prompt plus a refactoring prompt. Use it once you know the smell id, from list_smells or detect_smell. |
| list_smellsA | List the 12 UX smells (interface anti-patterns such as overloaded screens, form graveyards, silent errors or the AI-aesthetic cliches), optionally filtered by category. Returns id, name, short name, tagline, category and Nielsen heuristic for each. Use it to browse the catalogue before get_smell. |
| detect_smellA | Detect which UX smells match a plain-language description of an interface problem or a user complaint, in English or Spanish. Returns the matched smells with a confidence level and the suggested fix for each. Use it as the first step when a UI "feels off" and the cause is not named yet; runs offline. |
| suggest_fixA | Get a fix for a described UX issue: detects the most likely smell (or uses the one you pass), then returns its step-by-step fix recipe, the principles to apply and a refactoring prompt you can hand to a coding agent. Use it when you want an actionable remedy rather than a diagnosis; runs offline. |
| get_flowA | Get one user flow (onboarding, forms, pricing, dashboard, checkout, search, authentication and more) with its target metrics, the pre-flight checklist to run before designing it and the post-flight checklist to run before shipping it. Use it before designing or shipping a known flow. |
| list_flowsA | List the 12 user flows covered by the checklists (onboarding, forms, pricing, dashboard, empty states, checkout, settings, navigation, search, authentication, notifications, data tables) with the target metric of each. Returns id, name, description, metric target and the number of checklist items per phase. Use it to pick the id for get_flow, generate_checklist or get_flow_principles. |
| generate_checklistA | Generate the pre-flight (before design) or post-flight (before ship) checklist for one user flow. Returns the checklist as structured items (each tied to a principle) and as ready-to-paste markdown. Use it to review a design or a pull request against the flow it implements. |
| get_flow_principlesA | Get the key principles that govern one user flow and the UX smells that most often break it. Returns the principle slugs and the smell ids so you can read them with get_principle and get_smell. Use it to ground a flow review in evidence. |
| audit_interfaceA | Audit a described screen or flow: returns findings mapped to principles and UX smells, each with severity, remediation and business impact, plus a score, the detected interface type, strengths and the three priority fixes. Pro mode only (UXUI_API_KEY set): the audit runs on the uxuiprinciples.com API. Without a key use detect_smell then suggest_fix, which run offline. |
| check_requirementsA | Check a screen you built or designed against eight experience requirements: confirmation before consequential actions, error state, empty state, loading state, undo or edit, sources on AI output, recovery after an AI error, consent before automation. Describe the screen as data (flow, components, actions with flags, states implemented) and get pass, fail or not_applicable per rule, each with the principle it comes from and its citations, plus a markdown summary. Call it after generating or changing a screen and fix every fail. Pro mode only (UXUI_API_KEY set); without a key use generate_checklist for the unevaluated checklist. |
Prompts
Interactive templates invoked by user choice
| Name | Description |
|---|---|
No prompts | |
Resources
Contextual data attached and managed by the client
| Name | Description |
|---|---|
No resources | |
TDQS
Scored across 14 tools
The catalogue tools are cleanly tiered (list → search → get) across three distinct resources (principles, smells, flows), so picking one is easy. Two overlaps remain: audit_interface vs check_requirements both evaluate a described screen, and get_flow already returns pre/post-flight checklists that generate_checklist also produces, so an agent must read descriptions to choose.
Every tool is snake_case with a leading verb (get_, list_, search_, detect_, suggest_, generate_, audit_, check_), and the pattern maps predictably onto resource nouns. Companion tools share stems (list_principles/get_principle, list_smells/get_smell, list_flows/get_flow), which makes the surface easy to scan.
14 tools sits comfortably in the well-scoped range and each one maps to a real step: browse/search/read for principles, smells and flows, plus audit and checklist generation. Nothing feels padded, and the pro/offline notes are consistent across the set.
The read-only reference domain is well covered: principles (list/search/get/prompts), smells (list/get/detect/fix), flows (list/get/checklist/principles) plus audit and requirement checks. Minor gaps: no free-text smell search outside detect_smell, no way to fetch several principles in one call, and no direct path from an audit finding back to its principle other than a second call.