@just-every/design 0.1.32 → 0.1.34

package/README.md

@@ -1,6 +1,6 @@
 # @just-every/design
 
-MCP (Model Context Protocol) stdio server that proxies the **Design App API** (default: `https://design.justevery.com`) so MCP clients can create and inspect design runs.
+MCP (Model Context Protocol) stdio server that proxies the **Design App API** (default: `https://design.justevery.com`) so MCP clients can create, sync, and check design runs.
 
 ## Quick start
 
@@ -120,47 +120,12 @@ This avoids needing long-lived client secrets and is the lowest-friction path fo
 
 ## MCP tools
 
-Current tools are focused on runs + artifacts:
-
-- `design.create`
-- `design.list`
-- `design.get`
-- `design.watch`
-- `design.extractAssets` (opt-in: extract assets for interface runs)
-- `design.generateHtml` (opt-in: generate HTML/CSS + assets for interface runs)
-- `design.iterate` (iterate on a run using screenshot feedback)
-- `design.refineDraft` (non-fork: refine a specific draft within a run)
-- `design.uploadTarget` (upload an image and set it as the run target)
-- `design.setTarget` (select which draft should be treated as the run target)
-- `design.clearTarget` (clear explicit target selection)
-- `design.events`
-- `design.artifacts.list`
-- `design.artifacts.download` (downloads and caches locally)
-
-CLI helper commands (non-MCP):
-
-- `every-design create --json '{...}'`
-- `every-design watch --json '{...}'`
-- `every-design get --json '{...}'`
-- `every-design list --json '{...}'`
-- `every-design events --json '{...}'`
-- `every-design artifacts list --json '{...}'`
-- `every-design artifacts download --json '{...}'`
-- `every-design extract-assets --json '{...}'`
-- `every-design generate-html --json '{...}'`
-- `every-design refine-draft --json '{...}'`
-- `every-design upload-target --json '{...}'`
-- `every-design set-target --json '{...}'`
-- `every-design clear-target --json '{...}'`
-- `every-design screenshot <url>`
-- `every-design iterate --json '{"runId":"<run-id>","render":[...],"concerns":"..."}'`
-
-## Output kinds (CLI/MCP)
-
-When using this package via MCP/CLI:
-
-- HTML output is **opt-in**: use `output.designKind: "interface"` plus `progression.autoGenerateHtml: true` (or call `design.generateHtml`).
-- Asset extraction is **opt-in**: use `progression.autoExtractAssets: true` (or call `design.extractAssets`).
-- For web/app UI prompts with no explicit `output`, the CLI/MCP path defaults to `output.designKind: "interface"` to avoid expensive code builds while still producing a UI design.
-- For `interface` runs created via MCP/CLI, asset extraction and HTML generation are **deferred by default**. Use `design.extractAssets` / `design.generateHtml` (or the CLI helpers `extract-assets` / `generate-html`) when you explicitly want those outputs.
-- If you explicitly set `output.designKind` to `auto`, the backend will infer the best kind from the prompt.
+CLIs MUST follow this order when creating a user interface or visual element:
+`design.create` → `design.sync` → `design.check`.
+
+Available tools:
+
+- `design.create` — Create a new design. Returns run id.
+- `design.sync` — Wait for completion, extract assets, and sync to a folder (can take up to 30 mins).
+- `design.check` — Capture a screenshot and return guidance; accepts URL or local HTML file path.
+- `design.instructions` — Return the required workflow instructions for CLIs.