uxlint
Officialuxlint
Prüfen Sie die UX jeder Website so, wie es ein designkundiger Reviewer tun würde: Kontrast, Tap-Ziele, Typografie-Skala, Farbdisziplin, Scan-Muster, Landmarken. Jeder Befund wird mit einer konkreten Lösung geliefert, die ein Agent (oder ein Mensch) direkt anwenden kann. Es ist dafür konzipiert, in der Schleife eines Coding-Agents (MCP) zu sitzen und iteriert zu werden, bis alles grün ist.

Ein echter Lauf, von Anfang bis Ende: audit_url → Note B, ein Kontrastfehler von 2,39:1 und drei CTAs in drei verschiedenen Akzentfarben → die Lösung → verify_fix → Note A. Jede Zahl darin stammt von den Tools; nur das Warten wurde herausgeschnitten.
Dies ist die CLI: eine kleine, einzelne statische Rust-Binärdatei. Sie steuert ein bereits installiertes Chrome/Chromium über das DevTools-Protokoll (kein Node, kein Playwright, kein Headless-Browser-Download), erfasst, wie eine Seite aussieht und liest, und sendet das an den gehosteten Server von uxlint, der die eigentliche Bewertung vornimmt. Die Regel-Engine, die kalibrierten Schwellenwerte und der LLM-Richter leben alle serverseitig, sodass der Client nie aktualisiert werden muss, wenn sich eine Regel ändert.
┌──────────────────────────┐ POST /v1/audit {snapshots} ┌──────────────────────────┐
│ uxlint (this binary) │ ───────────────────────────────────────▶ │ uxlint-server (hosted) │
│ drives YOUR Chrome (CDP) │ ◀─────────────────────────────────────── │ rules engine + LLM judge │
└──────────────────────────┘ report {findings + fixes} └──────────────────────────┘Installation
curl -fsSL https://uxlint.net/install.sh | sh # detects OS/arch, verifies checksumOder mit mise – sein github-Backend zieht den passenden Build aus GitHub Releases, verifiziert ihn und aktualisiert bei mise up:
mise use -g "github:uxlint-net/uxlint-cli[rename_exe=uxlint]@latest"oder pinne es in einer mise.toml eines Projekts:
[tools]
"github:uxlint-net/uxlint-cli" = { version = "latest", rename_exe = "uxlint" }Oder aus dem Quellcode bauen (benötigt eine aktuelle stabile Rust-Toolchain und ein Chrome/Chromium im PATH):
git clone https://github.com/uxlint-net/uxlint-cli && cd uxlint-cli
cargo build --release
./target/release/uxlint --versionRelated MCP server: Prufa
Schnellstart
uxlint auth login # opens your browser, saves a token
uxlint audit --base https://your-site.com --routes /,/pricingZum ersten Mal ein eigenes Projekt prüfen? uxlint init wählt (oder erstellt) eine Site, an die Berichte angehängt werden, und schreibt eine uxlint.toml, sodass jede zukünftige Prüfung in diesem Verzeichnis einfach funktioniert:
uxlint init
uxlint audit --base http://localhost:5173 --routes /,/pricingExit-Code 1 bei Befunden über der konfigurierten Schwere → direkt in CI einbinden (siehe .github/workflows/ für eine Vorlage oder die GitHub Action uxlint-net/uxlint-action).
Ausblenden von Elementen aus einem Audit (uxlint-hide)
Einige On-Page-Elemente sind keine Produkt-UI und sollten nicht bewertet werden: ein Dev/Staging-Umgebungsbanner, ein „DEV“-Marker, eine Debug-Symbolleiste, ein Storybook/Vorschau-Element. Fügen Sie die Klasse uxlint-hide zu einem solchen Element hinzu, und das Audit entfernt es – es ist ab dem ersten Rendern display:none, erscheint also nie in einem Screenshot und ist für den Collector unsichtbar (es erzeugt keine Befunde):
<div class="env-banner uxlint-hide">STAGING</div>Die Klasse ist auf Ihrer echten Website wirkungslos – sie tut nichts, außer wenn das Audit läuft, weil das Stylesheet, das sie verbirgt (.uxlint-hide { display: none !important; }), nur vom Browser von uxlint injiziert wird, bevor die eigenen Skripte der Seite laufen. Gestalten Sie Ihr Element in der übrigen Zeit, wie Sie möchten. Sie gilt in jedem Erfassungspfad – beim Crawl, bei Goal-Walk-Tests und bei Fix-Vorschauen.
MCP (Verwendung aus einem Coding-Agent)
Claude Code, ein Befehl:
/plugin marketplace add uxlint-net/uxlint-cli
/plugin install uxlint@uxlintDas installiert den uxlint-MCP-Server und, falls die CLI nicht bereits im PATH ist, lädt er die passende Version einmalig mit demselben prüfsummenverifizierenden Installer wie oben herunter – so aktualisiert /plugin update auch die darunterliegende CLI. Kein Node nötig: Es lädt eine statische Binärdatei herunter (gegen eine veröffentlichte Prüfsumme verifiziert) und steuert das bereits vorhandene Chrome.
Jeder andere Agent – eine Zeile (das npm-Paket lädt die Binärdatei für Ihre Plattform herunter, verifiziert die daneben veröffentlichte Prüfsumme und übergibt sie). Dies ist der einzige Weg, der Node 18+ benötigt, für npx selbst; wenn Sie das nicht möchten, installieren Sie die Binärdatei mit der Zeile oben und registrieren Sie diese:
claude mcp add uxlint -- npx -y @uxlint-net/uxlint mcpOder für einen Client, der eine JSON-Konfiguration liest:
{ "mcpServers": { "uxlint": { "command": "npx", "args": ["-y", "@uxlint-net/uxlint", "mcp"] } } }uxlint ist auch im MCP-Registry als io.github.uxlint-net/uxlint für Clients, die darin stöbern. Haben Sie die CLI bereits? uxlint mcp install registriert sie direkt, ohne npx-Wrapper.
Es gibt kein Token, das zuerst eingerichtet werden muss: Bitten Sie Ihren Agenten, etwas zu prüfen, während Sie abgemeldet sind, und er gibt Ihnen einen Anmeldelink, der das Token für Sie erstellt und speichert (UXLINT_API_KEY ist für CI, das keinen Browser hat).
Fünf Tools: audit_url (vollständiges Audit, bewertetes Urteil + Aktionsplan), verify_fix (eine Regel auf einer Seite nach einer Bearbeitung erneut prüfen, ~2s), get_shot (annotierten Screenshot eines Befunds abrufen), ux_guidance (Best-Practice-Anleitung, die vor dem Erstellen von UI gelesen werden sollte) und lint_feedback – opt-in und standardmäßig deaktiviert (§ Datenschutz) – ein Tool für drei Arten von Signalen: ob ein Befund nützlich war, ein Lint, das uxlint fehlt, oder eine Komponentenbibliothek, die es nicht erkannt hat. Der Agent prüft, liest die Lösungen, bearbeitet und prüft erneut, bis alles grün ist.
Datenschutz & Vertrauen
Diese CLI läuft auf Ihrem Rechner und steuert einen echten Browser gegen echte Seiten, daher ist es berechtigt zu fragen, was genau sie erfasst und wohin es geht. Was wir Ihnen sagen können, weil es das ist, was der Code in diesem Repo tatsächlich tut:
Der Collector ist eingebaut und lesbar. Er ist in diese Binärdatei kompiliert (
include_str!vonassets/collector.js), sodassuxlint --versionden genauen Erfassungscode festlegt und der Server zur Laufzeit nichts injizieren kann. Alles, was er erfasst, sind Seitengeometrie, sichtbarer Text, berechnete Stile und Screenshots. Für ein eingebettetes<iframe>zeichnet er nur den Host der src auf – niemals die vollständige Embed-URL, die Session-IDs und Tokens in ihrer Query-String tragen kann. Er liest niemals Ihren Quellcode oder Ihr Dateisystem überuxlint.tomlhinaus. Er liest jedoch ein wenig Projekt-Herkunft und sendet sie mit dem Bericht: Ihren aktuellen Git-Commit-SHA und Branch-Namen (git rev-parse), den Hostnamen des Rechners und in GitHub Actions den Repo/PR/Commit-Link. Setzen SieUXLINT_RUNNER, um den Hostnamen zu überschreiben.Die Schwärzung von Geheimnissen und personenbezogenen Daten ist Best-Effort, keine Garantie. Bevor etwas hochgeladen wird, maskiert der Collector Text, der wie ein Token, API-Schlüssel, Passwort oder eine E-Mail-Adresse aussieht, im erfassten Seitentext und schwärzt dieselben Muster aus Konsolenprotokollen und nativen Dialogmeldungen. Alle Kanäle teilen sich eine Musterliste (
assets/redact.js), sodass sie nicht auseinanderdriften können. Screenshots erhalten direkt vor der Erfassung einen zusätzlichen Durchgang: Jeder Formularfeldwert wird maskiert (Passwörter geleert, andere Eingaben durch Punkte ersetzt) und musterbasierte Geheimnisse im On-Page-Text werden entfernt, sodass eingegebene Daten und angezeigte Schlüssel nicht im Bild landen. Dieser Durchgang erreicht auch Shadow-DOM (einschließlich geschlossener Wurzeln über einenattachShadow-Interceptor) und Same-Origin-Iframes und deckt ein Cross-Origin-Iframe mit einer undurchsichtigen Box ab, da dessen Pixel nicht geschwärzt werden können. Aber die Schwärzung ist musterbasiert, und ein Screenshot ist immer noch Pixel: Beliebiger angezeigter Inhalt, den kein Muster erfasst (ein Kundenname auf der Seite, Bestelldaten), aufgeteilte Werte und alles, was in Bilder oder<canvas>gezeichnet wird, kann immer noch durchschlüpfen. Anmeldedaten, die Sie mit--header/--storage/--login-*übergeben, steuern nur Ihren Browser und werden niemals an den Server von uxlint gesendet.Da ein Bericht Seiten-HTML, Text und Screenshots erfasst, ist es unmöglich, vollständig zu verhindern, dass sensible Inhalte hinein gelangen. Verwenden Sie TEST-Konten, keine echten oder Produktionskonten. Für die lokale Entwicklung ist das Risiko gering, solange die Daten nur lokale Entwicklungsdaten sind. Wenn Sie eine authentifizierte Site prüfen, die echte Geheimnisse oder personenbezogene Daten enthält, überprüfen Sie, was gesendet wird, bevor Sie es senden: Verwenden Sie
--dry-run, um die genaue Nutzlast (Seitentext, Herkunft und Screenshots) in einen lokalen Ordner zu schreiben und sie ohne Hochladen zu inspizieren. Schwärzung reduziert versehentliche Offenlegung; sie ist keine Sicherheitsgrenze, und Sie bleiben verantwortlich für das, worauf Sie uxlint richten.Navigations-Text wird absichtlich nur auf Geheimnisse hin bereinigt. Steuerbeschriftungen, Menü- und
<select>-Optionen sowie Namen von Workspace/Org-Umschaltern durchlaufen dieselben Geheimnismuster, werden aber nicht auf Namen oder andere beliebige Inhalte geschwärzt. Der Grund ist der Goal Walk: Ein Audit steuert die Seite mit einem LLM, das genau diesen Text liest, um das richtige Steuerelement zu finden, es zu bedienen und seine Auswahl zurück auf das DOM abzubilden. Das Maskieren würde den Walk zunichtemachen, weil der Richter nicht mehr zwischen zwei Optionen unterscheiden oder die von ihm gewählte anklicken könnte. Die Beschriftungen, die ein Audit zur Navigation benötigt, bleiben also lesbar, und ein echter Name, der in einer von ihnen mitläuft, wird durch die Testkonten-Regel oben abgedeckt und nicht durch Schwärzung. Dies ist ein bewusster Kompromiss: Den Goal Walk funktionsfähig zu halten, ist mehr wert, als Text zu schwärzen, den die Testkonten-Regel bereits schützt.Keine Telemetrie. Diese Binärdatei tätigt ausgehende Aufrufe genau an die Hosts, die Sie ihr vorgeben: den uxlint-API-Server (
--server/UXLINT_SERVERoder die standardmäßig gehostete Origin), die Site, die Sie sie prüfen lassen, und nur, wenn Sie explizit zustimmen, anonyme Regel-Feedback-Signale. Es gibt kein separates Analytics-/Crash-Reporting-/Phone-Home-Ziel, das irgendwo eingebaut ist.Feedback ist opt-in, standardmäßig deaktiviert.
uxlint initfragt einmal; es schreibt nur dannfeedback = trueinuxlint.toml, wenn Sie zustimmen, und Sie können es jederzeit wieder umstellen.Der Audit-Browser verwendet ein ephemeres Profil. Jedes Audit startet Chrome mit einem frischen, wegwerfbaren Benutzerdatenverzeichnis, sodass keine Cookies, Verläufe oder Erweiterungen aus Ihrem alltäglichen Browsen jemals in die geprüfte Sitzung geladen werden und nach dem Beenden des Prozesses nichts erhalten bleibt.
Ihr Login bleibt lokal.
uxlint auth loginspeichert ein Token unter~/.config/uxlint/credentials, mit chmod0600. Es wird nie protokolliert, nie ausgegeben (außer in einem bewussten Fall:uxlint signupgibt einen frisch erstellten Schlüssel aus, damit Sie ihn exportieren können) und nie in einen Bericht eingebunden.
Dies ist kein Ersatz für das Lesen des Quellcodes. Er ist kurz, und genau darum geht es bei der Veröffentlichung. Wenn Sie etwas finden, das nicht dieser Beschreibung entspricht, eröffnen Sie bitte ein Issue.
Was diese CLI nicht ist
Sie ist bewusst dumm: navigieren, den eingebauten Collector ausführen, den Schnappschuss hochladen, den Bericht ausgeben. Die Regeln, Schwellenwerte und das Richtermodell sind nicht in diesem Repo und werden es nie sein. Sie sind das eigentliche Produkt und leben nur serverseitig. Ein Build dieser CLI ist ohne einen uxlint-Server, mit dem er sprechen kann, nutzlos (standardmäßig der gehostete unter https://uxlint.net oder Ihr eigener).
Lizenz
Apache-Lizenz 2.0 (siehe LICENSE). Lesen Sie sie, prüfen Sie sie, forken Sie sie, bauen Sie sie aus dem Quellcode, liefern Sie sie in Ihren eigenen Tools aus – keine Bedingungen über die üblichen Namensnennungs- und Patentbestimmungen hinaus.
Dies war früher die Business Source License, die an einem Änderungsdatum im Jahr 2030 in Apache-2.0 umgewandelt wurde; wir sind einfach früher angekommen. Die Einschränkung, die sie trug – kein konkurrierender gehosteter „Audit my site“-Dienst, der auf diesem Code basiert – schützte das Falsche: Was wertvoll ist, sind die Regeln, die kalibrierten Schwellenwerte und der Richter, und die sind serverseitig und nicht in diesem Repo. Was HIER ist, ist ein Client, der einen uxlint-Server benötigt, um überhaupt etwas wert zu sein, und ein Client ist genau das Stück, das reibungslos zu installieren, zu lesen und zu vertreiben sein sollte.
Releases bis einschließlich v0.1.30 wurden unter BUSL-1.1 veröffentlicht; ab v0.1.31 gelten Apache-2.0.
Available Tools
6 toolsacknowledge_findingA
Mark ONE finding as a known false positive for this site, so later audits stop counting it — it moves out of the findings, the counts and the grade into the report's acknowledged list, where it stays visible with your reason. Use it only after you've checked the finding is wrong on this page (the rule misread it), never to silence a real problem you'd rather not fix. Pass the report (URL or id), the rule and the selector exactly as the finding gives them, and a reason. undo=true puts it back. Works on reports filed under a site.
| Name | Required | Description | Default |
|---|---|---|---|
| rule | Yes | The finding's rule, exactly as the report names it. | |
| undo | No | true to withdraw an earlier acknowledgement, putting the finding back. | |
| reason | No | Why the finding is wrong HERE — shown beside it in every later report, so whoever reads the report can see why it isn't counted. Required to acknowledge (20+ characters); not needed to undo. | |
| report | Yes | The report the finding is in: its URL (…/r/<id>) or its id. | |
| selector | No | The finding's selector (`selector` in the structured result); `site` for a site-wide finding. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
No annotations are supplied, so the description carries the full disclosure burden, and it does so well: it explains the state transition (out of findings, counts and grade), persistence in the `acknowledged` list 'where it stays visible with your reason', and the reversal mechanism ('undo=true puts it back'). It also notes the site-scoping constraint ('Works on reports filed under a site'). It does not mention permissions/authorization or idempotency of repeat acknowledgements, keeping it below 5.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Front-loads the core action and effect in the first sentence, then adds usage guidance, parameter passing, and undo in a tight sequence. Every sentence is functional, though the em-dash-heavy compound sentences and the trailing site-scoping note reduce crispness slightly.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a mutation tool with no annotations and no output schema, the description covers purpose, effect, usage constraints, and reversal, which is close to what an agent needs. It omits the response shape and whether the report must be a site report in all cases beyond the terse 'Works on reports filed under a site' note.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100% and every parameter (report, rule, selector, reason, undo) is documented in the schema itself, so the baseline is 3. The description mostly restates that set ('Pass the report (URL or id), the rule and the selector exactly as the finding gives them, and a reason') with only slight added guidance about copying values verbatim from the finding.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
States a specific verb and resource ('Mark ONE finding as a known false positive for this site') and immediately describes the downstream effect on findings, counts, grade, and the acknowledged list. This is unmistakably distinct from audit_url, get_report, get_shot, and verify_fix without opening any schema.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
Gives an explicit precondition ('only after you've checked the finding is wrong on this page (the rule misread it)') and an explicit exclusion ('never to silence a real problem you'd rather not fix'), which is strong when/when-not guidance. It does not name an alternative tool (e.g. verify_fix) for the case where the problem is real, so it stops short of full 5-level routing.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
audit_urlA
Audit a website's UX/design: contrast, tap targets, type scale, colour discipline, copy clarity, scan patterns. Each finding returns its RULE name (pass it to verify_fix), a SOURCE file:line hint (for local audits, grepped from the project you're in), the SELECTOR, the concrete FIX, and — for copy issues — the exact text EDIT (replace X with Y).
WORKFLOW: (1) Before you change anything, call ux_guidance for the area(s) the findings touch (forms, lists, layout, copy, …) so you fix toward the idiomatic, DRY pattern — not a one-off patch. If the result names a STYLEGUIDE, open it first and build to the components/tokens it shows. (2) Open the source line and apply the SMALLEST fix that reuses the project's existing components/tokens and voice (don't add a new one-off to silence the finding) without regressing the quality floor — responsive, visible keyboard focus, reduced motion, no new layout shift — then verify_fix. (3) Iterate until green. A finding you've checked and found WRONG on this page (the rule misread it)? acknowledge_finding marks it a known false positive for the site, so it stops coming back and stops counting against the grade — it stays visible in the report, with your reason. If a lint_feedback tool is in your tool list, also send a verdict for each finding you act on — it's how rules get kept, tuned or retired. It is absent unless the project set feedback = true (via uxlint init), so don't go looking for it: this result tells you when it's there.
SAFETY: interaction probes navigate, read, and click candidate menu/disclosure/dialog controls. Discovery skips recognised action words — delete, remove, accept, leave, revoke, pay, publish, add, create, save — using the full label. Labels cannot guarantee a click has no side effects; use an environment you control with disposable data. the write probes (which click Add/Create, and Delete through its confirm dialog) need the CLI's own --allow-mutation flag, which is not reachable from here. Declared tests are the exception and the only one: if the project's uxlint.toml declares tests that sign in as a persona, running them will SUBMIT forms and may DELETE items — that's what a test does, and it exercises create/delete flows on your own app. Point it only at an app you own / a throwaway env, never a site you don't control.
SETUP: in a project with no uxlint.toml, this returns the exact config to write first (org/site/base/routes) — write that file, check it in, then call again. Without it a local target can't be audited at all and a public one files its report under a site nobody chose.
AUTH: for a logged-in site, DON'T pass secrets here — credentials come from the project's uxlint.toml [personas] (the local client replays them; nothing touches this tool call or the transcript). If the audit hits a login wall, this tool returns the exact setup instructions.
| Name | Required | Description | Default |
|---|---|---|---|
| base | No | Base URL to audit — an ORIGIN like http://localhost:5173, NOT a path (a path gets appended to every route and mis-crawls). Optional: omit to use the `base` in the project's uxlint.toml. | |
| crawl | No | Max routes to discover and audit from the seeds (default 12). Set 0 to audit only the given routes. | |
| judge | No | Run the AI copy/design judge (prose quality, test-run navigation). ON by default; set false for a fast, deterministic-only pass while iterating. | |
| tests | No | Run the site's declared tests (whole-site reachability). ON by default; auto-scoped to crawling audits. Set false to skip for speed. Tests are a paid-plan feature — on a free plan, tests declared but not run print a one-line skip warning instead. | |
| detail | No | `full` for every finding's fix, best practice, rect and screenshot URL in the structured result. Default is compact: every finding, with each rule's fix said once — the full form can run past a client's output limit on a big site. | |
| routes | No | Comma-separated routes (default /) | |
| states | No | Drive hover/focus/keyboard interaction states — catches dead hover styles, hover-only content unreachable by touch/keyboard, illogical focus order, keyboard traps, form-validation gaps. ON by default; set false to skip it (faster) on large public crawls. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With no annotations, the description carries the full burden and does so: it discloses that interaction probes navigate/read/click, that discovery skips action-word labels, that write probes need an unreachable --allow-mutation flag, that declared tests SUBMIT forms and may DELETE items, and that credentials come from uxlint.toml personas. Mutation and side-effect risks are stated plainly.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
It is long, but it is organized into labelled WORKFLOW/SAFETY/SETUP/AUTH blocks with the purpose and return shape front-loaded, and each block carries decision-relevant content rather than filler. A few sentences could be tightened, but nothing is redundant.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a 7-parameter, zero-annotation tool with mutation-capable probes, no output schema, and a setup prerequisite, the description covers return shape, workflow, safety, auth, and setup. Nothing an agent needs to invoke it correctly is missing.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema coverage is 100%, so the schema already documents base, crawl, judge, tests, detail, routes, and states with defaults and constraints. The description adds output-format detail (RULE, SOURCE file:line, SELECTOR, FIX, EDIT) but little beyond the schema on the parameters themselves, so baseline 3 applies.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
Opens with a specific verb+resource ('Audit a website's UX/design') and enumerates the concrete dimensions checked (contrast, tap targets, type scale, copy clarity). It also describes the shape of each finding and explicitly routes to siblings (verify_fix, ux_guidance, acknowledge_finding), so the agent can distinguish it from the rest of the toolset.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
Provides an explicit numbered WORKFLOW with when-to-do-what ordering (ux_guidance before changes, open source line, smallest fix, verify_fix, iterate), plus the acknowledge_finding escape hatch for false positives and the conditional lint_feedback path. Alternatives and their triggering conditions are named rather than implied.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
get_reportA
Read an EXISTING report's findings — one the user started from the dashboard, a run whose audit_url call you lost, or one that TIMED OUT (it keeps whatever it found before the cap, and says so). Pass the report's URL as the user sees it (…/r/) or its id. Returns the same thing audit_url does: the grade, what moved since the last run, and every finding with its rule, location, source hint, fix and screenshot_url — so you can act on it and confirm each fix with verify_fix. Reports are private; this reads them with your uxlint login.
| Name | Required | Description | Default |
|---|---|---|---|
| detail | No | `full` for every finding's fix, best practice, rect and screenshot URL in the structured result; compact by default (see audit_url). | |
| report | Yes | The report to read: its URL as the dashboard shows it (`https://uxlint.net/sites/8/r/abc123`), a `/r/…` path, or the bare report id. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
No annotations exist, so the description carries the full burden, and it delivers: it labels the operation as a read, discloses that timed-out reports preserve partial findings and say so, and notes reports are private and read with the user's uxlint login. It also commits to a stable output shape by enumerating the returned fields.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is front-loaded with the core purpose, and each sentence adds a distinct fact: use cases, input formats, return payload, and privacy/auth. It is longer than minimal but dense and without filler, though the parenthetical examples could be slightly tightened.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
With no output schema, the description compensates by enumerating the returned grade, deltas, and each finding's fields, and by explaining timeout behavior and auth requirements. It does not cover error cases or exact formatting, but the schema handles parameter formatting, making this complete enough for correct invocation.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
The input schema already documents both parameters with 100% coverage, so the baseline is 3. The description restates the report parameter's accepted URL/path/id forms but adds no new semantic detail beyond the schema; detail's full-vs-compact behavior is delegated to audit_url and already covered in the schema.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description opens with a specific verb-resource pair ('Read an EXISTING report's findings') and immediately distinguishes the tool from siblings by mentioning audit_url and verify_fix. It makes the scope explicit: existing reports, including timed-out ones, not new audits.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
It clearly identifies when to use get_report: reports started in the dashboard, lost audit_url calls, or timed-out runs. It does not explicitly say 'use audit_url for new audits', but 'EXISTING' and the audit_url reference make the boundary inferable, giving clear context without a formal when-not clause.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
get_shotA
View a report's annotated screenshot — the flagged element boxed on its page. Reports are PRIVATE, so a finding's screenshot_url can't be fetched with a plain GET; this tool fetches it with your uxlint login. Pass the finding's screenshot_url (from audit_url / verify_fix). Returns the image inline (if your client renders MCP images) and always writes it to a local file whose path you can open/Read.
| Name | Required | Description | Default |
|---|---|---|---|
| screenshot_url | Yes | The `screenshot_url` from an audit_url / verify_fix finding — the annotated shot with the flagged element boxed. A full URL or a `/r/…` path on your uxlint server. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
No annotations are provided, so the description carries full burden. It discloses that reports are PRIVATE, reads requires the user's uxlint login, returns image inline (if client supports MCP images), and always writes to a local file. This adds significant behavioral context beyond what an annotation might provide, such as side effects (writing a file) and authentication requirements. The only minor gap is not detailing the exact file path or cleanup behavior, but the description is quite transparent.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is concise (about 3 sentences) and front-loads the core action. Every sentence provides essential information: purpose, why it's needed, what to pass, and what happens. No fluff or redundancy. The structure is logical: what, why, how, outcome.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given that there is only one parameter, no output schema, and no annotations, the description is complete. It covers the tool's purpose, usage, parameter source, return behavior (inline and local file), and the limitation about private reports. This is sufficient for an agent to select and correctly invoke the tool.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100% and it already explains the screenshot_url parameter clearly. The description adds contextual meaning by tying the parameter to the finding's screenshot_url and specifying the source (audit_url/verify_fix). It also clarifies that the URL can be a full URL or a /r/… path. This adds value beyond the schema, so a slightly above baseline score is warranted.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states the tool's purpose: to view a report's annotated screenshot, with the flagged element boxed. It also distinguishes it from siblings by explaining why a plain GET won't work and that it requires the finding's screenshot_url. The verb 'View' and specific resource 'report's annotated screenshot' are precise.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description explicitly explains when to use this tool (to fetch a screenshot_url from audit_url/verify_fix findings) and why it's necessary (reports are private, plain GET won't work). It also provides context that the screenshot URL comes from specific sources, serving as an alternative to direct fetching. This is exactly the kind of usage guidance expected.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
ux_guidanceA
Project design memory and best-practice UI guidance to read BEFORE building or changing UI — usability, consistency, and performance patterns distilled from uxlint's audit corpus, so you build idiomatic, DRY, testable components the first time instead of getting audited after. Reads the nearest project’s uxlint.design.json on each call; only explicitly approved versioned decisions guide edits. Never auto-approve or rewrite that contract to silence a lint. Covers whole-row click targets, single-column labelled forms, tabs/radiogroup vs plain buttons, one shared width scale + aligned panels, pagination by scroll length, CLS-safe layout, copy that reads as UI (active voice, honest labels, useful empty/error states), and money surfaces (plans, usage, the cost of an action shown before it runs, failed payments). Each item names the uxlint rule that catches a miss, so the loop is: read the topic, build to it, then audit_url to confirm.
| Name | Required | Description | Default |
|---|---|---|---|
| topic | No | Which area to get guidance for: layout, forms, lists, navigation, components, performance, accessibility, content, money (plans, checkout, usage, cost before an action). Omit for the index of topics; "all" for everything. Accepts aliases (copy, nav, a11y, perf, dry, …) and falls back to the index for anything unrecognized. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With no annotations, the description carries the behavioral load and does so well: it re-reads the nearest project's uxlint.design.json on each call, only approved versioned decisions steer edits, and it never auto-approves or rewrites the contract. The implicit read-only nature is conveyed rather than stated outright, but the governance constraints are unusually explicit for a retrieval tool.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The governing instruction (read before building) is front-loaded in the first clause, and the closing loop sentence ties usage together. It is on the long side and the enumerated topic catalogue slightly pad it, but every sentence carries operational information.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
No output schema exists, so the description must characterize returns, and it does: guidance items each name the uxlint rule that catches a miss. Combined with the read-before-build workflow and the config source, an agent has enough to invoke and interpret it. Return format granularity (single topic vs index) is only implied by the topic parameter.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema coverage is 100% and the single topic parameter is fully documented in the schema, including the alias and fallback behavior, so the schema does the heavy lifting. The description's topic list largely restates the schema enum values and adds little parameter-level meaning beyond the schema itself. Baseline 3 is appropriate.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
States a specific verb+resource (read UI/design guidance before building or changing UI) sourced from uxlint's audit corpus and the project's uxlint.design.json. It also distinguishes itself from siblings by defining the loop that terminates in audit_url. An agent can tell exactly what this tool returns versus audit_url or get_report.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
Explicitly says to read BEFORE building or changing UI, names the alternative audit_url as the confirmation step after building, and states the exclusions: only explicitly approved versioned decisions guide edits, and never auto-approve or rewrite the contract. When-to-use, when-not, and the sibling handoff are all present.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
verify_fixA
After editing to fix a finding, re-check ONE rule on ONE page — the 'did my fix land?' loop, far quicker than a full re-audit (one route, no crawl, no judge). Returns whether the rule still fires, AND names any OTHER deterministic findings now on that page (the regression guard — so a fix that clears your rule but breaks something else here doesn't read as all-clear). Returns status passed, failed, not_evaluated or inconclusive. A pass requires explicit server evidence for the requested route and both viewports. Currently supported passing checks: page-title-missing, html-lang-missing, horizontal-overflow. Other rules can report observed failures but cannot pass without execution evidence; re-run audit_url for judge, interaction and site checks. Unknown rules and missing evidence never clear. A cleared finding is not a user endorsement of the fix.
| Name | Required | Description | Default |
|---|---|---|---|
| base | No | Base URL — an ORIGIN like http://localhost:5173, NOT a path. Optional: omit to use the `base` in the project's uxlint.toml. | |
| rule | Yes | The rule to verify is gone, e.g. contrast, tap-target, unlabelled-field | |
| route | No | The route to check, e.g. /pricing (default /) | |
| states | No | Drive interaction states (needed for state/form/interaction rules) |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
No annotations are provided, so the description carries the full burden of behavioral disclosure. It does a good job: discloses that the tool only reports observed failures for rules not in the supported passing list, that unknown rules and missing evidence never clear, and that a cleared finding is not a user endorsement of the fix. It also explains the regression guard behavior. It does not explicitly state whether the operation is read-only or has side effects, but given the described behavior (a check), this is implicit. One might argue for a 5, but the lack of explicit mention of side-effect-freeness or any destructive potential is a tiny gap; still, it's quite thorough.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is a solid paragraph, slightly long but information-dense. It front-loads the purpose, then adds critical caveats. It could be split into bullet points for readability, but every sentence earns its place — no filler. The length is justified given the complexity (supported rules, evidential requirements, regression guard, exclusions).
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a tool with no output schema and no annotations, the description does an excellent job of covering everything an agent needs: what it does, when to use it, what the return statuses mean, what constitutes a pass (explicit server evidence for the requested route and both viewports), which rules are supported for passing, what happens for other rules, and how to handle judge/interaction/site checks. It also mentions the regression guard, covering the risk of a fix breaking something else. Very complete.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, so the schema already documents all four parameters. The description adds context about the rule parameter (which rules are supported for passing) and hints at the interaction states for state/form/interaction rules, but does not add substantial new semantics beyond what's in the schema. The description does not mention default values or relationships that are not already present in the schema. Baseline 3 is appropriate.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description states the specific verb ('re-check'), resource ('ONE rule on ONE page'), and purpose ('did my fix land?'). It clearly distinguishes itself from a full re-audit by naming the alternative (audit_url) and explaining the difference (one route, no crawl, no judge). The description is not a tautology; it explains the tool's role in the fix-verify workflow.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description explicitly states when to use this tool (after editing to fix a finding, to verify a specific fix) and when not to use it (for judge, interaction and site checks — says to re-run audit_url for those). It also names the sibling tool audit_url as the alternative. It provides clear conditions: a pass requires explicit server evidence for the requested route and both viewports, and unsupported rules cannot pass. This is explicit and actionable.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
Tool Schema Changelog
Recent tool additions, removals, and schema changes observed during successful MCP inspections.
2 tool updates
v0.1.46- Added
acknowledge_finding - Changed
ux_guidance1 field changed- changed
Input schema / properties / topic / descriptionPrevious value: -"Which area to get guidance for: layout, forms, lists, navigation, components, performance,\naccessibility, content. Omit for the index of topics; \"all\" for everything. Accepts aliases\n(copy, nav, a11y, perf, dry, …) and falls back to the index for anything unrecognized."New value: +"Which area to get guidance for: layout, forms, lists, navigation, components, performance,\naccessibility, content, money (plans, checkout, usage, cost before an action). Omit for the\nindex of topics; \"all\" for everything. Accepts aliases\n(copy, nav, a11y, perf, dry, …) and falls back to the index for anything unrecognized."
2 tool updates
v0.1.41- Changed
audit_url1 field changed- added
Input schema / properties / detailAdded value: +{ + "default": null, + "description": "`full` for every finding's fix, best practice, rect and screenshot URL in the structured\nresult. Default is compact: every finding, with each rule's fix said once — the full form can\nrun past a client's output limit on a big site.", + "type": [ + "string", + "null" + ] +}
- Added
get_report
4 tool updates
- First observed
audit_url - First observed
get_shot - First observed
ux_guidance - First observed
verify_fix
TDQS
Scored across 6 tools
Each tool has a distinct role in the audit workflow: running audits, reading reports, viewing screenshots, verifying fixes, acknowledging findings, and getting design guidance. While audit_url and get_report both surface findings, one initiates a run and the other retrieves an existing one, and the descriptions make this boundary clear. No two tools appear interchangeable.
Most tools follow a verb_noun pattern (acknowledge_finding, get_report, get_shot, verify_fix), with audit_url fitting the same style. The sole deviation is ux_guidance, a noun phrase with a ux_ prefix, which breaks the pattern slightly but remains readable and unambiguous.
Six tools cleanly cover the core loop of guidance, audit, inspect, verify, and acknowledge. Nothing feels redundant or missing at this scale, and the set is well-scoped for a focused UX linting server.
The surface covers the main lifecycle: read guidance, run an audit, retrieve reports, view evidence, verify individual fixes, and acknowledge false positives. A list_reports tool for discovering existing report IDs without already having a URL is a minor missing convenience, but most workflows are fully supported.
Maintenance
Related MCP Connectors
Review frontend code and live pages against 386 quality-gated web development rules.
Find what to fix on a site, check if changes worked, see how AI reads it. Free audit, no account.
Scan a web page for accessibility, security, privacy, quality and SEO issues, with fixes.
AI website audit: security, SEO, performance, UX and accessibility checks with actionable fixes.
Related MCP Servers
- AlicenseAqualityDmaintenanceAudit any website for privacy, security, accessibility, and performance issues — with scores, grades, and actionable fix instructions. No account required.37 npmMIT
- AlicenseAqualityCmaintenancePoint your coding agent at a URL and get a real-browser QA audit: broken signup/login/checkout flows, JS console errors, missing analytics, consent + security headers, mobile tap targets, and accessibility — returned as machine-verified findings graded A-F.4422 PyPI2Apache 2.0
- AlicenseNot gradedqualityCmaintenanceDesign review for UI code, inside your coding agent. Reviews React, Vue, Svelte, CSS and SwiftUI against 313 rules and returns scored findings with file:line fixes your agent can apply and verify.MIT
- AlicenseNot gradedqualityBmaintenanceEnables AI coding agents to audit rendered web pages for design and UI defects by measuring geometry, styles, contrast and motion in a local browser and judging them against evidence-tiered rules. Findings come back as short, fixable items expressed in the project's own design tokens, while only sanitized numeric measurements leave the machine.Apache 2.0