[Indexed on TensorBlock MCP Index]
[Qa MCP score on AI Agents Listing]
[Glama MCP server: license A, quality A, maintenance A]
ego-webqa
[PyPI]
[CI]
[Python]
[License]
Deterministic coarse delivery QA for AI-generated web pages, H5 demos, and PWAs.
Point it at a URL. It opens the page in a real Chromium browser by default,
checks a zero-config narrow-mobile matrix, safely probes the primary call to
action, and leaves screenshots plus machine-readable evidence behind. Firefox
and Playwright WebKit can be selected one engine at a time. The default eight
variants combine:
- 360px and 390px widths;
- 1.0x and 1.5x text scaling;
- 0px and 34px simulated bottom safe area.
See the result in 30 seconds
Prefer to inspect a completed run first? Open the
live before-and-after evidence board.
setup first checks the selected browser. If it already launches, setup exits
without downloading anything; otherwise it installs the pinned Playwright
headless shell with the active ego-webqa Python interpreter and verifies a
real headless launch. The first Chromium setup avoids the full headed browser
build because audits only run headless. Ordinary doctor and audit commands
never download a browser implicitly. The
audit command exits 0 for pass/warnings, 1 for blocking delivery defects,
and 2 for an audit or browser failure. Each run leaves screenshots and
structured evidence:
A real dogfood finding looks like this:
The report explains what broke, where it happened, which viewport combinations
were affected, and gives the Agent a command that reproduces the failure.
What real pages exposed
The v0.8.2 dogfood pass audited all 20 Ego-owned production or canonical
generated pages with zero runtime errors. After separating network-sensitive
performance observations from deterministic delivery findings, ten pages were
clean and ten had actionable structural findings. Stable failures included six
text-enlargement layout breaks, four bottom safe-area penetrations, five
clipped-text root causes, four undersized-target groups, and one generated page
loading a missing service worker. There are no known stable blocking false
positives in this corpus. This is a small, disclosed corpus rather than a
market-wide accuracy claim; the full evidence, raw mixed-profile counts, and
limitations are in
docs/real-world-dogfood-2026-10-31-v0.8.2.md.
Layout failures now identify the deepest unclipped elements that own the
overflow, so an Agent receives a concrete repair selector instead of html.
See how one generated page went from three root causes to zero blocking defects
in the
vocabulary repair case study.
If you want to test the same loop on one of your pages, follow the
15-minute first-trial protocol.
The field feedback protocol defines how real cases
are classified and converted into clean controls or benchmark fixtures.
Why
Generated pages often pass unit tests while still shipping obvious delivery
defects: content wider than the phone, invisible buttons, broken images,
console errors, a call-to-action that does nothing, or a page that shifts while
the user is trying to tap it.
ego-webqa turns those into deterministic checks. It is not a visual-regression
service and does not require writing tests or storing approved screenshots.
Install
Install the published package from PyPI:
To install the current checkout before a release:
For development, use the committed lockfile:
Without uv, python -m pip install -e '.[dev]' remains supported.
If uv is available and you do not want a persistent Python package install,
use the same commands through an isolated, version-pinned uvx environment:
Playwright is pinned by the package, and browser binaries live in Playwright's
shared cache, so the temporary uvx environment and later MCP launches reuse
the same browser revision.
If doctor reports missing Linux system libraries, ask setup to install them:
Setup is intentionally a separate, explicit command: wheel installs remain
offline-safe, while browser downloads and operating system changes are visible,
retryable user actions. setup is idempotent and reuses a browser that already
passes a real launch check. Use setup --dry-run to inspect the exact
interpreter-bound command, or --force to reinstall a damaged browser revision.
For a lower-level repair or explicit installation command, use:
Chromium installation is headless-only by default. If another tool on the same
machine requires the full headed Chromium build, opt in explicitly:
Use a system Chrome instead of downloading Chromium:
Firefox and WebKit
Install only the additional engine you need, then select it for the whole audit:
Chromium remains the default. Each audit runs one engine; this does not silently
multiply browser cost or claim cross-engine parity. The webkit option uses
Playwright's WebKit build and supplies useful Safari-engine evidence, but it is
not a real iPhone, iPad, or macOS Safari run. Use real-device testing when the
delivery decision requires it.
Use
Exit codes:
0: pass or warnings only1: at least one blocking error2: invalid invocation or browser/runtime failure
--viewports accepts WIDTHxHEIGHT[:NAME][@TEXT_SCALE][~SAFE_BOTTOM_PX].
Explicit viewports replace the default matrix. Text scale must be between 1.0
and 2.0; the simulated bottom safe area must be between 0 and 100px.
--preset quick selects four pairwise-balanced mobile variants for fast Agent
loops: each width covers both text scales and both safe-area states, while the
crossed scale/safe-area combinations alternate by width. --preset full
explicitly selects the default eight-variant matrix. A preset cannot be combined
with --viewports.
Every run writes self-contained evidence. Screenshot references in JSON are
relative to the report directory, so agents and CI can move the complete
artifact directory without rewriting paths:
Add --fail-on-warn for CI gates that require a completely clean report.
agent_summary.json is the compact Agent-facing view. Repeated findings are
aggregated by registered dimension, so the same root cause across several
viewports produces one repair item with affected triggers and a reproducible
command. MCP callers receive the same summary as structured content and as the
short text result.
feedback_bundle.json is the external-feedback view. By default it includes
dimension ids, counts, sanitized viewport geometry, browser engine, and target
type, but omits the target URL, local paths, custom viewport names, selectors,
page text, messages, raw evidence, screenshots, and configuration contents.
Review it before sharing. To deliberately add context for a private issue:
The first command regenerates the default bundle beside the report. The second
is an explicit opt-in and may contain page-sensitive data.
Baseline and regression gate
Compare a run with a known-good report without maintaining screenshots. Stable
fingerprints combine the registered dimension with its selector or root cause:
The run writes delta.json with new, persistent, changed, and resolved
root causes. --gate new fails only when a blocking root cause is new, becomes
blocking, increases its blocking occurrences, or affects an additional viewport.
Existing unresolved blockers remain visible but do not make an unchanged build
fail again. Add --fail-on-warn to gate new or changed warnings as well.
Both reports must use the same target source, profile, viewport matrix, browser
engine, and browser channel. Intentional cross-target or cross-configuration
comparisons require --allow-target-change and/or
--allow-configuration-change. This is a deterministic finding delta, not a
visual-regression baseline.
Each repair item keeps the first evidence object for compatibility and an
evidence_by_viewport map for the complete cross-viewport evidence. Network
failures additionally carry failure_details with resource type, frame URL,
same-origin status, redirect source, HTTP status or browser error, and occurrence
count. Query strings and credentials are removed from all reported URLs.
Checks
Blocking errors:
- horizontal page overflow
- layout break when text is enlarged
- bottom controls penetrating the device safe area
- JavaScript page errors and
console.error
- failed resources and HTTP errors
- a nearly blank page
- unreadable text below 10px
- broken visible images
- distorted canvas/image/video aspect ratio
- dead primary CTA
- a configured smoke-flow target or post-action assertion fails
- severe unexpected layout shift
Warnings:
- DOM rendered, but the
load event exceeded its bounded deadline
- small hit targets below 44px
- secondary text below 12px
- oversized fixed overlays
- slow first contentful paint
- moderate layout shift
- excessive first-load bytes or request count
The browser probe reports facts. All thresholds and pass/fail decisions live in
src/ego_webqa/config.py.
The aspect-ratio check only evaluates rendered media at least
aspect_min_rendered_px (48px by default), avoiding pixel-rounding noise from
small icons.
Dimensions
Issue codes belong to a closed, versioned registry in
src/ego_webqa/dimensions.py. Reports reject an
unregistered code, and each Agent summary item carries the dimension id,
version, detector, and default severity. Docs and integrations can inspect the
same source of truth without parsing prose:
Profiles
baseline is the default delivery profile. It checks whether the page renders,
responds, fits the viewport, and lets the primary action work. It deliberately
keeps network-sensitive observations out of the delivery gate: first paint,
load-event deadline, network-idle timeout, and transfer/request budgets do not
produce findings in baseline.
performance keeps every baseline check and adds those four network-sensitive
observations. Use it when the audit runs from a controlled network or when the
caller explicitly wants an observational performance gate.
accessibility keeps every baseline check and adds deterministic checks for:
- missing document language or page title
- controls without an accessible name
- visible images without an
alt attribute
- interactive content inside
aria-hidden containers
- duplicate IDs and skipped heading levels
- positive
tabindex values that override the natural focus order
This profile catches common machine-detectable defects. It is not a WCAG
conformance audit or a replacement for keyboard and assistive-technology
testing.
full enables the baseline, performance, and accessibility families together.
Raw timing measurements remain in report.json for every profile; the selected
profile controls which registered dimensions can produce findings.
Configuration
Use "viewport_preset": "quick" for the four-variant first gate, or replace it
with an explicit "viewports" list for a project-specific matrix. The preset
and explicit list are mutually exclusive.
Use --smoke-selector "#checkout" when the primary action's text is not matched
by the default CTA vocabulary. Safe smoke aborts HTTP requests and switches the
isolated browser context offline after the initial load. Use --smoke-mode live
only when real side effects are intended, or --no-smoke when even a DOM-only
click is undesirable.
smoke_success_selector and smoke_success_url_pattern replace the generic
"something changed" heuristic with an explicit post-click contract. When both
are configured, both must change from unmatched to matched.
Set smoke_scope to all to exercise the CTA independently in every viewport.
Use smoke_require_assertion for delivery gates that must not accept a vague
DOM change as success.
Bounded smoke flows
For a short client-side path, smoke_flow can describe an ordered sequence of
deterministic actions. It accepts at most eight steps from a closed set:
click: click a selector;fill: fill a selector, with the value redacted from reports;press: press a key on a selector;expect_visible: require a selector to become visible;expect_url: require the current URL to match a regular expression;expect_text: require the visible element's rendered text, or a form
control's current value, to match a case-insensitive regular expression.
The flow must contain a click, fill, or press action, followed later by at
least one expect_visible, expect_url, or expect_text assertion. A flow
cannot be combined with the single-CTA selector/assertion fields. The default
safe mode blocks HTTP after the initial page load, so flows are limited to
deterministic client-side behavior unless smoke_mode is explicitly changed to
live. Arbitrary JavaScript and user-defined detectors are not accepted.
expect_text reads input, textarea, and select values through
Playwright; all other elements use rendered text from the visible element.
Hidden descendants are not treated as delivered content. Reports retain the
pattern, source type, and observed length, but never copy the observed text into
evidence. This keeps text assertions deterministic without exposing values
typed into a page.
When a flow fails, report.json includes each completed step, the failed step,
and its error. The Agent summary names the exact action instead of reporting a
generic dead button.
Projects can keep several closed flows in one config and select one by name:
Flow names are closed identifiers matching [A-Za-z0-9][A-Za-z0-9._-]{0,63};
at most 16 definitions are accepted. Every definition is validated, but only
the selected flow runs. smoke_flows and the single inline smoke_flow are
mutually exclusive, as are named flows and the single-step smoke_selector /
success assertions, because every named flow must carry its own interaction and
assertion. Override the configured default with --smoke-flow-name checkout;
reports retain the selected name and redact fill values as before.
Use ready_selector for SPA content that appears after the load event. Known
third-party console and request noise can be excluded with regex patterns
without hiding DOM-based findings. Ignored responses are excluded from both
request counts and transfer-byte budgets. Reports record whether ready content,
fonts, and bounded network idle were reached.
Authenticated previews
Previews behind HTTP Basic auth, request headers, or a signed-in browser session
are supported through JSON configuration or environment variables:
Credentials and header values are redacted from the JSON report. Passing them
through environment variables also keeps them out of the CLI process argument
list.
Platforms and multi-agent use
The audit engine runs on Linux, macOS, and Windows with Python 3.10 or newer.
CI exercises the same test suite on all three operating systems.
Every audit() or CLI invocation owns its browser lifecycle, browser contexts,
static local server, and output directory. There is no shared mutable audit
state, so multiple agents can run concurrently when each supplies a unique
--out directory:
--json prints the same stable payload written to report.json.
schema_version governs compatibility; JUnit and SARIF are derived from the
same in-memory issue list. Agents should treat exit code 0 as pass/warn, 1
as blocking findings, and 2 as an invocation or browser failure.
The eight public JSON payloads have packaged Draft 2020-12 schemas. Print one with
ego-webqa --print-schema report; see
docs/json-contracts.md for names and the
compatibility policy.
Within one audit, up to three viewports render in isolated browsers
concurrently. This bounds slow-site wall time without sharing cookies, network
state, screenshots, or mutable evidence between viewports.
MCP server
Expose the gate directly inside an AI coding agent:
ego-webqa-mcp remains available as a compatibility alias. An MCP client can
launch either command over stdio. The registry-compatible one-shot form is
uvx [email protected] mcp. The server advertises one tool, audit_web_page,
with structured success and blocking-error results:
Typical tool arguments are:
The config path is the MCP integration point for bounded smoke_flow
sequences, authenticated requests, ignore policies, and other settings that do
not need to be repeated in every tool call.
The MCP result is marked as an error when the report status is fail, while
the full report remains available as structured content. Authentication
environment variables are read by the server process, not passed as tool
arguments. This adapter deliberately remains a delivery-usability gate; it is
not a security scanner, WCAG certification tool, or visual-regression system.
Governed value overrides
Projects can temporarily adjust a registered dimension without disabling the
dimension or adding arbitrary assertions. Every override requires an owner,
reason, and expiry; it may also change the effective block/warn severity
and use only that dimension's declared, safely overridable thresholds:
The UTC audit date is the expiry clock. An override is active through its
expires date and automatically falls back to registry defaults the next day.
Unknown dimensions, unknown or unsafe parameters, duplicate dimension entries,
and conflicting values for a shared threshold are rejected.
report.json records the override in each affected issue and adds a
governance block containing active and expired declarations plus effective
parameters. agent_summary.json carries the same source metadata and reports
overridden_dimensions, downgraded_blocks, and expired_overrides. JUnit and
SARIF use the effective severity. An expired override remains visible for audit
but no longer changes detection or status. See
examples/webqa-governed.json.
DeepSeek Harness can install the same MCP tool through the separate declarative
dsh-ego-webqa bundle. It reuses DSH's native MCP client instead of adding a
second QA implementation; see
docs/dsh-integration.md for the boundary and
acceptance criteria.
GitHub Actions
This repository is also a composite GitHub Action. The Action installs the
package from the Action ref, installs the selected browser engine (Chromium by
default), runs the audit, uploads the report even when the audit fails, and
writes a concise privacy-safe root-cause table to the job summary:
For a local checkout of this repository, use uses: ./ after checkout. The
Action's safe smoke mode is the default; set smoke-mode: live only when the
click is intentionally allowed to cause real side effects. See
examples/github-action.yml and
action.yml for the full input set. The @v0.8.2 tag is created
only after the same commit passes the full cross-platform CI matrix.
Python API
Scope and independence
This is a deterministic coarse gate for obvious delivery failures. A bounded
smoke flow can prove that one configured short client-side path reaches its
declared visible state, text/value, or URL; it does not prove business
correctness, that every supported browser matches, or that the page is secure.
Fixed report scope:
本报告仅覆盖多终端几何与基础体验的确定性粗检；业务主路径、跨浏览器兼容、安全合规需另行验证。
This repository is a standalone extraction of the general-purpose delivery
checks originally proven inside the ego project. It has no dependency on
ego_protocol, ego_uri, ego sharing, deployment, miniapp, or product-shell
semantics. Product-specific checks belong in plugins, not in the core.
Benchmark and trust
The repository separates a controlled local regression benchmark from
real-world public-network observation:
benchmarks/ runs 128 independent synthetic cases across narrow, mobile,
tablet, and desktop variants. It is the serial Chromium latency baseline and
the correctness corpus for all 38 registered dimensions.dogfood/ runs a fixed real-page sample and reports url and local
outcomes separately. It is observational evidence, not a latency threshold,
because network and target-site behavior change outside the tool's control.
Ground truth is declared per benchmark scenario; the evaluator does not import
detector thresholds to decide whether a result is correct.
The evaluator reports exact dimension matches, case precision/recall/F1,
blocking false-positive and false-negative rates, dimension-level TP/FP/FN, and
complete audit latency. It writes machine-readable evidence plus a Markdown
summary. The 0.7.0 baseline is 128/128 exact with 0% blocking FP/FN, P50 357ms,
P95 1147ms, and max 3615ms in serial local Chromium:
docs/benchmark-2026-10-30-v0.7.0.md.
These results measure curated synthetic fixtures in Chromium, not real-site
coverage or cross-engine parity. Firefox and WebKit have a separate real-browser
CI fixture for a clean page and a deterministic overflow failure. The
benchmark's value is regression pressure: its first run exposed a real
accessibility profile crash on standard <label> markup and duplicate CTA
root-cause reporting; both were fixed before the baseline was recorded.
See docs/performance-baselines.md for the
measurement contract and the two evidence classes.
Development
The same scripts/dev.py entry point and lockfile are used by GitHub Actions
on Linux, macOS, and Windows, preventing local and CI dependency or command
drift. Coverage enforces a 90% line/branch floor. See
CONTRIBUTING.md before adding a rule. Every rule needs a
positive control and an observed failure mode.
License
MIT
