Design documents ability reference
Reference for the GoBuildWP Free 1.18.6 source. Installed schemas and policy remain authoritative.
This Design documents ability reference lists every call GoBuildWP Free registers for design documents, page captures and composition checks, with the exact slug an agent sends and what the plugin's own contract says it does. Of the 26, 19 read, 6 write and 1 is marked destructive in the source.
Read-only, write and destructive groups describe the source annotations. They do not establish a minimum safety profile, human approval or undo support. Those controls are separate: check the installed ability, the connected user and the active site policy before calling it. A read can still return sensitive data. These pages are not evidence that every operation passed an end-to-end runtime test.
What Design documents needs before these load
Design documents ships inside GoBuildWP Free 1.18.6, so none of its 26 calls waits on a licence. Whether a connected agent sees a given call still depends on the site's safety profile and the capabilities of the user behind the credential.
Design documents reads
| Ability | What it does |
|---|---|
wppilot/get-page-view-linkGet Page View Link | Returns a URL to open in your own browser tool so you can SEE a page you built, plus the viewport widths worth checking. For an unpublished page it returns the preview URL and requires_sign_in=true: a browser that is not already signed in to this site needs to sign in to this site. Normal WordPress sign-in works; wppilot/create-admin-access-link is another option when permitted, and is a critical ability that needs confirmation and that the active safety profile may refuse. Use this after building or editing a page and before reporting it finished - wppilot/verify-rendered-page reads the markup, and this is how you look at the result. If you have no browser tool, wppilot/capture-page asks the site to take the screenshot instead. |
wppilot/get-capture-jobGet a Capture Job | Reports whether a queued capture has been taken yet, which viewports are done, and anything the capture could not include. Poll this after wppilot/capture-page. |
wppilot/list-capturesList Page Captures | Lists the screenshots recorded for a page, newest first, with the viewport each was taken at and what it was labelled. Use it to find the before capture to compare a change against. |
wppilot/compare-capturesCompare Two Page Captures | Compares two screenshots of a page and reports how much changed and where. Returns a score from 0 (identical) to 1, the regions that differ in the coordinates of the newer image, and whether the page got taller. Use it after a change to see whether anything moved that you did not mean to move - the regions are what to go and look at. Compare captures taken at the same viewport width; different widths report the whole page as changed. |
wppilot/check-designCheck Design (Pre-flight) | Pre-flight a candidate page (its HTML/CSS or visible text) against the active design's tokens and Don't rules plus universal anti-slop checks (em-dash, AI-purple, Inter, filler copy, off-palette fonts/colors). Call before finalizing any visual output and fix every "fail" before shipping. |
wppilot/get-active-designGet Active Design | Return the active site design system as raw DESIGN.md plus structured tokens, dials, guidance, provenance, and readiness. Read this before visual work and build within the returned contract. |
wppilot/get-designGet Design | Return a specific design system by slug as raw DESIGN.md plus its structured contract and readiness. Use to read, repair, or evolve a saved direction. |
wppilot/list-design-libraryList Design Library | List saved design systems, readiness, sync readiness, and which is active. |
wppilot/adopt-design-from-siteAdopt Design From Site | Reads the design this site already has — the theme.json global styles a block theme defines, the customizer's standard colours, and whatever a builder module can contribute — and returns a DESIGN.md draft built from it. Use this before inventing anything on a site that is not brand new: the brand already exists in the theme and the existing pages, and a fresh direction invented alongside it produces work that clashes with every page already there. Nothing is saved; review the draft, add the reasoning it cannot know, then save it with wppilot/save-design. |
wppilot/check-compositionCheck Composition | Validate a composition — a block subtree, in spec vocabulary, describing what something is made of — and return it normalized with its structural signature. Use it to write down a shape worth keeping: a pricing tier you measured on a reference, a hero that worked, the way a section on this site is already built. Call wppilot/get-design-spec with no slug first for the vocabulary. This is deliberately not a library of shapes: a file per industry saying what a dentist's homepage contains works the day it is written, is stale a month later, covers only the trades somebody listed, and gives every dentist the same page. Prescribing at section level rather than pixel level does not stop that being a template. So nothing is shipped, and what you measure is checked against the same normalizer a spec uses — passing confirms the normalized shape, which can be graded against afterwards. It does not prove that every required widget, resource or installed builder feature is available, or that the rendered result matches. Composed items are the point: a tier is a ribbon, a name, a price row on one baseline, a feature list and a button, and writing that as a title and a paragraph is how every card ends up looking like every other one. |
wppilot/check-contrastCheck Design Contrast | Computes WCAG 2.x contrast ratios for every colour pair in a design's palette, and reports which surfaces can carry body text at AA. Call this when establishing or editing a design, and before choosing a text colour for a section: it answers "what can I put on this background" with the design's own colours instead of defaulting to black or white. Pass background to get the palette's strongest foreground for one colour. Pass foreground and background together to check a single pair, including colours not in the palette. This reports; it does not refuse anything — whether a pair is a problem depends on how the design uses it. |
wppilot/compare-referencesCompare References | Turn measurements of several reference pages into a report of what is convention and what is cliche. Supply what you observed on each reference, one object per site, using the dimension names this returns when called with no observations. A fixed per-industry checklist of what a homepage contains goes stale and gives every site in that industry the same page; this answers the question from the references you measured instead. A property present on every reference is a convention, and what to do about it depends on which kind: a booking button above the fold on eight of eight references is probably functional and worth keeping, while three equal cards on eight of eight is decoration that makes the sites look alike. The report keeps those apart, because a single frequency table cannot tell you which way to move. Honour the functional agreements, diverge from the decorative ones, and say in the design which you broke and why. |
wppilot/compare-to-specCompare To Spec | Grade a built page against the spec it was meant to match, and return a score with the properties that differ. Supply what the page actually renders as: the surface of each section in order, the container width, the section padding, and the size and weight of each type role. Read those from a real browser, because a rendered page is a resolved cascade and no amount of reading the source will tell you what it came out as. The comparison itself is deliberately not yours to make: asked to grade its own work an agent grades it generously, and a build that lands at a fifth of the target looks finished from the inside. Surfaces are weighted hardest because their sequence is what a person recognises first, and weight is graded without tolerance because it is the property that decides whether a page reads as the same design at all. |
wppilot/generate-designGenerate Design | Resolve a brief into a complete design, derived from this site rather than chosen. Asked to pick, a language model tends toward the most familiar answer (Inter, three equal cards), so this does not ask the model to choose. A mood names a hue window, and the hue, the ground, the type pairing, the scale ratio, the corner family, the spacing and the permitted compositions are all derived from the site address and the design name. Two sites with the same brief get different designs; one site re-run gets the same design, because nothing here is random. Colour is solved rather than sampled: ink is pushed until it clears 12:1 on the ground and the accent until it carries ink at 7:1, and a brief that cannot be solved is refused rather than shipped unreadable. Anything the brief states outright is used verbatim, because deriving is for the decisions nobody has made. Returns the tokens and a ready DESIGN.md to review and save. |
wppilot/get-design-specGet Design Spec | Read a design's reproduction spec, the roles it compiles to, and the vocabulary a spec may use. Call it with no slug to get the layout names and type roles before writing one. |
wppilot/list-design-examplesList Design Examples | Worked example design directions to read and learn from before writing one. Call with no arguments for short cards describing each; call with a slug for the full DESIGN.md, its contrast analysis and its readiness check. These are references, not presets: there is no ability that applies one, and copying a palette onto a site it was not chosen for produces exactly the generic result the design gate exists to catch. Read the closest one to see how a direction is argued and structured, then write one for this site — the site's own existing design is usually the better starting point, via wppilot/adopt-design-from-site. |
wppilot/list-layout-grammarsList Layout Grammars | The compositions a section can be built from, and which one this design should use where. Generated pages share one shape — a vertical stack of full-width bands, each a centred heading over equal columns — not because the shape was chosen but because a stack of flex containers is the only thing most tooling can express. These are the alternatives: an asymmetric split, a panel overlapping the section boundary, content bleeding past one edge, absolutely-placed layers, a sticky index beside a scrolling detail. Each carries its own responsive behaviour, so a composition that works at 1440px is already defined at 390px. Call with a section index to be told which grammar to use there, chosen from the active design's variance dial and a per-site seed so the answer is repeatable rather than random. |
wppilot/list-typefacesList Typefaces | A considered set of typefaces to choose a pairing from, and the rule for whether two of them go together. Asked for a font, the habit is Inter, Poppins, Montserrat or Playfair Display, which is why generated pages sound alike even when their palettes differ. Every face here says what it sounds like and what it can carry, so a pairing can be chosen rather than defaulted to. Pass two families to have the pairing checked before committing to it: the check refuses two faces from the same class, which read as one face gone wrong rather than as a decision, and refuses a display face set as body text. Pass one family and a role to be given the faces that pair with it. |
wppilot/verify-rendered-pageVerify Rendered Page | Fetches a page as a visitor gets it and reports what is actually there: the heading outline, images with no alt text or no source, containers that rendered empty, PHP errors or unrendered shortcodes reaching the visitor, the colours and fonts the served HTML carries, and the document weight. The empty-container and skipped-level checks read only the page's own content (summary.scope says how it was found), outline entries carry source: content|theme, and every finding carries source so theme, sidebar and footer output is not mistaken for the page. Call this after building or editing a page — saved-tree checks read what you wrote, while this reads what the site served, which is a different thing once a theme, a plugin and a cache have had their turn. Pass post_id for a page on this site or url for any address the site can reach. An unpublished page works too: its preview is fetched with your own session, so a draft can be checked before anyone sees it. No JavaScript is executed, so anything a script paints is not seen; not_checked lists that and the other limits with every result. |
Design documents writes
| Ability | What it does |
|---|---|
wppilot/capture-pageCapture a Page | Asks the site to screenshot a page at one or more viewport widths and store each one as a capture you can compare later with wppilot/compare-captures. The screenshot is taken by a logged-in wp-admin tab - the Visual Runtime page - so it only proceeds while somebody has that tab open; the result says whether one is online and gives the URL to open if not. If your client has a browser tool, prefer wppilot/get-page-view-link: it returns a URL immediately for your browser; unpublished pages still require an authorized signed-in session. The capture is a re-render rather than a browser screenshot, so a script that paints after load, a cross-origin image and an external webfont are not captured; each capture records which of those it hit. |
wppilot/register-captureRegister a Page Capture | Records an image already in the media library as a screenshot of a page, so later calls can compare against it. Upload the screenshot first - wppilot/create-upload-link gives a browser somewhere to PUT it, or wppilot/import-media-url pulls one from a URL - then call this with the attachment ID, the post it shows and the viewport width it was taken at. Take a capture BEFORE a risky change and another after, then call wppilot/compare-captures: that is how a visual regression gets caught rather than reported by a visitor. |
wppilot/attach-captures-to-changeAttach Captures to a Change | Records a before and an after capture against an entry in the change ledger, with the difference score between them. That turns a visual change from something somebody has to remember into something the ledger carries: wppilot/get-change then shows what the write did to the page, not only what it did to the data. Capture before the write, capture after it, then call this with the change ID from the write and the two attachment IDs. |
wppilot/activate-designActivate Design | Make a ready design system (by slug) active for this site. Incomplete saved drafts are rejected until their required colors and typography are repaired. |
wppilot/save-designSave Design | Create or update a design system from raw DESIGN.md and return its structured contract. Incomplete new documents are saved as drafts but not activated; an incomplete write never overwrites the active design. |
wppilot/save-design-specSave Design Spec | Attach reproduction measurements to a saved design, so a page can be built to match a reference instead of merely built in its spirit. A design document is a direction: it names a palette and two faces, deliberately leaves layout open, and cannot answer "does this match the screenshot". A spec is the numbers, in order: the surface each section sits on, the container width, the section padding, and the type scale with weight and tracking rather than size alone. Supply them from whatever you were given, a URL you measured, a screenshot, a Figma file, or your own reading of a written brief, and say which in "source". Nothing is inferred here and nothing is repaired: a missing value is refused rather than guessed, because a guessed number is then compiled into classes and graded against as though somebody had chosen it. Compile it with wppilot/elementor-compile-spec and grade the result with wppilot/compare-to-spec. |
Destructive Design documents calls
| Ability | What it does |
|---|---|
wppilot/delete-designDelete Design | Delete a saved design system by slug. If the deleted design was active, the site is left with no active design. |