webstudio 0.281.0 → 0.282.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/lib/cli.js +809 -336
- package/package.json +18 -16
- package/templates/cloudflare/package.json +1 -1
- package/templates/defaults/app/root.tsx +2 -1
- package/templates/defaults/package.json +8 -8
- package/templates/react-router/app/root.tsx +2 -1
- package/templates/react-router/package.json +8 -8
- package/templates/react-router/vite.config.ts +3 -0
- package/templates/react-router-cloudflare/package.json +1 -1
- package/templates/ssg/package.json +6 -6
- package/templates/ssg/renderer/+onRenderHtml.tsx +2 -0
package/lib/cli.js
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import process$1, { exit as exit$1, cwd, stdin, stdout, chdir, stderr, argv } from "node:process";
|
|
2
2
|
import { hideBin } from "yargs/helpers";
|
|
3
|
-
import path, { join, dirname, resolve, sep, normalize as normalize$2, basename, relative, delimiter, parse as parse$
|
|
3
|
+
import path, { join, dirname, resolve, sep, normalize as normalize$2, basename, relative, isAbsolute, delimiter, parse as parse$V, extname } from "node:path";
|
|
4
4
|
import hash from "@emotion/hash";
|
|
5
5
|
import deepEqual$1 from "fast-deep-equal";
|
|
6
6
|
import { z as z$2 } from "zod";
|
|
@@ -8,7 +8,7 @@ import { nanoid } from "nanoid";
|
|
|
8
8
|
import { enableMapSet, enablePatches, applyPatches, produceWithPatches, current, isDraft } from "immer";
|
|
9
9
|
import warnOnce from "warn-once";
|
|
10
10
|
import { simple } from "acorn-walk";
|
|
11
|
-
import { parseFragment, serialize as serialize$1, defaultTreeAdapter, html as html$1, Tokenizer } from "parse5";
|
|
11
|
+
import { parseFragment, serialize as serialize$1, defaultTreeAdapter, html as html$1, Tokenizer, parse as parse$U } from "parse5";
|
|
12
12
|
import { kebabCase, camelCase } from "change-case";
|
|
13
13
|
import { decodeNamedCharacterReference } from "decode-named-character-reference";
|
|
14
14
|
import { randomUUID, createHash } from "node:crypto";
|
|
@@ -500,6 +500,11 @@ const FONT_FORMATS = /* @__PURE__ */ new Map([
|
|
|
500
500
|
Array.from(FONT_FORMATS.keys()).map((format) => `.${format}`).join(", ");
|
|
501
501
|
const FONT_STYLES = ["normal", "italic", "oblique"];
|
|
502
502
|
const sanitizeCssUrl$1 = (str) => JSON.stringify(str);
|
|
503
|
+
const fontFormatOrder = Array.from(FONT_FORMATS.values());
|
|
504
|
+
const getFontFormat = (asset2) => {
|
|
505
|
+
const extension = asset2.name.slice(asset2.name.lastIndexOf(".") + 1);
|
|
506
|
+
return FONT_FORMATS.has(extension) ? FONT_FORMATS.get(extension) ?? asset2.format : FONT_FORMATS.get(asset2.format) ?? asset2.format;
|
|
507
|
+
};
|
|
503
508
|
const formatFace = (asset2, format, url2) => {
|
|
504
509
|
if ("variationAxes" in asset2.meta) {
|
|
505
510
|
const { wght, wdth } = asset2.meta?.variationAxes ?? {};
|
|
@@ -529,22 +534,34 @@ const getKey = (asset2) => {
|
|
|
529
534
|
const getFontFaces = (assets, options) => {
|
|
530
535
|
const { assetBaseUrl } = options;
|
|
531
536
|
const faces = /* @__PURE__ */ new Map();
|
|
537
|
+
const seenUrls = /* @__PURE__ */ new Set();
|
|
532
538
|
for (const asset2 of assets) {
|
|
533
539
|
const url2 = `${assetBaseUrl}${asset2.name}`;
|
|
534
540
|
const assetKey = getKey(asset2);
|
|
535
|
-
|
|
536
|
-
const format = FONT_FORMATS.get(asset2.format);
|
|
537
|
-
if (format === void 0) {
|
|
541
|
+
if (seenUrls.has(url2)) {
|
|
538
542
|
continue;
|
|
539
543
|
}
|
|
540
|
-
|
|
541
|
-
|
|
542
|
-
|
|
543
|
-
|
|
544
|
+
seenUrls.add(url2);
|
|
545
|
+
const format = getFontFormat(asset2);
|
|
546
|
+
const sources = faces.get(assetKey) ?? /* @__PURE__ */ new Map();
|
|
547
|
+
const existing = sources.get(format);
|
|
548
|
+
if (existing === void 0 || url2 < existing.url) {
|
|
549
|
+
sources.set(format, { asset: asset2, format, url: url2 });
|
|
544
550
|
}
|
|
545
|
-
|
|
551
|
+
faces.set(assetKey, sources);
|
|
546
552
|
}
|
|
547
|
-
return Array.from(faces.values())
|
|
553
|
+
return Array.from(faces.values(), (sources) => {
|
|
554
|
+
const [{ asset: asset2, format, url: url2 }, ...fallbacks] = Array.from(
|
|
555
|
+
sources.values()
|
|
556
|
+
).sort(
|
|
557
|
+
(left, right) => fontFormatOrder.indexOf(left.format) - fontFormatOrder.indexOf(right.format)
|
|
558
|
+
);
|
|
559
|
+
const face = formatFace(asset2, format, url2);
|
|
560
|
+
face.src += fallbacks.map(
|
|
561
|
+
({ format: fallbackFormat, url: fallbackUrl }) => `, url(${sanitizeCssUrl$1(fallbackUrl)}) format("${fallbackFormat}")`
|
|
562
|
+
).join("");
|
|
563
|
+
return face;
|
|
564
|
+
});
|
|
548
565
|
};
|
|
549
566
|
const fontFormat = z$2.union([
|
|
550
567
|
z$2.literal("ttf"),
|
|
@@ -666,6 +683,19 @@ const fileAsset = z$2.object({
|
|
|
666
683
|
type: z$2.literal(assetType.enum.file)
|
|
667
684
|
});
|
|
668
685
|
const asset$1 = z$2.union([fontAsset, imageAsset, fileAsset]);
|
|
686
|
+
const assetMetaSchemas = {
|
|
687
|
+
font: fontMeta,
|
|
688
|
+
image: imageMeta,
|
|
689
|
+
file: z$2.object({})
|
|
690
|
+
};
|
|
691
|
+
const mergeAssetMeta = (type2, current4, override) => {
|
|
692
|
+
const merged = { ...current4, ...override };
|
|
693
|
+
const result = assetMetaSchemas[type2].safeParse(merged);
|
|
694
|
+
if (result.success === false || Object.keys(result.data).length !== Object.keys(merged).length) {
|
|
695
|
+
return;
|
|
696
|
+
}
|
|
697
|
+
return result.data;
|
|
698
|
+
};
|
|
669
699
|
z$2.map(assetId, asset$1);
|
|
670
700
|
const basicLoginErrors = (login) => {
|
|
671
701
|
const issues = [];
|
|
@@ -7761,7 +7791,7 @@ const assetFileTypes = {
|
|
|
7761
7791
|
webm: binaryFile("video/webm"),
|
|
7762
7792
|
// Images
|
|
7763
7793
|
// Note: Cloudflare Image Resizing supports: jpg, jpeg, png, gif, webp, svg, avif
|
|
7764
|
-
// Other formats (bmp, ico
|
|
7794
|
+
// Other formats (bmp, ico) are served as-is without optimization
|
|
7765
7795
|
jpg: binaryFile("image/jpeg"),
|
|
7766
7796
|
jpeg: binaryFile("image/jpeg"),
|
|
7767
7797
|
png: binaryFile("image/png"),
|
|
@@ -7771,8 +7801,6 @@ const assetFileTypes = {
|
|
|
7771
7801
|
avif: binaryFile("image/avif"),
|
|
7772
7802
|
ico: binaryFile("image/vnd.microsoft.icon"),
|
|
7773
7803
|
bmp: binaryFile("image/bmp"),
|
|
7774
|
-
tif: binaryFile("image/tiff"),
|
|
7775
|
-
tiff: binaryFile("image/tiff"),
|
|
7776
7804
|
// Fonts
|
|
7777
7805
|
woff: binaryFile("font/woff"),
|
|
7778
7806
|
woff2: binaryFile("font/woff2"),
|
|
@@ -82115,6 +82143,13 @@ const runtimeOperationContractData = [
|
|
|
82115
82143
|
type: "null"
|
|
82116
82144
|
}
|
|
82117
82145
|
]
|
|
82146
|
+
},
|
|
82147
|
+
meta: {
|
|
82148
|
+
type: "object",
|
|
82149
|
+
propertyNames: {
|
|
82150
|
+
type: "string"
|
|
82151
|
+
},
|
|
82152
|
+
additionalProperties: {}
|
|
82118
82153
|
}
|
|
82119
82154
|
},
|
|
82120
82155
|
required: []
|
|
@@ -84023,7 +84058,8 @@ const assetUpdateInput = z$2.object({
|
|
|
84023
84058
|
"Editable display filename. This does not change the immutable uploaded asset name; list-assets returns both name and filename."
|
|
84024
84059
|
).optional(),
|
|
84025
84060
|
description: z$2.union([z$2.string(), z$2.null()]).optional(),
|
|
84026
|
-
folderId: z$2.union([z$2.string().min(1), z$2.null()]).optional()
|
|
84061
|
+
folderId: z$2.union([z$2.string().min(1), z$2.null()]).optional(),
|
|
84062
|
+
meta: z$2.record(z$2.string(), z$2.unknown()).optional()
|
|
84027
84063
|
}).refine(
|
|
84028
84064
|
(values) => Object.keys(values).length > 0,
|
|
84029
84065
|
getZodValidationIssueOptions({
|
|
@@ -84420,6 +84456,22 @@ const updateAsset$1 = (state, input2) => {
|
|
|
84420
84456
|
return throwBuilderRuntimeError("NOT_FOUND", "Asset not found");
|
|
84421
84457
|
}
|
|
84422
84458
|
const patches = [];
|
|
84459
|
+
if (input2.values.meta !== void 0) {
|
|
84460
|
+
const meta2 = mergeAssetMeta(asset2.type, asset2.meta, input2.values.meta);
|
|
84461
|
+
if (meta2 === void 0) {
|
|
84462
|
+
return throwBuilderRuntimeError(
|
|
84463
|
+
"BAD_REQUEST",
|
|
84464
|
+
`Invalid metadata for ${asset2.type} asset`
|
|
84465
|
+
);
|
|
84466
|
+
}
|
|
84467
|
+
if (deepEqual$1(asset2.meta, meta2) === false) {
|
|
84468
|
+
patches.push({
|
|
84469
|
+
op: "replace",
|
|
84470
|
+
path: [asset2.id, "meta"],
|
|
84471
|
+
value: meta2
|
|
84472
|
+
});
|
|
84473
|
+
}
|
|
84474
|
+
}
|
|
84423
84475
|
if (input2.values.filename !== void 0) {
|
|
84424
84476
|
if (isValidFilename(input2.values.filename) === false) {
|
|
84425
84477
|
return throwBuilderRuntimeError("BAD_REQUEST", "Invalid filename");
|
|
@@ -197728,21 +197780,49 @@ const createStyleDecl = ({
|
|
|
197728
197780
|
value: value2,
|
|
197729
197781
|
listed
|
|
197730
197782
|
});
|
|
197731
|
-
const
|
|
197783
|
+
const createStyleDeclsFromInput = ({
|
|
197732
197784
|
styleSourceId: styleSourceId2,
|
|
197733
197785
|
property: property2,
|
|
197734
197786
|
value: value2,
|
|
197735
197787
|
breakpoint: breakpoint2 = DEFAULT_BREAKPOINT_ID,
|
|
197736
197788
|
state,
|
|
197737
197789
|
listed
|
|
197738
|
-
}) =>
|
|
197739
|
-
|
|
197740
|
-
|
|
197741
|
-
|
|
197742
|
-
|
|
197743
|
-
|
|
197744
|
-
|
|
197745
|
-
|
|
197790
|
+
}) => {
|
|
197791
|
+
const createStyleDeclWithInput = (property22, value22) => createStyleDecl({
|
|
197792
|
+
styleSourceId: styleSourceId2,
|
|
197793
|
+
breakpointId: breakpoint2,
|
|
197794
|
+
property: property22,
|
|
197795
|
+
value: value22,
|
|
197796
|
+
state,
|
|
197797
|
+
listed
|
|
197798
|
+
});
|
|
197799
|
+
const normalizedProperty = normalizeStyleProperty(property2);
|
|
197800
|
+
const cssProperty = hyphenateProperty(String(normalizedProperty));
|
|
197801
|
+
if (shorthandProperties.includes(
|
|
197802
|
+
cssProperty
|
|
197803
|
+
) === false) {
|
|
197804
|
+
return [createStyleDeclWithInput(property2, value2)];
|
|
197805
|
+
}
|
|
197806
|
+
const parsedValue = styleValue$1.safeParse(value2);
|
|
197807
|
+
if (parsedValue.success === false) {
|
|
197808
|
+
return [createStyleDeclWithInput(property2, value2)];
|
|
197809
|
+
}
|
|
197810
|
+
const parsed = parseCss(
|
|
197811
|
+
`.styles{${cssProperty}:${toValue(parsedValue.data)}}`,
|
|
197812
|
+
/* @__PURE__ */ new Map()
|
|
197813
|
+
);
|
|
197814
|
+
if (parsed.errors.length > 0 || parsed.styles.length === 0 || parsed.styles.some(
|
|
197815
|
+
({ value: parsedStyleValue }) => ["invalid", "guaranteedInvalid"].includes(parsedStyleValue.type)
|
|
197816
|
+
)) {
|
|
197817
|
+
return throwBuilderRuntimeError(
|
|
197818
|
+
"BAD_REQUEST",
|
|
197819
|
+
`Invalid value for shorthand CSS property "${cssProperty}"`
|
|
197820
|
+
);
|
|
197821
|
+
}
|
|
197822
|
+
return parsed.styles.map(
|
|
197823
|
+
(style) => createStyleDeclWithInput(style.property, style.value)
|
|
197824
|
+
);
|
|
197825
|
+
};
|
|
197746
197826
|
const getStyleDeclKeyFromInput = ({
|
|
197747
197827
|
styleSourceId: styleSourceId2,
|
|
197748
197828
|
property: property2,
|
|
@@ -198141,18 +198221,19 @@ const createDesignTokenCreatePayload = ({
|
|
|
198141
198221
|
value: styleSource2
|
|
198142
198222
|
});
|
|
198143
198223
|
for (const declaration2 of createDesignTokenStyleInputs(token2)) {
|
|
198144
|
-
const style
|
|
198224
|
+
for (const style of createStyleDeclsFromInput({
|
|
198145
198225
|
styleSourceId: tokenId,
|
|
198146
198226
|
breakpoint: declaration2.breakpoint,
|
|
198147
198227
|
property: declaration2.property,
|
|
198148
198228
|
value: declaration2.value,
|
|
198149
198229
|
state: declaration2.state
|
|
198150
|
-
})
|
|
198151
|
-
|
|
198152
|
-
|
|
198153
|
-
|
|
198154
|
-
|
|
198155
|
-
|
|
198230
|
+
})) {
|
|
198231
|
+
stylePatches.push({
|
|
198232
|
+
op: "add",
|
|
198233
|
+
path: [getStyleDeclKey(style)],
|
|
198234
|
+
value: style
|
|
198235
|
+
});
|
|
198236
|
+
}
|
|
198156
198237
|
}
|
|
198157
198238
|
}
|
|
198158
198239
|
return {
|
|
@@ -198177,23 +198258,24 @@ const createDesignTokenStyleUpdatePayload = ({
|
|
|
198177
198258
|
const styleKeys = new Set(
|
|
198178
198259
|
Array.from(styles, (styleDecl2) => getStyleDeclKey(styleDecl2))
|
|
198179
198260
|
);
|
|
198180
|
-
const patches = updates.
|
|
198181
|
-
|
|
198261
|
+
const patches = updates.flatMap(
|
|
198262
|
+
(update) => createStyleDeclsFromInput({
|
|
198182
198263
|
styleSourceId: designTokenId,
|
|
198183
198264
|
breakpoint: update.breakpoint,
|
|
198184
198265
|
property: update.property,
|
|
198185
198266
|
value: update.value,
|
|
198186
198267
|
state: update.state
|
|
198187
|
-
})
|
|
198188
|
-
|
|
198189
|
-
|
|
198190
|
-
|
|
198191
|
-
|
|
198192
|
-
|
|
198193
|
-
|
|
198194
|
-
|
|
198195
|
-
|
|
198196
|
-
|
|
198268
|
+
}).map((style) => {
|
|
198269
|
+
const key = getStyleDeclKey(style);
|
|
198270
|
+
const patch = {
|
|
198271
|
+
op: styleKeys.has(key) ? "replace" : "add",
|
|
198272
|
+
path: [key],
|
|
198273
|
+
value: style
|
|
198274
|
+
};
|
|
198275
|
+
styleKeys.add(key);
|
|
198276
|
+
return patch;
|
|
198277
|
+
})
|
|
198278
|
+
);
|
|
198197
198279
|
return {
|
|
198198
198280
|
payload: patches.length === 0 ? [] : [{ namespace: "styles", patches }],
|
|
198199
198281
|
styleKeys: patches.map((patch) => String(patch.path[0]))
|
|
@@ -198348,20 +198430,21 @@ const createStyleDeclarationUpdatePayload = ({
|
|
|
198348
198430
|
continue;
|
|
198349
198431
|
}
|
|
198350
198432
|
payload.push(...result.payload);
|
|
198351
|
-
const nextStyleDecl
|
|
198433
|
+
for (const nextStyleDecl of createStyleDeclsFromInput({
|
|
198352
198434
|
styleSourceId: result.styleSourceId,
|
|
198353
198435
|
breakpoint: update.breakpoint,
|
|
198354
198436
|
property: update.property,
|
|
198355
198437
|
value: update.value,
|
|
198356
198438
|
state: update.state,
|
|
198357
198439
|
listed: update.listed
|
|
198358
|
-
})
|
|
198359
|
-
|
|
198360
|
-
|
|
198361
|
-
|
|
198362
|
-
|
|
198363
|
-
|
|
198364
|
-
|
|
198440
|
+
})) {
|
|
198441
|
+
const key = getStyleDeclKey(nextStyleDecl);
|
|
198442
|
+
stylePatches.set(key, {
|
|
198443
|
+
op: existingStyleKeys.has(key) ? "replace" : "add",
|
|
198444
|
+
path: [key],
|
|
198445
|
+
value: nextStyleDecl
|
|
198446
|
+
});
|
|
198447
|
+
}
|
|
198365
198448
|
}
|
|
198366
198449
|
const patches = Array.from(stylePatches.values());
|
|
198367
198450
|
if (patches.length > 0) {
|
|
@@ -198476,21 +198559,22 @@ const createSelectedStyleDeclarationUpdatePayload = ({
|
|
|
198476
198559
|
update.styleSourceId
|
|
198477
198560
|
]);
|
|
198478
198561
|
}
|
|
198479
|
-
const styleDecl2
|
|
198562
|
+
for (const styleDecl2 of createStyleDeclsFromInput({
|
|
198480
198563
|
styleSourceId: update.styleSourceId,
|
|
198481
198564
|
breakpoint: update.breakpoint,
|
|
198482
198565
|
property: update.property,
|
|
198483
198566
|
value: update.value,
|
|
198484
198567
|
state: update.state,
|
|
198485
198568
|
listed: update.listed
|
|
198486
|
-
})
|
|
198487
|
-
|
|
198488
|
-
|
|
198489
|
-
|
|
198490
|
-
|
|
198491
|
-
|
|
198492
|
-
|
|
198493
|
-
|
|
198569
|
+
})) {
|
|
198570
|
+
const styleKey = getStyleDeclKey(styleDecl2);
|
|
198571
|
+
stylePatches.push({
|
|
198572
|
+
op: existingStyleKeys.has(styleKey) ? "replace" : "add",
|
|
198573
|
+
path: [styleKey],
|
|
198574
|
+
value: styleDecl2
|
|
198575
|
+
});
|
|
198576
|
+
existingStyleKeys.add(styleKey);
|
|
198577
|
+
}
|
|
198494
198578
|
}
|
|
198495
198579
|
if (styleSourcePatches.length > 0) {
|
|
198496
198580
|
payload.push({
|
|
@@ -206597,6 +206681,7 @@ const getRenderedAuditScreenshotInput = ({
|
|
|
206597
206681
|
path: pagePath2,
|
|
206598
206682
|
output: `.webstudio/audits/screenshots/${pageId2.replaceAll(/[^a-z0-9_-]/gi, "_")}-${viewport.width}x${viewport.height}.webp`,
|
|
206599
206683
|
source: "session",
|
|
206684
|
+
mode: "production",
|
|
206600
206685
|
viewport: { width: viewport.width, height: viewport.height },
|
|
206601
206686
|
fullPage: true,
|
|
206602
206687
|
includeImageMetrics: performanceEnabled,
|
|
@@ -207366,6 +207451,7 @@ const augmentAuditWithRenderedChecks = async ({
|
|
|
207366
207451
|
const previewResult = await startPreview(
|
|
207367
207452
|
{
|
|
207368
207453
|
source: "session",
|
|
207454
|
+
mode: "production",
|
|
207369
207455
|
port: automaticPreviewPort,
|
|
207370
207456
|
imageDomains: renderedInput.imageDomains
|
|
207371
207457
|
},
|
|
@@ -207814,6 +207900,8 @@ const defaultScreenshotWaitUntil = "load";
|
|
|
207814
207900
|
const defaultScreenshotWaitForTimeout = 250;
|
|
207815
207901
|
const defaultScreenshotTimeout = 3e4;
|
|
207816
207902
|
const isScreenshotWaitUntil = (value2) => typeof value2 === "string" && screenshotWaitUntilValues.includes(value2);
|
|
207903
|
+
const projectPreviewSources = ["local", "session"];
|
|
207904
|
+
const projectPreviewModes = ["iterative", "production"];
|
|
207817
207905
|
const LATEST_PROTOCOL_VERSION = "2024-11-05";
|
|
207818
207906
|
const SUPPORTED_PROTOCOL_VERSIONS = [
|
|
207819
207907
|
LATEST_PROTOCOL_VERSION,
|
|
@@ -215074,7 +215162,11 @@ const parseWebstudioJsxFragment = async (source) => {
|
|
|
215074
215162
|
const fragment = await evaluateWebstudioJsxFragment(source);
|
|
215075
215163
|
return webstudioFragment.parse(fragment);
|
|
215076
215164
|
};
|
|
215165
|
+
const projectSessionPreviewSources = projectPreviewSources;
|
|
215166
|
+
const projectSessionPreviewModes = projectPreviewModes;
|
|
215077
215167
|
const isScreenshotBrowser = (value2) => typeof value2 === "string" && screenshotBrowserChoices.includes(value2);
|
|
215168
|
+
const isProjectSessionPreviewSource = (value2) => projectSessionPreviewSources.some((source) => source === value2);
|
|
215169
|
+
const isProjectSessionPreviewMode = (value2) => projectSessionPreviewModes.some((mode) => mode === value2);
|
|
215078
215170
|
const getRequestParams = (request) => isRecord(request) && isRecord(request.params) ? request.params : {};
|
|
215079
215171
|
const emptyInputSchema = {
|
|
215080
215172
|
type: "object",
|
|
@@ -215635,7 +215727,7 @@ const getNormalizedOperationInput = (operation, input2) => {
|
|
|
215635
215727
|
};
|
|
215636
215728
|
const screenshotInputSchema = {
|
|
215637
215729
|
...emptyInputSchema,
|
|
215638
|
-
description:
|
|
215730
|
+
description: 'Capture the generated site for AI vision review. For the configured project, use { path: "/" }; this refreshes the current MCP session and reloads only the generated site. Never pass a Webstudio Builder/share URL or screenshot the Builder UI. Use { url } only for an intentional standalone external site, or { baseUrl, path } for an existing generated-site server.',
|
|
215639
215731
|
properties: {
|
|
215640
215732
|
url: {
|
|
215641
215733
|
type: "string",
|
|
@@ -215712,10 +215804,16 @@ const screenshotInputSchema = {
|
|
|
215712
215804
|
},
|
|
215713
215805
|
source: {
|
|
215714
215806
|
type: "string",
|
|
215715
|
-
enum:
|
|
215716
|
-
default: "
|
|
215807
|
+
enum: projectSessionPreviewSources,
|
|
215808
|
+
default: "session",
|
|
215717
215809
|
description: "When screenshot needs to start/restart preview for a path, choose local for .webstudio/data.json or session for the current ProjectSession snapshot after MCP edits."
|
|
215718
215810
|
},
|
|
215811
|
+
mode: {
|
|
215812
|
+
type: "string",
|
|
215813
|
+
enum: projectSessionPreviewModes,
|
|
215814
|
+
default: "iterative",
|
|
215815
|
+
description: "Iterative keeps one development server and browser alive while reloading after MCP edits. Production performs a full generated build and is intended for audits and release-like verification."
|
|
215816
|
+
},
|
|
215719
215817
|
host: {
|
|
215720
215818
|
type: "string",
|
|
215721
215819
|
default: "127.0.0.1",
|
|
@@ -215903,7 +216001,7 @@ const installOcrInputSchema = {
|
|
|
215903
216001
|
};
|
|
215904
216002
|
const previewInputSchema = {
|
|
215905
216003
|
...emptyInputSchema,
|
|
215906
|
-
description: "
|
|
216004
|
+
description: "Start or refresh the generated-site preview. Iterative mode is the default for repeated MCP edit and screenshot cycles: it keeps one server alive, regenerates the current session, and uses normal page reloads without HMR. Use production mode for release-like audits.",
|
|
215907
216005
|
properties: {
|
|
215908
216006
|
host: {
|
|
215909
216007
|
type: "string",
|
|
@@ -215915,10 +216013,15 @@ const previewInputSchema = {
|
|
|
215915
216013
|
},
|
|
215916
216014
|
source: {
|
|
215917
216015
|
type: "string",
|
|
215918
|
-
enum:
|
|
215919
|
-
default: "
|
|
216016
|
+
enum: projectSessionPreviewSources,
|
|
216017
|
+
default: "session",
|
|
215920
216018
|
description: "Project data source for generated preview: local uses .webstudio/data.json; session materializes the current ProjectSession snapshot first, which is the right choice after MCP mutations."
|
|
215921
216019
|
},
|
|
216020
|
+
mode: {
|
|
216021
|
+
type: "string",
|
|
216022
|
+
enum: projectSessionPreviewModes,
|
|
216023
|
+
default: "iterative"
|
|
216024
|
+
},
|
|
215922
216025
|
imageDomains: {
|
|
215923
216026
|
type: "array",
|
|
215924
216027
|
description: "External image hostnames allowed by the generated preview optimizer, for example storage.example.com.",
|
|
@@ -216023,6 +216126,15 @@ const mcpArgumentExamples = {
|
|
|
216023
216126
|
],
|
|
216024
216127
|
"download-asset": [{ assetId: "asset-id" }],
|
|
216025
216128
|
"upload-asset": [
|
|
216129
|
+
{
|
|
216130
|
+
asset: {
|
|
216131
|
+
name: "Rajdhani-SemiBold.woff2",
|
|
216132
|
+
type: "font",
|
|
216133
|
+
format: "woff2",
|
|
216134
|
+
meta: { family: "Rajdhani", style: "normal", weight: 600 }
|
|
216135
|
+
},
|
|
216136
|
+
assetsDir: ".webstudio/assets"
|
|
216137
|
+
},
|
|
216026
216138
|
{
|
|
216027
216139
|
asset: {
|
|
216028
216140
|
name: "hero.png",
|
|
@@ -216320,6 +216432,10 @@ const mcpArgumentExamples = {
|
|
|
216320
216432
|
}
|
|
216321
216433
|
],
|
|
216322
216434
|
"update-asset": [
|
|
216435
|
+
{
|
|
216436
|
+
assetId: "font-asset-id",
|
|
216437
|
+
values: { meta: { family: "Rajdhani", style: "normal", weight: 600 } }
|
|
216438
|
+
},
|
|
216323
216439
|
{
|
|
216324
216440
|
assetId: "asset-id",
|
|
216325
216441
|
values: { description: "Team collaborating around a whiteboard" }
|
|
@@ -216500,9 +216616,10 @@ const previewDataSchema = {
|
|
|
216500
216616
|
properties: {
|
|
216501
216617
|
url: { type: "string" },
|
|
216502
216618
|
pid: { type: "integer" },
|
|
216503
|
-
running: { type: "boolean" }
|
|
216619
|
+
running: { type: "boolean" },
|
|
216620
|
+
mode: { type: "string", enum: projectSessionPreviewModes }
|
|
216504
216621
|
},
|
|
216505
|
-
required: ["url", "running"],
|
|
216622
|
+
required: ["url", "running", "mode"],
|
|
216506
216623
|
additionalProperties: false
|
|
216507
216624
|
};
|
|
216508
216625
|
const restorePointSummaryDataSchema = getZodObjectSchema(
|
|
@@ -217094,7 +217211,7 @@ const downloadAssetTool = createProjectSessionMcpTool({
|
|
|
217094
217211
|
const previewTools = [
|
|
217095
217212
|
createProjectSessionMcpTool({
|
|
217096
217213
|
name: "preview.start",
|
|
217097
|
-
description: "
|
|
217214
|
+
description: "Start or refresh a generated-site preview. The iterative default keeps the server and browser alive and normally reloads the generated route after each MCP edit; production mode performs the full build used by audits.",
|
|
217098
217215
|
inputSchema: previewInputSchema,
|
|
217099
217216
|
outputSchema: getMcpOutputSchema(previewDataSchema),
|
|
217100
217217
|
mcpExamples: getMcpExamples("preview.start"),
|
|
@@ -218849,6 +218966,23 @@ const metaGoalGuides = [
|
|
|
218849
218966
|
"Preview and verify every auth state with non-secret fixture data, then audit the route. Do not claim the real provider flow works until redirects, session refresh, failure handling, and protected data access are exercised in its configured environment."
|
|
218850
218967
|
]
|
|
218851
218968
|
},
|
|
218969
|
+
{
|
|
218970
|
+
pattern: /(?:upload|import|add|update|manage).*\bfonts?\b|\bfonts?\b.*(?:upload|import|add|update|manage)|font\s+assets?/i,
|
|
218971
|
+
tools: [
|
|
218972
|
+
"list-fonts",
|
|
218973
|
+
"list-assets",
|
|
218974
|
+
"upload-asset",
|
|
218975
|
+
"upload-assets",
|
|
218976
|
+
"update-asset",
|
|
218977
|
+
"refresh",
|
|
218978
|
+
"get-asset"
|
|
218979
|
+
],
|
|
218980
|
+
workflow: [
|
|
218981
|
+
"Use upload-asset or upload-assets with the local filename, detected format, and complete family, style, and weight metadata. Use the returned asset ids directly; do not read a project snapshot to rediscover uploaded assets.",
|
|
218982
|
+
"Use update-asset to correct font metadata without re-uploading the binary.",
|
|
218983
|
+
'After font mutations, call refresh with {"namespaces":["assets"]}, then use get-asset for each changed id to verify the persisted metadata.'
|
|
218984
|
+
]
|
|
218985
|
+
},
|
|
218852
218986
|
{
|
|
218853
218987
|
pattern: /(?:figma|wireframe|screenshot|design\s*(?:guide|input|file)|design\.md|inception).*(?:page|site|build|implement|recreate)|(?:build|implement|recreate).*(?:figma|wireframe|screenshot|design\s*(?:guide|input|file)|design\.md|inception)/i,
|
|
218854
218988
|
tools: [
|
|
@@ -219433,9 +219567,13 @@ const getScreenshotInput = (input2) => {
|
|
|
219433
219567
|
}
|
|
219434
219568
|
}
|
|
219435
219569
|
const source = input2.source === void 0 ? void 0 : input2.source;
|
|
219436
|
-
if (source !== void 0 && source
|
|
219570
|
+
if (source !== void 0 && isProjectSessionPreviewSource(source) === false) {
|
|
219437
219571
|
throw new Error("screenshot source must be local or session.");
|
|
219438
219572
|
}
|
|
219573
|
+
const mode = input2.mode === void 0 ? void 0 : input2.mode;
|
|
219574
|
+
if (mode !== void 0 && isProjectSessionPreviewMode(mode) === false) {
|
|
219575
|
+
throw new Error("screenshot mode must be iterative or production.");
|
|
219576
|
+
}
|
|
219439
219577
|
const host = typeof input2.host === "string" ? input2.host : void 0;
|
|
219440
219578
|
if (host !== void 0 && host.length === 0) {
|
|
219441
219579
|
throw new Error("screenshot host must not be empty.");
|
|
@@ -219458,9 +219596,9 @@ const getScreenshotInput = (input2) => {
|
|
|
219458
219596
|
} catch {
|
|
219459
219597
|
throw new Error("screenshot baseUrl must be an absolute URL.");
|
|
219460
219598
|
}
|
|
219461
|
-
if (host !== void 0 || port !== void 0 || source !== void 0 || imageDomains !== void 0) {
|
|
219599
|
+
if (host !== void 0 || port !== void 0 || source !== void 0 || mode !== void 0 || imageDomains !== void 0) {
|
|
219462
219600
|
throw new Error(
|
|
219463
|
-
"screenshot baseUrl uses an existing preview/site and cannot be combined with host, port, source, or imageDomains."
|
|
219601
|
+
"screenshot baseUrl uses an existing preview/site and cannot be combined with host, port, source, mode, or imageDomains."
|
|
219464
219602
|
);
|
|
219465
219603
|
}
|
|
219466
219604
|
}
|
|
@@ -219473,6 +219611,7 @@ const getScreenshotInput = (input2) => {
|
|
|
219473
219611
|
port,
|
|
219474
219612
|
imageDomains,
|
|
219475
219613
|
source,
|
|
219614
|
+
mode,
|
|
219476
219615
|
viewport: { width: width2, height: height2 },
|
|
219477
219616
|
fullPage: input2.fullPage === true,
|
|
219478
219617
|
includeImageMetrics: input2.includeImageMetrics === true,
|
|
@@ -219585,9 +219724,13 @@ const getPreviewInput = (input2) => {
|
|
|
219585
219724
|
throw new Error("preview port must be an integer between 1 and 65535.");
|
|
219586
219725
|
}
|
|
219587
219726
|
const source = input2.source === void 0 ? void 0 : input2.source;
|
|
219588
|
-
if (source !== void 0 && source
|
|
219727
|
+
if (source !== void 0 && isProjectSessionPreviewSource(source) === false) {
|
|
219589
219728
|
throw new Error("preview source must be local or session.");
|
|
219590
219729
|
}
|
|
219730
|
+
const mode = input2.mode === void 0 ? void 0 : input2.mode;
|
|
219731
|
+
if (mode !== void 0 && isProjectSessionPreviewMode(mode) === false) {
|
|
219732
|
+
throw new Error("preview mode must be iterative or production.");
|
|
219733
|
+
}
|
|
219591
219734
|
const imageDomains = input2.imageDomains;
|
|
219592
219735
|
if (imageDomains !== void 0 && (Array.isArray(imageDomains) === false || imageDomains.some(
|
|
219593
219736
|
(domain) => typeof domain !== "string" || /^[a-z0-9.-]+(?::\d+)?$/i.test(domain) === false
|
|
@@ -219600,6 +219743,7 @@ const getPreviewInput = (input2) => {
|
|
|
219600
219743
|
host,
|
|
219601
219744
|
port,
|
|
219602
219745
|
source,
|
|
219746
|
+
mode,
|
|
219603
219747
|
imageDomains
|
|
219604
219748
|
};
|
|
219605
219749
|
};
|
|
@@ -219646,7 +219790,8 @@ const createProjectSessionMcpCore = ({
|
|
|
219646
219790
|
guidance,
|
|
219647
219791
|
reportToolProgress,
|
|
219648
219792
|
storeRenderedAuditArtifacts,
|
|
219649
|
-
restorePoints
|
|
219793
|
+
restorePoints,
|
|
219794
|
+
onProjectSessionChange
|
|
219650
219795
|
}) => {
|
|
219651
219796
|
let session;
|
|
219652
219797
|
let pendingCheckpoint;
|
|
@@ -219925,11 +220070,15 @@ const createProjectSessionMcpCore = ({
|
|
|
219925
220070
|
if (name2 === "refresh") {
|
|
219926
220071
|
const session2 = getSession();
|
|
219927
220072
|
await session2.initialize();
|
|
219928
|
-
|
|
220073
|
+
const result = await session2.refresh(getRefreshNamespaces(input2));
|
|
220074
|
+
onProjectSessionChange?.();
|
|
220075
|
+
return toCallResult(result);
|
|
219929
220076
|
}
|
|
219930
220077
|
if (name2 === "reset-session") {
|
|
219931
220078
|
const session2 = getSession();
|
|
219932
|
-
|
|
220079
|
+
const result = await session2.reset();
|
|
220080
|
+
onProjectSessionChange?.();
|
|
220081
|
+
return toCallResult(result);
|
|
219933
220082
|
}
|
|
219934
220083
|
if (name2 === "create-restore-point" && restorePoints !== void 0) {
|
|
219935
220084
|
return toMetaResult(
|
|
@@ -220200,6 +220349,7 @@ const createProjectSessionMcpServer = async ({
|
|
|
220200
220349
|
reportLog,
|
|
220201
220350
|
storeRenderedAuditArtifacts,
|
|
220202
220351
|
restorePoints,
|
|
220352
|
+
onProjectSessionChange,
|
|
220203
220353
|
onInitialized,
|
|
220204
220354
|
toolHeartbeatIntervalMs = 1e4
|
|
220205
220355
|
}) => {
|
|
@@ -220237,6 +220387,7 @@ const createProjectSessionMcpServer = async ({
|
|
|
220237
220387
|
guidance,
|
|
220238
220388
|
storeRenderedAuditArtifacts,
|
|
220239
220389
|
restorePoints,
|
|
220390
|
+
onProjectSessionChange,
|
|
220240
220391
|
reportToolProgress: (message) => {
|
|
220241
220392
|
sendLog("info", message);
|
|
220242
220393
|
}
|
|
@@ -222287,6 +222438,13 @@ const writeFileAtomic = async (filePath, content2) => {
|
|
|
222287
222438
|
throw error;
|
|
222288
222439
|
}
|
|
222289
222440
|
};
|
|
222441
|
+
const writeFileIfChanged = async (filePath, content2) => {
|
|
222442
|
+
if (await readFile(filePath, "utf8").catch(() => void 0) === content2) {
|
|
222443
|
+
return false;
|
|
222444
|
+
}
|
|
222445
|
+
await writeFileAtomic(filePath, content2);
|
|
222446
|
+
return true;
|
|
222447
|
+
};
|
|
222290
222448
|
const wait = (duration) => new Promise((resolve2) => setTimeout(resolve2, duration));
|
|
222291
222449
|
const withFileLock = async (filePath, callback) => {
|
|
222292
222450
|
const lockPath = `${filePath}.lock`;
|
|
@@ -223466,18 +223624,18 @@ class HandledCliError extends Error {
|
|
|
223466
223624
|
}
|
|
223467
223625
|
const isHandledCliError = (error) => error instanceof HandledCliError;
|
|
223468
223626
|
const name = "webstudio";
|
|
223469
|
-
const version = "0.
|
|
223627
|
+
const version = "0.282.1";
|
|
223470
223628
|
const description = "Webstudio CLI";
|
|
223471
223629
|
const author = "Webstudio <github@webstudio.is>";
|
|
223472
223630
|
const homepage = "https://webstudio.is";
|
|
223473
223631
|
const type = "module";
|
|
223474
223632
|
const bin = { "webstudio-cli": "./bin.js", "webstudio": "./bin.js" };
|
|
223475
223633
|
const files = ["lib/*", "templates/*", "bin.js", "!*.{test,stories}.*"];
|
|
223476
|
-
const scripts = { "typecheck": "tsc --noEmit", "generate-docs": "tsx scripts/generate-docs.ts && oxfmt src/docs.generated.ts", "build": "pnpm generate-docs && rm -rf lib && vite build", "test": "vitest run", "test:release-smoke": "pnpm build && tsx --conditions=webstudio scripts/release-smoke.ts", "test:release-smoke:model": "WEBSTUDIO_RELEASE_SMOKE_MODEL_EVAL_REQUIRED=1 pnpm test:release-smoke", "test:release-smoke:registry": "tsx --conditions=webstudio scripts/release-smoke.ts" };
|
|
223634
|
+
const scripts = { "typecheck": "tsc --noEmit", "generate-docs": "tsx scripts/generate-docs.ts && oxfmt src/docs.generated.ts", "build": "pnpm generate-docs && rm -rf lib && vite build", "evaluations": "tsx --conditions=webstudio evaluations/high-impact/run-local-agent.ts", "test": "vitest run", "test:release-smoke": "pnpm build && tsx --conditions=webstudio scripts/release-smoke.ts", "test:release-smoke:model": "WEBSTUDIO_RELEASE_SMOKE_MODEL_EVAL_REQUIRED=1 pnpm test:release-smoke", "test:release-smoke:registry": "tsx --conditions=webstudio scripts/release-smoke.ts" };
|
|
223477
223635
|
const license = "AGPL-3.0-or-later";
|
|
223478
223636
|
const engines = { "node": ">=22" };
|
|
223479
223637
|
const dependencies = { "@clack/prompts": "^0.10.0", "@emotion/hash": "^0.9.2", "@trpc/client": "^10.45.2", "@webstudio-is/http-client": "workspace:*", "@webstudio-is/project-migrations": "workspace:*", "@webstudio-is/protocol": "workspace:*", "@webstudio-is/sync-client": "workspace:*", "acorn": "^8.14.1", "acorn-jsx": "^5.3.2", "acorn-walk": "^8.3.4", "change-case": "^5.4.4", "chrome-launcher": "^1.2.1", "deepmerge": "^4.3.1", "decode-named-character-reference": "^1.0.2", "env-paths": "^3.0.0", "esbuild": "^0.25.3", "fast-deep-equal": "^3.1.3", "immer": "^10.1.1", "nanoid": "^5.1.5", "p-limit": "^6.2.0", "parse5": "7.3.0", "picocolors": "^1.1.1", "reserved-identifiers": "^1.0.0", "tinyexec": "^0.3.2", "tus-js-client": "^4.3.1", "warn-once": "^0.1.1", "yargs": "^17.7.2", "zod": "^4.4.3" };
|
|
223480
|
-
const devDependencies = { "@cloudflare/vite-plugin": "^1.1.0", "@netlify/vite-plugin-react-router": "^1.0.1", "@react-router/dev": "^7.5.3", "@react-router/fs-routes": "^7.5.3", "@react-router/node": "^7.5.3", "@react-router/serve": "^7.5.3", "@remix-run/cloudflare": "^2.16.5", "@remix-run/cloudflare-pages": "^2.16.5", "@remix-run/dev": "^2.16.5", "@remix-run/node": "^2.16.5", "@remix-run/react": "^2.16.5", "@remix-run/server-runtime": "^2.16.5", "@types/mdast": "^4.0.4", "@types/react": "^18.2.70", "@types/react-dom": "^18.2.25", "@types/yargs": "^17.0.33", "@vercel/react-router": "^1.1.0", "@vitejs/plugin-react": "^4.4.1", "@webstudio-is/css-engine": "workspace:*", "@webstudio-is/image": "workspace:*", "@webstudio-is/project-build": "workspace:*", "@webstudio-is/react-sdk": "workspace:*", "@webstudio-is/sdk": "workspace:*", "@webstudio-is/sdk-components-animation": "workspace:*", "@webstudio-is/sdk-components-react": "workspace:*", "@webstudio-is/sdk-components-react-radix": "workspace:*", "@webstudio-is/sdk-components-react-remix": "workspace:*", "@webstudio-is/sdk-components-react-router": "workspace:*", "@webstudio-is/sdk-components-registry": "workspace:*", "@webstudio-is/tsconfig": "workspace:*", "@webstudio-is/wsauth": "workspace:*", "h3": "^1.15.1", "ipx": "^3.0.3", "isbot": "^5.1.25", "mdast-util-directive": "^3.1.0", "mdast-util-from-markdown": "^2.0.3", "mdast-util-to-string": "^4.0.0", "micromark-extension-directive": "^4.0.0", "oxfmt": "0.58.0", "react": "18.3.0-canary-14898b6a9-20240318", "react-dom": "18.3.0-canary-14898b6a9-20240318", "react-router": "^7.5.3", "ts-expect": "^1.3.0", "typescript": "7.0.2", "vike": "^0.4.229", "vite": "^6.3.4", "vitest": "^3.1.2", "wrangler": "^3.63.2" };
|
|
223638
|
+
const devDependencies = { "@cloudflare/vite-plugin": "^1.1.0", "@netlify/vite-plugin-react-router": "^1.0.1", "@react-router/dev": "^7.5.3", "@react-router/fs-routes": "^7.5.3", "@react-router/node": "^7.5.3", "@react-router/serve": "^7.5.3", "@remix-run/cloudflare": "^2.16.5", "@remix-run/cloudflare-pages": "^2.16.5", "@remix-run/dev": "^2.16.5", "@remix-run/node": "^2.16.5", "@remix-run/react": "^2.16.5", "@remix-run/server-runtime": "^2.16.5", "@types/mdast": "^4.0.4", "@types/react": "^18.2.70", "@types/react-dom": "^18.2.25", "@types/yargs": "^17.0.33", "@vercel/react-router": "^1.1.0", "@vitejs/plugin-react": "^4.4.1", "@webstudio-is/css-engine": "workspace:*", "@webstudio-is/fonts": "workspace:*", "@webstudio-is/image": "workspace:*", "@webstudio-is/project-build": "workspace:*", "@webstudio-is/react-sdk": "workspace:*", "@webstudio-is/sdk": "workspace:*", "@webstudio-is/sdk-components-animation": "workspace:*", "@webstudio-is/sdk-components-react": "workspace:*", "@webstudio-is/sdk-components-react-radix": "workspace:*", "@webstudio-is/sdk-components-react-remix": "workspace:*", "@webstudio-is/sdk-components-react-router": "workspace:*", "@webstudio-is/sdk-components-registry": "workspace:*", "@webstudio-is/tsconfig": "workspace:*", "@webstudio-is/wsauth": "workspace:*", "h3": "^1.15.1", "ipx": "^3.0.3", "isbot": "^5.1.25", "mdast-util-directive": "^3.1.0", "mdast-util-from-markdown": "^2.0.3", "mdast-util-to-string": "^4.0.0", "micromark-extension-directive": "^4.0.0", "oxfmt": "0.58.0", "react": "18.3.0-canary-14898b6a9-20240318", "react-dom": "18.3.0-canary-14898b6a9-20240318", "react-router": "^7.5.3", "ts-expect": "^1.3.0", "typescript": "7.0.2", "vike": "^0.4.229", "vite": "^6.3.4", "vitest": "^3.1.2", "wrangler": "^3.63.2" };
|
|
223481
223639
|
const packageJson = {
|
|
223482
223640
|
name,
|
|
223483
223641
|
version,
|
|
@@ -226898,25 +227056,32 @@ const remixComponents = /* @__PURE__ */ Object.freeze(/* @__PURE__ */ Object.def
|
|
|
226898
227056
|
RemixForm: RemixForm$1,
|
|
226899
227057
|
RichTextLink: Link$2
|
|
226900
227058
|
}, Symbol.toStringTag, { value: "Module" }));
|
|
226901
|
-
const
|
|
226902
|
-
|
|
227059
|
+
const routeTemplatesDirectory = join("app", "route-templates");
|
|
227060
|
+
const cleanupFrameworkTemplates = async ({
|
|
227061
|
+
preserveTemplates = false
|
|
227062
|
+
} = {}) => {
|
|
227063
|
+
if (preserveTemplates === false) {
|
|
227064
|
+
await rm(routeTemplatesDirectory, { recursive: true, force: true });
|
|
227065
|
+
}
|
|
227066
|
+
};
|
|
227067
|
+
const createFramework$2 = async (options = {}) => {
|
|
226903
227068
|
const htmlTemplate = await readFile(
|
|
226904
|
-
join(
|
|
227069
|
+
join(routeTemplatesDirectory, "html.tsx"),
|
|
226905
227070
|
"utf8"
|
|
226906
227071
|
);
|
|
226907
227072
|
const xmlTemplate = await readFile(
|
|
226908
|
-
join(
|
|
227073
|
+
join(routeTemplatesDirectory, "xml.tsx"),
|
|
226909
227074
|
"utf8"
|
|
226910
227075
|
);
|
|
226911
227076
|
const textTemplate = await readFile(
|
|
226912
|
-
join(
|
|
227077
|
+
join(routeTemplatesDirectory, "text.tsx"),
|
|
226913
227078
|
"utf8"
|
|
226914
227079
|
);
|
|
226915
227080
|
const defaultSitemapTemplate = await readFile(
|
|
226916
|
-
join(
|
|
227081
|
+
join(routeTemplatesDirectory, "default-sitemap.tsx"),
|
|
226917
227082
|
"utf8"
|
|
226918
227083
|
);
|
|
226919
|
-
await
|
|
227084
|
+
await cleanupFrameworkTemplates(options);
|
|
226920
227085
|
const remix = "@webstudio-is/sdk-components-react-remix";
|
|
226921
227086
|
const { components: components2, metas } = createFrameworkComponentRegistry({
|
|
226922
227087
|
routerComponents: remixComponents,
|
|
@@ -229275,25 +229440,24 @@ const reactRouterComponents = /* @__PURE__ */ Object.freeze(/* @__PURE__ */ Obje
|
|
|
229275
229440
|
RemixForm,
|
|
229276
229441
|
RichTextLink: Link
|
|
229277
229442
|
}, Symbol.toStringTag, { value: "Module" }));
|
|
229278
|
-
const createFramework$1 = async () => {
|
|
229279
|
-
const routeTemplatesDir = join("app", "route-templates");
|
|
229443
|
+
const createFramework$1 = async (options = {}) => {
|
|
229280
229444
|
const htmlTemplate = await readFile(
|
|
229281
|
-
join(
|
|
229445
|
+
join(routeTemplatesDirectory, "html.tsx"),
|
|
229282
229446
|
"utf8"
|
|
229283
229447
|
);
|
|
229284
229448
|
const xmlTemplate = await readFile(
|
|
229285
|
-
join(
|
|
229449
|
+
join(routeTemplatesDirectory, "xml.tsx"),
|
|
229286
229450
|
"utf8"
|
|
229287
229451
|
);
|
|
229288
229452
|
const textTemplate = await readFile(
|
|
229289
|
-
join(
|
|
229453
|
+
join(routeTemplatesDirectory, "text.tsx"),
|
|
229290
229454
|
"utf8"
|
|
229291
229455
|
);
|
|
229292
229456
|
const defaultSitemapTemplate = await readFile(
|
|
229293
|
-
join(
|
|
229457
|
+
join(routeTemplatesDirectory, "default-sitemap.tsx"),
|
|
229294
229458
|
"utf8"
|
|
229295
229459
|
);
|
|
229296
|
-
await
|
|
229460
|
+
await cleanupFrameworkTemplates(options);
|
|
229297
229461
|
const reactRouter = "@webstudio-is/sdk-components-react-router";
|
|
229298
229462
|
const { components: components2, metas } = createFrameworkComponentRegistry({
|
|
229299
229463
|
routerComponents: reactRouterComponents,
|
|
@@ -229346,21 +229510,20 @@ const generateVikeRoute = (pagePath2) => {
|
|
|
229346
229510
|
}
|
|
229347
229511
|
return pagePath2;
|
|
229348
229512
|
};
|
|
229349
|
-
const createFramework = async () => {
|
|
229350
|
-
const routeTemplatesDir = join("app", "route-templates");
|
|
229513
|
+
const createFramework = async (options = {}) => {
|
|
229351
229514
|
const htmlPageTemplate = await readFile(
|
|
229352
|
-
join(
|
|
229515
|
+
join(routeTemplatesDirectory, "html", "+Page.tsx"),
|
|
229353
229516
|
"utf8"
|
|
229354
229517
|
);
|
|
229355
229518
|
const htmlHeadTemplate = await readFile(
|
|
229356
|
-
join(
|
|
229519
|
+
join(routeTemplatesDirectory, "html", "+Head.tsx"),
|
|
229357
229520
|
"utf8"
|
|
229358
229521
|
);
|
|
229359
229522
|
const htmlDataTemplate = await readFile(
|
|
229360
|
-
join(
|
|
229523
|
+
join(routeTemplatesDirectory, "html", "+data.ts"),
|
|
229361
229524
|
"utf8"
|
|
229362
229525
|
);
|
|
229363
|
-
await
|
|
229526
|
+
await cleanupFrameworkTemplates(options);
|
|
229364
229527
|
const { components: components2, metas } = createFrameworkComponentRegistry();
|
|
229365
229528
|
return {
|
|
229366
229529
|
metas,
|
|
@@ -229395,6 +229558,14 @@ const createFramework = async () => {
|
|
|
229395
229558
|
defaultSitemap: () => []
|
|
229396
229559
|
};
|
|
229397
229560
|
};
|
|
229561
|
+
const generatedFilesManifest = join(
|
|
229562
|
+
".webstudio",
|
|
229563
|
+
"generated-files.json"
|
|
229564
|
+
);
|
|
229565
|
+
const appRoot = "app";
|
|
229566
|
+
const generatedDir = join(appRoot, "__generated__");
|
|
229567
|
+
const routesDir = join(appRoot, "routes");
|
|
229568
|
+
const generatedOutputDirectories = [generatedDir, routesDir];
|
|
229398
229569
|
const mergeJsonInto = async (sourcePath, destinationPath) => {
|
|
229399
229570
|
const sourceJson = await readFile(sourcePath, "utf8");
|
|
229400
229571
|
const destinationJson = await readFile(destinationPath, "utf8").catch(
|
|
@@ -229434,15 +229605,35 @@ const readAssetBaseUrl = async (constantsPath) => {
|
|
|
229434
229605
|
`Cannot read exported string assetBaseUrl from ${constantsPath}`
|
|
229435
229606
|
);
|
|
229436
229607
|
};
|
|
229437
|
-
const writeWsAuthResources = async (
|
|
229608
|
+
const writeWsAuthResources = async (generatedDir2, pages2, projectSettings2, writeGeneratedFile) => {
|
|
229438
229609
|
const { content: content2, module } = createAuthConfigResources(pages2, projectSettings2);
|
|
229439
229610
|
await createFolderIfNotExists(dirname(LOCAL_AUTH_FILE));
|
|
229440
|
-
await
|
|
229441
|
-
await
|
|
229442
|
-
join(
|
|
229611
|
+
await writeFileIfChanged(LOCAL_AUTH_FILE, content2);
|
|
229612
|
+
await writeGeneratedFile(
|
|
229613
|
+
join(generatedDir2, "$resources.wsauth.server.ts"),
|
|
229443
229614
|
module
|
|
229444
229615
|
);
|
|
229445
229616
|
};
|
|
229617
|
+
const isGeneratedOutputPath = (path2) => generatedOutputDirectories.some((directory) => {
|
|
229618
|
+
const relativePath = relative(directory, path2);
|
|
229619
|
+
return relativePath !== "" && relativePath !== ".." && relativePath.startsWith(`..${sep}`) === false && isAbsolute(relativePath) === false;
|
|
229620
|
+
});
|
|
229621
|
+
const readGeneratedFilesManifest = async () => {
|
|
229622
|
+
const value2 = JSON.parse(await readFile(generatedFilesManifest, "utf8"));
|
|
229623
|
+
if (Array.isArray(value2) === false || value2.some(
|
|
229624
|
+
(path2) => typeof path2 !== "string" || isGeneratedOutputPath(path2) === false
|
|
229625
|
+
)) {
|
|
229626
|
+
throw new Error("Generated files manifest is invalid.");
|
|
229627
|
+
}
|
|
229628
|
+
return new Set(value2);
|
|
229629
|
+
};
|
|
229630
|
+
const removeObsoleteGeneratedFiles = async (previousFiles, generatedFiles) => {
|
|
229631
|
+
for (const path2 of previousFiles) {
|
|
229632
|
+
if (generatedFiles.has(path2) === false) {
|
|
229633
|
+
await rm(path2, { force: true });
|
|
229634
|
+
}
|
|
229635
|
+
}
|
|
229636
|
+
};
|
|
229446
229637
|
const isCliTemplate = async (template) => {
|
|
229447
229638
|
const currentPath = fileURLToPath(new URL(import.meta.url));
|
|
229448
229639
|
const templatesPath = normalize$2(
|
|
@@ -229555,22 +229746,42 @@ Please check webstudio --help for more details`
|
|
|
229555
229746
|
}
|
|
229556
229747
|
}
|
|
229557
229748
|
feedback.step("Scaffolding the project files");
|
|
229558
|
-
|
|
229559
|
-
|
|
229560
|
-
|
|
229561
|
-
|
|
229562
|
-
|
|
229749
|
+
if (options.incremental !== true) {
|
|
229750
|
+
await rm(generatedDir, { recursive: true, force: true });
|
|
229751
|
+
}
|
|
229752
|
+
if (options.incremental !== true) {
|
|
229753
|
+
await rm(routesDir, { recursive: true, force: true });
|
|
229754
|
+
}
|
|
229755
|
+
const generatedFiles = /* @__PURE__ */ new Set();
|
|
229756
|
+
const previousGeneratedFiles = options.incremental === true ? await readGeneratedFilesManifest() : /* @__PURE__ */ new Set();
|
|
229757
|
+
const writeGeneratedFile = async (file2, content2) => {
|
|
229758
|
+
generatedFiles.add(normalize$2(file2));
|
|
229759
|
+
if (options.incremental === true) {
|
|
229760
|
+
return await writeFileIfChanged(file2, content2);
|
|
229761
|
+
}
|
|
229762
|
+
await createFileIfNotExists(file2, content2);
|
|
229763
|
+
return true;
|
|
229764
|
+
};
|
|
229563
229765
|
await writeFile(join(cwd(), ".npmrc"), npmrc);
|
|
229564
|
-
|
|
229565
|
-
|
|
229766
|
+
if (options.incremental !== true) {
|
|
229767
|
+
for (const template of options.template) {
|
|
229768
|
+
await copyTemplates(template);
|
|
229769
|
+
}
|
|
229566
229770
|
}
|
|
229771
|
+
const preserveRouteTemplates = options.incremental === true || options.preserveRouteTemplates === true;
|
|
229567
229772
|
let framework;
|
|
229568
229773
|
if (options.template.includes("ssg")) {
|
|
229569
|
-
framework = await createFramework(
|
|
229774
|
+
framework = await createFramework({
|
|
229775
|
+
preserveTemplates: preserveRouteTemplates
|
|
229776
|
+
});
|
|
229570
229777
|
} else if (options.template.includes("react-router")) {
|
|
229571
|
-
framework = await createFramework$1(
|
|
229778
|
+
framework = await createFramework$1({
|
|
229779
|
+
preserveTemplates: preserveRouteTemplates
|
|
229780
|
+
});
|
|
229572
229781
|
} else {
|
|
229573
|
-
framework = await createFramework$2(
|
|
229782
|
+
framework = await createFramework$2({
|
|
229783
|
+
preserveTemplates: preserveRouteTemplates
|
|
229784
|
+
});
|
|
229574
229785
|
}
|
|
229575
229786
|
const assetBaseUrl = await readAssetBaseUrl(join(cwd(), "app/constants.mjs"));
|
|
229576
229787
|
const loadedSiteData = await loadJSONFile(LOCAL_DATA_FILE);
|
|
@@ -229595,7 +229806,8 @@ Please check webstudio --help for more details`
|
|
|
229595
229806
|
await writeWsAuthResources(
|
|
229596
229807
|
generatedDir,
|
|
229597
229808
|
pages2,
|
|
229598
|
-
siteData.build.projectSettings
|
|
229809
|
+
siteData.build.projectSettings,
|
|
229810
|
+
writeGeneratedFile
|
|
229599
229811
|
);
|
|
229600
229812
|
const siteDataByPage = {};
|
|
229601
229813
|
const fontAssetsByPage = {};
|
|
@@ -229700,7 +229912,7 @@ Please check webstudio --help for more details`
|
|
|
229700
229912
|
assetBaseUrl,
|
|
229701
229913
|
atomic: siteData.build.projectSettings?.compiler.atomicStyles ?? pages2.compiler?.atomicStyles ?? true
|
|
229702
229914
|
});
|
|
229703
|
-
await
|
|
229915
|
+
await writeGeneratedFile(join(generatedDir, "index.css"), cssText);
|
|
229704
229916
|
for (const page2 of generatedPages) {
|
|
229705
229917
|
const scope2 = createScope([
|
|
229706
229918
|
// manually maintained list of occupied identifiers
|
|
@@ -229817,6 +230029,8 @@ Please check webstudio --help for more details`
|
|
|
229817
230029
|
|
|
229818
230030
|
export const projectId = "${siteData.build.projectId}";
|
|
229819
230031
|
|
|
230032
|
+
${pagePath2 === "/" ? `export const projectVersion = ${siteData.build.version};` : ""}
|
|
230033
|
+
|
|
229820
230034
|
export const projectDomain = ${JSON.stringify(siteData.projectDomain)};
|
|
229821
230035
|
|
|
229822
230036
|
export const lastPublished = "${new Date(siteData.build.createdAt).toISOString()}";
|
|
@@ -229888,9 +230102,9 @@ Please check webstudio --help for more details`
|
|
|
229888
230102
|
`;
|
|
229889
230103
|
const generatedBasename = generateRemixRoute(pagePath2);
|
|
229890
230104
|
const clientFile = join(generatedDir, `${generatedBasename}.tsx`);
|
|
229891
|
-
await
|
|
230105
|
+
await writeGeneratedFile(clientFile, pageExports);
|
|
229892
230106
|
const serverFile = join(generatedDir, `${generatedBasename}.server.tsx`);
|
|
229893
|
-
await
|
|
230107
|
+
await writeGeneratedFile(serverFile, serverExports);
|
|
229894
230108
|
const getTemplates = framework[documentType];
|
|
229895
230109
|
for (const { file: file2, template } of getTemplates({ pagePath: pagePath2 })) {
|
|
229896
230110
|
const content2 = template.replaceAll("__CONSTANTS__", importFrom("./app/constants.mjs", file2)).replaceAll(
|
|
@@ -229912,7 +230126,7 @@ Please check webstudio --help for more details`
|
|
|
229912
230126
|
"__CSS__",
|
|
229913
230127
|
importFrom(`./app/__generated__/index.css`, file2)
|
|
229914
230128
|
);
|
|
229915
|
-
await
|
|
230129
|
+
await writeGeneratedFile(file2, content2);
|
|
229916
230130
|
}
|
|
229917
230131
|
}
|
|
229918
230132
|
for (const { file: file2, template } of framework.defaultSitemap()) {
|
|
@@ -229920,9 +230134,9 @@ Please check webstudio --help for more details`
|
|
|
229920
230134
|
"__SITEMAP__",
|
|
229921
230135
|
importFrom(`./app/__generated__/$resources.sitemap.xml`, file2)
|
|
229922
230136
|
);
|
|
229923
|
-
await
|
|
230137
|
+
await writeGeneratedFile(file2, content2);
|
|
229924
230138
|
}
|
|
229925
|
-
await
|
|
230139
|
+
await writeGeneratedFile(
|
|
229926
230140
|
join(generatedDir, "$resources.sitemap.xml.ts"),
|
|
229927
230141
|
`
|
|
229928
230142
|
export const sitemap = ${JSON.stringify(
|
|
@@ -229935,27 +230149,39 @@ Please check webstudio --help for more details`
|
|
|
229935
230149
|
const assetsById = Object.fromEntries(
|
|
229936
230150
|
siteData.assets.map((asset2) => [
|
|
229937
230151
|
asset2.id,
|
|
229938
|
-
|
|
230152
|
+
{
|
|
230153
|
+
...toRuntimeAsset(asset2, "https://placeholder.local"),
|
|
230154
|
+
// Generated projects serve materialized assets from the template's
|
|
230155
|
+
// asset base; the /cgi routes only exist in the live builder.
|
|
230156
|
+
url: `${assetBaseUrl}${asset2.name}`
|
|
230157
|
+
}
|
|
229939
230158
|
])
|
|
229940
230159
|
);
|
|
229941
|
-
await
|
|
230160
|
+
await writeGeneratedFile(
|
|
229942
230161
|
join(generatedDir, "$resources.assets.ts"),
|
|
229943
230162
|
`
|
|
229944
230163
|
export const assets = ${JSON.stringify(assetsById, null, 2)};
|
|
229945
230164
|
`
|
|
229946
230165
|
);
|
|
229947
|
-
await
|
|
230166
|
+
await writeGeneratedFile(
|
|
229948
230167
|
join(generatedDir, "$resources.redirects.ts"),
|
|
229949
230168
|
generateRedirectsModule(pages2.redirects)
|
|
229950
230169
|
);
|
|
229951
230170
|
if (pages2.redirects !== void 0 && pages2.redirects.length > 0) {
|
|
229952
|
-
await
|
|
230171
|
+
await writeGeneratedFile(
|
|
229953
230172
|
join(routesDir, "$.tsx"),
|
|
229954
230173
|
generateRedirectFallbackRoute(
|
|
229955
230174
|
options.template.includes("react-router") ? "react-router" : "remix"
|
|
229956
230175
|
)
|
|
229957
230176
|
);
|
|
229958
230177
|
}
|
|
230178
|
+
if (options.incremental === true) {
|
|
230179
|
+
await removeObsoleteGeneratedFiles(previousGeneratedFiles, generatedFiles);
|
|
230180
|
+
}
|
|
230181
|
+
await writeFileIfChanged(
|
|
230182
|
+
generatedFilesManifest,
|
|
230183
|
+
JSON.stringify([...generatedFiles].sort(), void 0, 2)
|
|
230184
|
+
);
|
|
229959
230185
|
if (options.assets === true && siteData.assets.length > 0) {
|
|
229960
230186
|
const downloading = createProgress();
|
|
229961
230187
|
downloading.start("Downloading fonts and images");
|
|
@@ -230014,12 +230240,12 @@ const build = async (options) => {
|
|
|
230014
230240
|
await prebuild(options);
|
|
230015
230241
|
};
|
|
230016
230242
|
const cliDocs = {
|
|
230017
|
-
"api-use-cases": '# CLI API Use Cases\n\n## Link/configure one project\n\nCommands:\n\n- webstudio init --link <api-share-link> --json\n\nNotes:\n\n- Writes local project id and global origin/token config.\n\n## Import synced project bundle into another project\n\nCommands:\n\n- webstudio sync\n- webstudio import --to <destination-share-link>\n- MCP tool: import {"to":"<destination-share-link>"}\n\nNotes:\n\n- Imports local `.webstudio/data.json` into the destination project.\n- Destination share link must allow build/import access.\n- Use `--skip-assets` only when asset rows and files should not be imported.\n\n## Identify current token\n\nCommands:\n\n- MCP tool: whoami {}\n\n## Check token permissions\n\nCommands:\n\n- webstudio permissions --json\n\n## Inspect project/build/version\n\nCommands:\n\n- MCP tool: inspect {}\n- MCP tool: snapshot {"include":["pages","instances","styles"]}\n\n## Discover CLI/API capabilities\n\nCommands:\n\n- webstudio schema api\n- webstudio schema mcp\n- webstudio man --json\n- webstudio man llm --json\n- MCP tool: meta.index {}\n- MCP tool: meta.guide {"brief":"Create a pricing page"}\n- MCP tool: meta.get_more_tools {"brief":"update-styles"}\n- webstudio mcp list-resources\n- webstudio mcp read-resource webstudio://project/guide\n- webstudio mcp read-resource webstudio://project/expressions\n\nNotes:\n\n- Use `webstudio schema mcp` for a compact machine-readable MCP tool overview. Add `--verbose` or use focused `meta.get_more_tools` calls only when exact input schemas are needed.\n- Use focused MCP tools for discovery first: `meta.index`, `meta.guide`, `meta.get_more_tools`, `components.list`, `components.summary`, `components.search`, `components.get`, `templates.list`, and `templates.get`. Protocol clients can use `resources/list` and `resources/read`; shell agents can use `webstudio mcp list-resources` and `webstudio mcp read-resource <uri>`. Read longer resources such as `webstudio://project/tools` and `webstudio://project/components` only when focused tools are insufficient.\n- `components.summary` returns counts by default; request `{"detail":"components","limit":20}` for paginated entries. Registry list tools return compact metadata, while `components.get` and `templates.get` return focused full details.\n- Read `webstudio://project/expressions` before authoring unfamiliar computed text, prop bindings, resource expressions, actions, or Collection item bindings.\n- From a shell, call one MCP tool with the shortcut form `webstudio <tool> \'<json>\'`, for example `webstudio components.summary`. The explicit equivalent is `webstudio mcp single-op-call <tool> \'<json>\'`. Use `--input-file` for large payloads.\n\n## Inspect external shadcn registry items\n\nCommands:\n\n- webstudio registry inspect --source https://example.com/r/registry.json --item button --json\n- webstudio registry inspect --source ./registry.json --item dialog --json\n- webstudio registry inspect --source https://example.com/r/button.json --json\n\nNotes:\n\n- Reads a local or remote registry item without installing files or changing the configured Webstudio project.\n- Returns the item name, description, package and registry dependencies, file paths/targets, available docs, and a read-only compatibility report.\n- The report explicitly says whether installation or editable-component conversion is supported, lists declared requirements and manual steps, and says when arbitrary source code was not analyzed.\n- This is an inspection step only. It does not install files or change the configured project.\n\n## Understand what MCP can do\n\nCommands:\n\n- webstudio man mcp\n- MCP tool: meta.index {}\n- MCP tool: meta.guide {"brief":"What can Webstudio MCP do?"}\n\nMCP lets agents work on one configured Webstudio project. Agents can:\n\n- Inspect the linked project, token permissions, and latest editable build.\n- Read selected project data for audits, migrations, and repair.\n- Search labels, text, props, resource URLs, asset metadata, and styles.\n- Audit accessibility, security, SEO, performance settings, unused assets, ineffective Collection styles, and unused or duplicate style data.\n- Create and edit pages, folders, redirects, breakpoints, and page templates.\n- Create pages from reusable templates.\n- Update page metadata, SEO fields, auth settings, and marketplace metadata.\n- Insert components and styled JSX sections.\n- Create data-driven lists, grids, cards, and similar repeated UI from array or object data in one Collection operation.\n- Move, copy, wrap, unwrap, convert, rename, retag, and delete elements.\n- Update text, rich text, props, bindings, and actions.\n- Create and update local styles, design tokens, style sources, and CSS variables.\n- Create static data variables and JSON variables.\n- Create HTTP, GraphQL, and system resources.\n- Use system resources for sitemap, current date, and assets.\n- Bind resources to rendered data or form/action props.\n- Manage nested asset folders and upload, inspect, move, duplicate, download, replace, delete, and inspect usage for assets.\n- Publish, unpublish, inspect publish jobs, and manage custom domains.\n- Start preview, capture screenshots, compare screenshot diffs, and use OCR when installed.\n\n## Inspect and refresh MCP session cache\n\nCommands:\n\n- MCP tool: status {}\n- MCP tool: status {"verbose":true}\n- MCP tool: refresh {"namespaces":["pages","instances","styles"]}\n- MCP tool: reset-session {}\n\nNotes:\n\n- Use status before a task to understand the cached ProjectSession state.\n- Use status with `{"verbose":true}` only when debugging full namespaces, freshness, compatibility, or diagnostics.\n- Use refresh when project data may have changed outside the current MCP session.\n- Use reset-session when local cached state is corrupt or incompatible.\n\n## Visually verify rendered work with AI vision\n\nCommands:\n\n- MCP tool: preview.start {"host":"127.0.0.1","port":5173}\n- MCP tool: preview.status {}\n- MCP tool: preview.stop {}\n- MCP tool: screenshot {"path":"/","output":".webstudio/screenshots/home-current.png","viewport":{"width":1440,"height":900},"waitUntil":"load","waitForTimeout":250}\n- MCP tool: screenshot {"path":"/pricing","output":".webstudio/screenshots/pricing-current.png","viewport":{"width":1440,"height":900},"waitUntil":"load","waitForTimeout":250}\n- MCP tool: screenshot {"baseUrl":"http://127.0.0.1:5177","path":"/pricing","output":".webstudio/screenshots/pricing-current.png","viewport":{"width":1440,"height":900},"waitUntil":"load","waitForTimeout":250}\n- MCP tool: screenshot.diff {"baselinePath":".webstudio/screenshots/home-before.png","currentPath":".webstudio/screenshots/home-current.png","outputDir":".webstudio/screenshots/diff"}\n- MCP tool: screenshot.diff {"baselinePath":".webstudio/screenshots/home-before.png","currentPath":".webstudio/screenshots/home-current.png","outputDir":".webstudio/screenshots/diff","expectedText":["Pricing","Start free"]}\n- MCP tool: screenshot.diff {"baselinePath":".webstudio/screenshots/home-before.png","currentPath":".webstudio/screenshots/home-current.png","outputDir":".webstudio/screenshots/diff","expectedVisual":{"maxMismatchPercentage":2,"maxChangedRegions":3,"dominantColorChange":{"channel":"luminance","direction":"increase","minMagnitude":10}}}\n- MCP tool: screenshot.diff {"baselinePath":".webstudio/screenshots/pricing-before.png","currentPath":".webstudio/screenshots/pricing-current.png","outputDir":".webstudio/screenshots/diff"}\n- MCP tool: vision.install-ocr {"confirm":true}\n\nNotes:\n\n- Use this after page/content/style mutations and after generated project files are current so a vision-capable AI can see the production-like generated site.\n- For multi-page work, capture every changed page by `path` through the same preview server; no click navigation is required.\n- After MCP mutations, path screenshots regenerate/restart preview as needed before capture; when preview is fresh, repeated path screenshots reuse the running server.\n- Do not call `preview.start` through one-shot `webstudio mcp single-op-call`: it is long-lived. From a shell, use `webstudio mcp run` with preview.start, screenshot, and preview.stop in one shared process, or use a real long-running MCP client.\n- From one-shot shell calls or another process, pass `baseUrl` with `path` to capture an already-running preview/site without generating, building, starting, or restarting preview.\n- Use preview.stop only in the same long-running MCP server or `webstudio mcp run` process that started preview. A separate one-shot `single-op-call` process does not own another process\'s preview controller.\n- Use waitForSelector when the rendered app has a reliable ready marker, waitUntil:"networkidle" for network-heavy pages, and waitForTimeout only for final visual settling.\n- Preview installs generated app dependencies under `.webstudio/preview` and reuses them across regenerations.\n- Do not add generated-preview dependencies to the repository root `package.json` or `pnpm-lock.yaml`.\n- If dependency installation fails, check npm and network configuration, then reinstall or update the Webstudio CLI if the problem persists.\n- When a baseline exists, use screenshot.diff once per baseline/current page or viewport pair to get changed regions, OCR textAnalysis, and diff artifact paths before deciding whether the result matches. Pass expectedText for explicit pass/fail current-screen text assertions with found and missing text. Pass expectedVisual for pass/fail limits on pixel mismatch percentage, changed-region count, or the overall dominant color/brightness direction.\n- If screenshot.diff reports OCR unavailable and the user agrees to install it, call vision.install-ocr {"confirm":true}; otherwise continue with pixel diff and visual inspection.\n- Compare the PNG, OCR text evidence, and diff artifacts against the user\'s intent for layout, typography, colors, spacing, imagery, and responsive framing; then iterate with focused mutations.\n- Root CLI equivalent: `webstudio screenshot --path /pricing --output pricing.png` generates a temporary production preview, captures that route, and stops the server. For repeated captures, keep `webstudio preview` running and pass its absolute URL to `webstudio screenshot`.\n\n## List pages\n\nCommands:\n\n- MCP tool: list-pages {}\n- MCP tool: list-folders {}\n\n## Read page by id\n\nCommands:\n\n- MCP tool: get-page {"pageId":"<pageId>"}\n\n## Read page by path\n\nCommands:\n\n- MCP tool: get-page-by-path {"path":"/pricing"}\n\n## Create page\n\nCommands:\n\n- MCP tool: create-page {"name":"Pricing","path":"/pricing"}\n- MCP tool: create-page {"name":"Pricing","path":"/pricing","title":"Pricing","meta":{"description":"Plans for teams"}}\n\nNotes:\n\n- `name`, `path`, page `title`, and metadata text fields accept plain fixed values.\n- For computed page titles or metadata, send JavaScript expression code such as `pageTitle ?? "Pricing"`.\n\n## Update page settings/metadata\n\nCommands:\n\n- MCP tool: update-page {"pageId":"<pageId>","values":{"title":"Pricing","meta":{"description":"Plans","status":200}}}\n- MCP tool: update-page {"pageId":"<pageId>","values":{"meta":{"auth":{"method":"basic","login":"<login>","password":"<password>"}}}}\n\nNotes:\n\n- Page `title` and metadata text fields accept plain fixed values.\n- For computed page titles or metadata, send JavaScript expression code such as `pageTitle ?? "Pricing"`.\n- Page `status` accepts a fixed HTTP status code as a number from 200 through 599 or a JavaScript expression string for a dynamic status.\n\n## Read project settings\n\nCommands:\n\n- MCP tool: get-project-settings {}\n\nNotes:\n\n- Read `meta.agentInstructions` before making project changes. It contains the project\'s own guidance for AI agents.\n- Agent instructions are shared project guidance. Do not store credentials or other secrets there.\n\n## Update project settings\n\nCommands:\n\n- MCP tool: update-project-settings {"meta":{"siteName":"Acme"}}\n- MCP tool: update-project-settings {"meta":{"agentInstructions":"Use existing design tokens and keep product copy concise."}}\n\n## Read marketplace product\n\nCommands:\n\n- MCP tool: get-marketplace-product {}\n\n## Update marketplace product\n\nCommands:\n\n- MCP tool: update-marketplace-product {"category":"pageTemplates","name":"Acme Template","thumbnailAssetId":"asset-id","author":"Acme Studio","email":"hello@example.com","website":"https://example.com","issues":"","description":"Reusable template project for Acme landing pages."}\n\n## List redirects\n\nCommands:\n\n- MCP tool: list-redirects {}\n\n## Create redirect\n\nCommands:\n\n- MCP tool: create-redirect {"old":"/old","new":"/new","status":301}\n\n## Update redirect\n\nCommands:\n\n- MCP tool: update-redirect {"old":"/old","values":{"new":"/newer","status":302}}\n- MCP tool: update-redirect {"old":"/old","values":{"status":null}}\n\n## Delete redirect\n\nCommands:\n\n- MCP tool: delete-redirect {"old":"/old"}\n\n## Set redirects\n\nCommands:\n\n- MCP tool: set-redirects {"redirects":[{"old":"/old","new":"/new","status":"301"}]}\n\n## List breakpoints\n\nCommands:\n\n- MCP tool: list-breakpoints {}\n\n## Create breakpoint\n\nCommands:\n\n- MCP tool: create-breakpoint {"label":"Tablet","maxWidth":991}\n\n## Update breakpoint\n\nCommands:\n\n- MCP tool: update-breakpoint {"breakpointId":"tablet","values":{"label":"Tablet","maxWidth":1023}}\n- MCP tool: update-breakpoint {"breakpointId":"tablet","values":{"condition":null,"minWidth":768}}\n- MCP tool: update-breakpoint {"breakpointId":"tablet","values":{"minWidth":null,"maxWidth":null,"condition":"(hover: hover)"}}\n\n## Delete breakpoint\n\nCommands:\n\n- MCP tool: delete-breakpoint {"breakpointId":"tablet"}\n\n## Duplicate page\n\nCommands:\n\n- MCP tool: duplicate-page {"pageId":"<pageId>","name":"Pricing Copy","path":"/pricing-copy"}\n- MCP tool: duplicate-page {"pageId":"<pageId>","name":"Paris","path":"/paris","substitutions":{"text":{"London":"Paris"},"variables":{"city":{"type":"string","value":"Paris"}}}}\n- webstudio duplicate-page --page <pageId> --name Paris --path /paris --substitutions \'{"text":{"London":"Paris"},"variables":{"city":{"type":"string","value":"Paris"}}}\' --json\n\nNotes:\n\n- Text substitutions replace exact fixed text only in the duplicated page\'s text children, string props, title, and metadata.\n- Variable substitutions are keyed by copied source-variable name and use typed variable values. The operation rejects missing or ambiguous names without committing a partial duplicate.\n- Existing expressions and cloned variable/resource references keep their remapped ids.\n\n## List page templates\n\nCommands:\n\n- MCP tool: list-page-templates {}\n\n## Create page template\n\nCommands:\n\n- MCP tool: create-page-template {"name":"Landing Template","title":"Landing"}\n\n## Update page template\n\nCommands:\n\n- MCP tool: update-page-template {"templateId":"<templateId>","values":{"name":"Article Template","meta":{"description":"Reusable article layout"}}}\n\n## Delete page template\n\nCommands:\n\n- MCP tool: delete-page-template {"templateId":"<templateId>"}\n\n## Duplicate page template\n\nCommands:\n\n- MCP tool: duplicate-page-template {"templateId":"<templateId>"}\n\n## Reorder page template\n\nCommands:\n\n- MCP tool: reorder-page-template {"sourceTemplateId":"<sourceTemplateId>","targetTemplateId":"<targetTemplateId>","position":"before"}\n\n## Create page from template\n\nCommands:\n\n- MCP tool: create-page-from-template {"templateId":"<templateId>","name":"Landing","path":"/landing"}\n\n## Delete page\n\nCommands:\n\n- MCP tool: delete-page {"pageId":"<pageId>"}\n\n## List folders\n\nCommands:\n\n- MCP tool: list-folders {}\n- MCP tool: list-pages {}\n\n## Create folder\n\nCommands:\n\n- MCP tool: create-folder {"name":"Blog","slug":"blog"}\n\n## Update folder\n\nCommands:\n\n- MCP tool: update-folder {"folderId":"<folderId>","values":{"name":"Blog","slug":"blog"}}\n\n## Delete folder\n\nCommands:\n\n- MCP tool: delete-folder {"folderId":"<folderId>"}\n\n## List element instances\n\nCommands:\n\n- MCP tool: list-instances {"pagePath":"/","maxDepth":3}\n\n## Inspect one element instance\n\nCommands:\n\n- MCP tool: inspect-instance {"instanceId":"<instanceId>","include":["props","styles","children"]}\n\n## Insert authored JSX or one component template\n\nCommands:\n\n- MCP tool: insert-fragment {"parentInstanceId":"<instanceId>","fragment":"<ws.element ws:tag=\\"section\\" ws:style={css`padding: 32px;`}><ws.element ws:tag=\\"h2\\">Product OS</ws.element><radix.Switch><radix.SwitchThumb /></radix.Switch></ws.element>"}\n- MCP tool: insert-component {"parentInstanceId":"<instanceId>","component":"@webstudio-is/sdk-components-react-radix:Switch"}\n- MCP tool: insert-component {"parentInstanceId":"<instanceId>","component":"Form"}\n\nNotes:\n\n- Use MCP `insert-fragment` as the default way to author styled component trees. It converts JSX to a structured fragment before mutation.\n- Use only exact component ids returned by `components.search`, `components.get`, or `templates.get`. Never derive or guess component ids.\n- The `ws:` namespace contains specific Webstudio core components; it is not HTML-tag shorthand. Use `<ws.element ws:tag="div">` for a native `div` and `<ws.element ws:tag="form">` for a native form, never `<ws.div>` or `<ws.form>`.\n- For Webstudio\'s complete form structure, discover the Form component and insert its automatic template with `insert-component` using component `"Form"`.\n- MCP receives JSX as a JSON string because MCP arguments are JSON. The CLI converts it locally before the runtime mutation, so the project session receives structured Webstudio data, not JSX source.\n- In `insert-fragment` JSX, use `ws:style={css\\`...\\`}`for Webstudio-native CSS, or use React-style object syntax such as`style={{ padding: 24 }}` when that is simpler. Both forms create editable Webstudio style data.\n- Do not access host globals or dynamic code APIs in JSX fragments, including `process`, `globalThis`, `eval`, `Function`, or `constructor`.\n- Use Webstudio prop names such as `class` and `for`; do not use React aliases `className` or `htmlFor`.\n- Use Webstudio actions for event/action props, for example `onClick={new ActionValue(["event"], expression\\`console.log(event)\\`)}`. Do not pass JavaScript functions such as `onClick={() => ...}`.\n- Plain prop values must be JSON-compatible: `null`, strings, booleans, finite numbers, arrays, and plain objects. Do not pass `undefined`, `Symbol`, `BigInt`, `NaN`, `Infinity`, `Date`, `Map`, `Set`, class instances, or circular objects; omit the prop, use plain data, or use `expression`/`ActionValue` when the value is dynamic.\n- Template-backed components used in JSX must include required child/part components explicitly under the same parent structure as the template, for example `<radix.Switch><radix.SwitchThumb /></radix.Switch>`.\n- Webstudio applies a registered template automatically when using `insert-component`, so composed components such as Switch include required child parts and styles.\n- Use `components.list`, `components.summary`, `components.search`, `components.get`, `templates.list`, and `templates.get` to discover known registry items, component ids, props, templates, insertability, and content model. Read `webstudio://project/components` only when those focused tools are insufficient.\n- Component/template registry items use a shadcn-compatible top-level shape plus Webstudio-specific superset metadata in `meta`. They are for Builder/MCP discovery, not a published shadcn install registry yet.\n- Known components with `contentModel.category: "none"` are not standalone-insertable; insert their root component template instead so required providers/parents are included.\n- Unknown custom component ids are a low-level extension mechanism, not a discovery fallback. Agents must not synthesize them.\n\n## Make a region editable in Content mode\n\nCommands:\n\n- MCP tool: insert-component {"parentInstanceId":"<instanceId>","component":"ws:block"}\n- MCP tool: inspect-instance {"instanceId":"<instanceId>","include":["children"]}\n\nNotes:\n\n- When a page will be handed to a Content-mode editor, wrap every region they should be able to edit in a Content Block (`ws:block`). Content-mode editors can edit text and supported props only in Content Block descendants. Content outside those blocks remains read-only, even when it looks like ordinary editable text.\n- Put reusable insertable options inside the Content Block\'s `ws:block-template` child. A template is source material, not editor content: editors cannot edit or delete it directly. When an editor inserts a template, its copy becomes a direct child of the Content Block and is editable.\n- Before handing off a page, verify with `inspect-instance` that the intended text, images, and links are inside a Content Block, and that templates include all required styling because Content-mode editors cannot use the Style panel.\n\n## Move elements\n\nCommands:\n\n- MCP tool: move-instance {"moves":"moves.json contents"}\n\nNotes:\n\n- Use `position: "end"` to append an instance. Repeating this for A and then B preserves the final order A, B.\n- A numeric `insertIndex` addresses the target parent\'s children before the moved instance is removed. Use it for exact placement; do not calculate the last index to append.\n- Moves in one `moves` array are applied sequentially in array order.\n\n## Clone element subtree\n\nCommands:\n\n- MCP tool: clone-instance {"sourceInstanceId":"<instanceId>","targetParentInstanceId":"<targetParentId>"}\n\n## Delete element subtree\n\nCommands:\n\n- MCP tool: delete-instance {"instanceIds":["<instanceId>"]}\n\n## List text/expression children\n\nCommands:\n\n- MCP tool: list-texts {"pagePath":"/"}\n\n## Update text child\n\nCommands:\n\n- MCP tool: update-text {"instanceId":"<instanceId>","childIndex":0,"text":"Launch faster"}\n\n## Replace bounded literal text\n\nCommands:\n\n- MCP tool: replace-text {"find":"Start free","replace":"Get started","match":"exact","pagePath":"/pricing","limit":20}\n\nNotes:\n\n- This changes only literal text children, never expression children. Scope it to pagePath or pageId and set a limit before a broad replacement.\n\n## Replace bounded static prop text\n\nCommands:\n\n- MCP tool: replace-prop-text {"find":"old.example.com","replace":"www.example.com","match":"substring","names":["href","code"],"limit":20}\n\nNotes:\n\n- This changes only static string props such as href, alt, aria-label, title, and HTML embed code. It never changes expressions, resources, actions, assets, or other dynamic bindings. Use names or instanceIds and a limit to narrow the change.\n\n## Replace bounded resource text\n\nCommands:\n\n- MCP tool: replace-resource-text {"find":"api.old.example.com","replace":"api.example.com","fields":["url"],"limit":20}\n\nNotes:\n\n- This changes resource names and fixed URL literals only. It skips dynamic URL expressions, headers, search parameters, request bodies, and GraphQL query code.\n\n## Update props\n\nCommands:\n\n- MCP tool: update-props {"updates":"props.json contents"}\n- MCP tool: replace-prop-text {"find":"Old label","replace":"New label","names":["aria-label","title"],"limit":20}\n\nNotes:\n\n- Use this for fixed prop values such as `aria-label`, `alt`, `id`, static `href`, and other direct string/number/boolean/json prop values.\n\n## Add JSON-LD structured data\n\nCommands:\n\n- MCP tool: components.get {"component":"JsonLd"}\n- MCP tool: insert-component {"parentInstanceId":"<headSlotInstanceId>","component":"JsonLd"}\n- MCP tool: update-props {"updates":[{"instanceId":"<jsonLdInstanceId>","name":"code","type":"string","value":"{\\"@context\\":\\"https://schema.org\\",\\"@type\\":\\"Organization\\",\\"name\\":\\"Acme\\"}"}]}\n- MCP tool: audit {"scopes":["seo"],"pagePath":"/"}\n\nNotes:\n\n- Prefer placing `JsonLd` inside `HeadSlot`.\n- Store `code` as a JSON object or array encoded as a compact string. The Builder formats it for editing.\n- The semantic prop update rejects malformed JSON and structurally invalid fixed JSON-LD with a precise JSON path.\n- The SEO audit also warns about a missing top-level `@context`, unknown or superseded Schema.org terms, properties unsupported by the supplied type, and incompatible primitive value types.\n- Schema.org vocabulary findings are warnings because custom vocabularies and extensions remain valid. Dynamic JSON-LD is marked as skipped for rendered validation.\n- Do not use bindings just to set static text.\n\n## Delete props\n\nCommands:\n\n- MCP tool: delete-props {"deletions":"props.json contents"}\n\n## Bind props to expressions/resources/actions\n\nCommands:\n\n- MCP tool: bind-props {"bindings":"bindings.json contents"}\n\nNotes:\n\n- Use this only when the prop should remain dynamic: expression, resource, action, or an existing scoped runtime context value such as `system`.\n- For a fixed string value, use `update-props` with `type:"string"` and a direct `value` instead.\n\n## Read styles\n\nCommands:\n\n- MCP tool: get-styles {"instanceIds":["<instanceId>"],"includeTokens":true}\n\n## Update local styles\n\nCommands:\n\n- MCP tool: update-styles {"updates":"styles.json contents"}\n\n## Delete local styles\n\nCommands:\n\n- MCP tool: delete-styles {"deletions":"styles.json contents"}\n\n## Replace matching style values\n\nCommands:\n\n- MCP tool: replace-styles {"property":"color","fromValue":{"type":"keyword","value":"red"},"toValue":{"type":"keyword","value":"blue"}}\n\n## List design tokens\n\nCommands:\n\n- MCP tool: list-design-tokens {}\n- MCP tool: list-design-tokens {"withUsage":true}\n- MCP tool: list-design-tokens {"verbose":true}\n\nNotes:\n\n- The default response is compact and includes token id, name, declaration count, and optional usage count.\n- Use `verbose:true` only when you need the full inline style declarations.\n\n## Create design tokens\n\nCommands:\n\n- MCP tool: create-design-token {"tokens":"tokens.json contents"}\n\n## Update design token styles\n\nCommands:\n\n- MCP tool: update-design-token-styles {"designTokenId":"<tokenId>","updates":"styles.json contents"}\n\n## Delete design token styles\n\nCommands:\n\n- MCP tool: delete-design-token-styles {"designTokenId":"<tokenId>","deletions":"styles.json contents"}\n\n## Attach design token to instances\n\nCommands:\n\n- MCP tool: attach-design-token {"designTokenId":"<tokenId>","instanceIds":"instances.json contents"}\n\n## Detach design token from instances\n\nCommands:\n\n- MCP tool: detach-design-token {"designTokenId":"<tokenId>","instanceIds":"instances.json contents"}\n\n## Extract design token from local styles\n\nCommands:\n\n- MCP tool: extract-design-token {"instanceIds":["<instanceId>"],"name":"Brand Primary","removeLocalProps":["color"]}\n\n## List CSS variables\n\nCommands:\n\n- MCP tool: list-css-variables {"withUsage":true}\n\n## Define CSS variables\n\nCommands:\n\n- MCP tool: define-css-variable {"vars":"vars.json contents"}\n\n## Delete CSS variables\n\nCommands:\n\n- MCP tool: delete-css-variable {"names":"names.json contents","force":true}\n\n## Rewrite CSS variable references\n\nCommands:\n\n- MCP tool: rewrite-css-variable-refs {"map":"variables.json contents"}\n\n## List data variables\n\nCommands:\n\n- MCP tool: list-variables {}\n- MCP tool: list-variables {"scopeInstanceId":"<instanceId>"}\n\nNotes:\n\n- Data variables live in the internal `dataSources` namespace.\n- For raw `snapshot`, request the public `variables` namespace rather than the internal `dataSources` name. Raw patch payloads still use `dataSources` when applying direct changes.\n- Scope variables to the instance where they should become available. Descendants can use them in expressions, and nested variables with the same name mask outer variables.\n\n## Create data variable\n\nCommands:\n\n- MCP tool: create-variable {"scopeInstanceId":"<instanceId>","name":"title","value":{"type":"string","value":"Hello"}}\n- MCP tool: create-variable {"scopeInstanceId":"<instanceId>","name":"count","value":{"type":"number","value":3}}\n- MCP tool: create-variable {"scopeInstanceId":"<instanceId>","name":"featured","value":{"type":"boolean","value":true}}\n- MCP tool: create-variable {"scopeInstanceId":"<instanceId>","name":"tags","value":{"type":"string[]","value":["news","product"]}}\n- MCP tool: create-variable {"scopeInstanceId":"<instanceId>","name":"filters","value":{"type":"json","value":{"tag":"news"}}}\n\nNotes:\n\n- Data variable values support `string`, `number`, `boolean`, `string[]`, and `json`.\n- Parameters are internal scoped runtime values provided by pages, collections, or components. They are not a public authoring surface: do not create, update, or delete parameter records. Use data variables/resources for user-authored data, and reference documented context values such as `system` only where they are already in scope.\n\n## Update data variable\n\nCommands:\n\n- MCP tool: update-variable {"dataSourceId":"<variableId>","values":{"value":{"type":"json","value":{"count":1}}}}\n\n## Delete data variable\n\nCommands:\n\n- MCP tool: delete-variable {"dataSourceId":"<variableId>"}\n\n## List resources\n\nCommands:\n\n- MCP tool: list-resources {}\n- MCP tool: list-resources {"scopeInstanceId":"<instanceId>"}\n\n## Create resource\n\nCommands:\n\n- MCP tool: create-resource {"resource":{"name":"Posts","method":"get","url":"https://api.example.com/posts","headers":[]}}\n- MCP tool: create-resource {"resource":{"name":"Posts","method":"get","url":"\\"https://api.example.com/posts?tag=\\" + filters.tag","headers":[]},"scopeInstanceId":"<instanceId>","dataSourceName":"posts"}\n- MCP tool: create-resource {"resource":{"name":"Filtered Posts","method":"get","url":"https://api.example.com/posts","searchParams":[{"name":"tag","value":"filters.tag"},{"name":"source","value":{"type":"literal","value":"website"}}],"headers":[{"name":"Authorization","value":"\\"Bearer \\" + auth.token"}]},"scopeInstanceId":"<instanceId>","dataSourceName":"posts"}\n- MCP tool: create-resource {"resource":{"name":"Post GraphQL","control":"graphql","method":"post","url":"https://api.example.com/graphql","headers":[{"name":"Content-Type","value":{"type":"literal","value":"application/json"}}],"body":"{ query: \\"query Post($slug: String!) { post(slug: $slug) { title } }\\", variables: { slug: system.params.slug } }"},"scopeInstanceId":"<instanceId>","dataSourceName":"post"}\n- MCP tool: create-resource {"resource":{"name":"Current Date","control":"system","method":"get","url":"/$resources/current-date","headers":[]},"scopeInstanceId":"<instanceId>","dataSourceName":"currentDate"}\n\nNotes:\n\n- Resource `url` accepts plain fixed URLs and paths such as `https://api.example.com/posts` and `/$resources/current-date`.\n- Resource `url` can also be a JavaScript expression when it is computed, such as `"https://api.example.com/posts?tag=" + filters.tag`.\n- Header values, search parameter values, and body accept expressions for dynamic values. For fixed text, use `{"type":"literal","value":"application/json"}`; Webstudio stores the required string expression for you.\n- Search parameter values, header values, and body expressions can read scoped variables and documented runtime context values such as `system` when they are available at the resource scope.\n- Add `scopeInstanceId` and `dataSourceName` when the resource result should be exposed as a scoped read data variable. Scoped resources are generated into the page resource `data` map and may be loaded during page rendering. Use this for read-oriented resources such as GET CMS/API data.\n- For submit/write/action resources, create the resource without `scopeInstanceId`, then bind a component prop such as a Form `action` with `bind-props` and `binding.type: "resource"`. Prop-bound resources are generated into the page resource `action` map instead of the read `data` map. Use this for POST, PUT, DELETE, webhooks, GraphQL submissions, and other explicit action flows.\n- Resource `method` can be `get`, `post`, `put`, or `delete`. Use GET for read data, POST for creates/GraphQL/webhooks/form submissions, PUT for full updates or replacements, and DELETE for deletion actions.\n- Optional `control` values are `graphql` and `system`. Use `graphql` for GraphQL-style requests, usually POST with a query body. Use `system` for built-in resources such as `"/$resources/sitemap.xml"`, `"/$resources/current-date"`, and `"/$resources/assets"` and when the resource should use the built-in `system` parameter. System fields are `system.origin`, `system.pathname`, `system.params`, and `system.search`.\n\n## Update resource\n\nCommands:\n\n- MCP tool: update-resource {"resourceId":"<resourceId>","values":{"url":"https://api.example.com/posts"}}\n- MCP tool: replace-resource-text {"find":"api.old.example.com","replace":"api.example.com","fields":["url"],"limit":20}\n\n## Delete resource\n\nCommands:\n\n- MCP tool: delete-resource {"resourceId":"<resourceId>"}\n\n## List assets\n\nCommands:\n\n- MCP tool: list-assets {"withUsage":true}\n- MCP tool: list-assets {"verbose":true}\n\nNotes:\n\n- Compact results include each asset\'s folder id. Use `verbose:true` to include complete records for a page of assets, or `get-asset` to read one complete record including description, folder, creation time, and image/font metadata.\n- Image asset descriptions are the default alt text for asset-backed Image components.\n- To generate missing descriptions, inspect the image in its rendered page or asset source, write a concise description of its purpose, and save it on the asset rather than duplicating it on each Image instance.\n\n## Get asset\n\nCommands:\n\n- MCP tool: get-asset {"assetId":"<assetId>"}\n\n## List asset folders\n\nCommands:\n\n- MCP tool: list-asset-folders {}\n\n## Create asset folder\n\nCommands:\n\n- MCP tool: create-asset-folder {"name":"Marketing"}\n- MCP tool: create-asset-folder {"name":"Photos","parentId":"<parentFolderId>"}\n\n## Update asset folder\n\nCommands:\n\n- MCP tool: update-asset-folder {"folderId":"<folderId>","values":{"name":"Brand"}}\n- MCP tool: update-asset-folder {"folderId":"<folderId>","values":{"parentId":"<parentFolderId>"}}\n- MCP tool: update-asset-folder {"folderId":"<folderId>","values":{"parentId":null}}\n\nNotes:\n\n- Updating `parentId` is the folder equivalent of cut and paste. Use `null` to move a folder to Root.\n\n## Duplicate asset folder\n\nCommands:\n\n- MCP tool: duplicate-asset-folder {"folderId":"<folderId>"}\n- MCP tool: duplicate-asset-folder {"folderId":"<folderId>","parentId":"<targetFolderId>"}\n\nNotes:\n\n- Duplication recursively copies descendant folders and assets. This is the folder equivalent of copy and paste.\n\n## Delete asset folder\n\nCommands:\n\n- MCP tool: delete-asset-folder {"folderId":"<folderId>"}\n\nNotes:\n\n- Deleting a folder recursively deletes its descendant folders and assets.\n\n## Update asset metadata\n\nCommands:\n\n- MCP tool: update-asset {"assetId":"<assetId>","values":{"description":"Team collaborating around a whiteboard"}}\n\nNotes:\n\n- Use an empty description only when the image is intentionally decorative.\n- Updating an image asset description updates the default alt text wherever that asset is used with an asset-backed alt prop.\n\n## Generate missing image descriptions with an agent\n\nCommands:\n\n- MCP tool: audit {"scopes":["accessibility"],"verbose":true}\n- MCP tool: set-image-descriptions {"updates":[{"assetId":"hero-id","description":"Team collaborating around a whiteboard"},{"assetId":"texture-id","decorative":true}]}\n- MCP tool: audit {"scopes":["accessibility"]}\n\nNotes:\n\n- Start from `missing-image-description` findings. Inspect each image in its rendered page context before writing text.\n- The vision-capable agent generates the wording; the CLI validates and stores it but does not contain its own vision model.\n- Use `decorative:true` only when the image adds no information. This intentionally stores an empty description so later audits do not report it as missing.\n- Re-run the accessibility audit after the update. Asset-backed Image components use the saved asset description as their default alt text.\n\n## Manage fonts\n\nCommands:\n\n- MCP tool: list-fonts {"includeSystem":true}\n- MCP tool: list-assets {"type":"font"}\n- MCP tool: upload-asset {"asset":{"name":"acme-sans.woff2","type":"font","format":"woff2","meta":{"family":"Acme Sans","style":"normal","weight":400}},"assetsDir":".webstudio/assets"}\n- MCP tool: update-styles {"updates":"styles.json contents"}\n\nNotes:\n\n- Use `list-fonts` to discover uploaded families and system stacks. Upload/delete fonts through the existing asset tools, then apply a family with a `font-family` style declaration.\n\n## Upload one asset\n\nCommands:\n\n- MCP tool: upload-asset {"asset":{"name":"image.png","type":"image","format":"png","meta":{"width":1200,"height":630}},"assetsDir":".webstudio/assets"}\n- MCP tool: upload-asset {"asset":{"name":"image.png","type":"image","format":"png","folderId":"<folderId>","meta":{"width":1200,"height":630}},"assetsDir":".webstudio/assets"}\n\n## Upload asset batch\n\nCommands:\n\n- MCP tool: upload-assets {"assets":[{"name":"image.png","type":"image","format":"png","meta":{"width":1200,"height":630}}],"assetsDir":".webstudio/assets"}\n\n## Duplicate asset\n\nCommands:\n\n- MCP tool: duplicate-asset {"assetId":"<assetId>"}\n- MCP tool: duplicate-asset {"assetId":"<assetId>","folderId":"<targetFolderId>"}\n- MCP tool: duplicate-asset {"assetId":"<assetId>","folderId":null}\n\nNotes:\n\n- Duplication is the asset equivalent of copy and paste. Updating `folderId` is the equivalent of cut and paste; use `null` for Root.\n\n## Download asset\n\nCommands:\n\n- MCP tool: download-asset {"assetId":"<assetId>"}\n\n## Find asset usage\n\nCommands:\n\n- MCP tool: find-asset-usage {"assetId":"<assetId>"}\n\n## Replace asset references\n\nCommands:\n\n- MCP tool: replace-asset {"fromAssetId":"<oldAssetId>","toAssetId":"<newAssetId>"}\n\n## Delete assets\n\nCommands:\n\n- MCP tool: delete-asset {"assetIdsOrPrefixes":["<assetId>"],"force":true}\n\n## Publish project\n\nCommands:\n\n- webstudio publish deploy --target production --json\n\n## List publishes\n\nCommands:\n\n- webstudio publish list --json\n\n## Check publish job\n\nCommands:\n\n- webstudio publish status --job <buildId> --json\n\n## Unpublish\n\nCommands:\n\n- webstudio publish unpublish --target production --confirm --json\n\n## List domains\n\nCommands:\n\n- webstudio domains list --json\n\n## Create domain\n\nCommands:\n\n- webstudio domains create --domain example.com --json\n\n## Update domain\n\nCommands:\n\n- webstudio domains update --domain-id <domainId> --domain www.example.com --json\n\n## Delete domain\n\nCommands:\n\n- webstudio domains delete --domain-id <domainId> --confirm --json\n\n## Verify domain\n\nCommands:\n\n- webstudio domains verify --domain-id <domainId> --json\n\n## Make arbitrary store-level changes\n\nCommands:\n\n- MCP tool: inspect {}\n- MCP tool: snapshot {"include":["<namespace>"]}\n- MCP tool: apply-patch {"baseVersion":"<version>","transactions":"patch.json contents"}\n\nNotes:\n\n- Use only when no semantic command exists.\n\n## Manage marketplace metadata\n\nCommands:\n\n- MCP tool: get-marketplace-product {}\n- MCP tool: update-marketplace-product {"category":"pageTemplates","name":"Acme Template","thumbnailAssetId":"asset-id","author":"Acme Studio","email":"hello@example.com","website":"https://example.com","issues":"","description":"Reusable template project for Acme landing pages."}\n\nPatch namespaces:\n\n- marketplaceProduct\n\n## Search and inspect safely\n\nCommands:\n\n- MCP tool: search-project {"query":"pricing"}\n- MCP tool: search-project {"query":"api.example.com","scopes":["resources"]}\n- MCP tool: list-instances {"pagePath":"/","maxDepth":5}\n- MCP tool: inspect-instance {"instanceId":"<instanceId>","include":["props","styles","children"]}\n- MCP tool: list-texts {"pagePath":"/"}\n- MCP tool: list-assets {"withUsage":true}\n- MCP tool: find-asset-usage {"assetId":"<assetId>"}\n- MCP tool: snapshot {"include":["pages","instances","props","resources","assets"]}\n\nNotes:\n\n- Use `search-project` for query-driven lookup across labels, text, prop values, resource URLs, asset metadata, and styles. Use `audit` for project health findings.\n\n## Audit project quality\n\nCommands:\n\n- webstudio audit --json\n- webstudio audit --scopes accessibility --scopes seo --json\n- webstudio audit --page-path /pricing --json\n- webstudio audit --scopes accessibility --verbose --json\n- webstudio audit --rendered --page-path /pricing --json\n- webstudio audit --rendered --route-example post=/blog/hello --json\n- webstudio audit --rendered --image-domain images.example.com --json\n- MCP tool: audit {}\n- MCP tool: audit {"scopes":["accessibility","security"],"severities":["error","warning"]}\n- MCP tool: audit {"scopes":["accessibility"],"verbose":true}\n- MCP tool: audit {"scopes":["craft"],"verbose":true}\n- MCP tool: audit {"rendered":true,"verbose":true}\n\nNotes:\n\n- With no scopes, `audit` checks accessibility, security, SEO, performance settings, unused assets, ineffective Collection styles, non-GET resources exposed as render-time data, and unused or duplicate style data.\n- Craft is opt-in and read-only. Run `audit` with `scopes:["craft"]` to detect whether the project is not using Craft, partially compatible, or compatible with the versioned Craft 1.2 profile. `profileStatuses` includes the University-doc provenance and the smallest safe next action. The audit never installs Craft or changes a non-Craft project.\n- The `performance` scope reports disabled atomic CSS generation. A rendered audit also measures broken, eager below-fold, and oversized images, browser-marked render-blocking resources, and legacy font formats.\n- Rendered image and resource metrics run only when the selected scopes include `performance`; responsive layout dimensions remain available whenever `rendered:true` is requested.\n- Compact findings include stable ids, severity, message, and location. Use `--verbose` or `{"verbose":true}` for evidence, explanation, suggested remediation, skipped-check details, and manual-check workflows.\n- `summary` counts all findings before severity filtering and pagination.\n- `contractVersion` identifies the audit response contract. Handle a new value before assuming existing fields retain the same meaning.\n- Expression-, resource-, and parameter-backed values that cannot be checked reliably appear in `skippedChecks`; they are not treated as passing or failing.\n- Page filters apply to page-owned accessibility, security, and SEO checks. Asset and style usage remain project-wide to avoid false unused findings.\n- Continue paginated results with `cursor`. Restart the audit if the project version changes.\n- Verbose skipped-check and manual-check details are included on the first findings page only; their total counts remain available on every page.\n- `manualChecks` describes responsive, hierarchy, and contrast checks that require preview screenshots and vision.\n- Focused audits return only manual checks relevant to their selected scopes.\n- In a long-lived MCP session, `{"rendered":true}` reuses preview and screenshot\n tools to capture every static page at mobile, desktop, and Builder breakpoint\n edges. Compact output reports rendered check/issue/failure counts; verbose\n output includes screenshot paths and measured layout dimensions.\n- Dynamic route templates are skipped unless `--route-example <pageId>=<path>`\n (or MCP `routeExamples`) supplies a concrete path. The path must not contain\n unresolved `:` or `*` parameters.\n- Plans above 120 captures return a short-lived confirmation token. Review the\n unchanged plan, then rerun with `--confirm-large-run` and\n `--confirmation-token`.\n- Detailed rendered evidence is stored in a versioned manifest under\n `.webstudio/audits`; compact output includes its path and screenshot count.\n- Rendered checks also report broken images, eager images below the fold, and\n image sources more than 2x their rendered dimensions in both axes, including\n Webstudio instance ids and measured dimensions when available.\n- Rendered checks include sanitized Resource Timing evidence and report\n browser-marked render-blocking resources plus legacy `.ttf`, `.otf`, and\n `.woff` fonts without applying a universal transfer-size threshold.\n- Fix findings through semantic mutation commands, then rerun `audit` to confirm their deterministic finding ids disappeared.\n\n## Verify dynamic bindings\n\nCommands:\n\n- webstudio verify-bindings --json\n- MCP tool: verify-bindings {"pagePath":"/pricing"}\n- MCP tool: verify-bindings {"instanceId":"<instanceId>","limit":50}\n\nNotes:\n\n- Statically checks persisted text expressions, expression/action/resource/parameter props, resource expressions, and page metadata.\n- Findings distinguish invalid syntax, unknown or out-of-scope variables, stale internal data-source ids, and missing resource or parameter references.\n- Page and instance filters can be combined when the instance belongs to the selected page. Continue findings with `cursor`.\n- This operation does not resolve rendered values or execute external resources. Preview representative loading, empty, error, and populated states after static findings are fixed.\n\n## Refactor targeted content\n\nCommands:\n\n- MCP tool: list-instances {"pagePath":"/"}\n- MCP tool: list-texts {"pagePath":"/"}\n- MCP tool: update-text {"instanceId":"<instanceId>","childIndex":0,"text":"Launch faster"}\n- MCP tool: replace-text {"find":"Old headline","replace":"New headline","match":"exact","pagePath":"/pricing","limit":20}\n- MCP tool: update-props {"updates":"props.json contents"}\n- MCP tool: update-page {"pageId":"<pageId>","values":{"title":"Pricing","meta":{"description":"Plans"}}}\n- MCP tool: update-resource {"resourceId":"<resourceId>","values":{"url":"https://api.example.com/posts"}}\n- MCP tool: replace-asset {"fromAssetId":"<oldAssetId>","toAssetId":"<newAssetId>"}\n- MCP tool: replace-styles {"property":"color","fromValue":{"type":"keyword","value":"red"},"toValue":{"type":"keyword","value":"blue"}}\n- MCP tool: rewrite-css-variable-refs {"map":"variables.json contents"}\n\nNotes:\n\n- Use focused reads first, then mutate only matching instances, props, metadata, resource URLs, assets, or style references. Use `replace-text` for bounded literal text changes, `replace-prop-text` for bounded static prop text, `replace-resource-text` for fixed resource names/URLs, and `update-text` for one known child or expressions.\n\n## Optimize existing project\n\nCommands:\n\n- MCP tool: list-pages {}\n- MCP tool: list-folders {}\n- MCP tool: update-page {"pageId":"<pageId>","values":{"title":"Pricing","meta":{"description":"Plans"}}}\n- MCP tool: update-props {"updates":"props.json contents"}\n- MCP tool: list-breakpoints {}\n- MCP tool: update-breakpoint {"breakpointId":"tablet","values":{"maxWidth":1023}}\n- MCP tool: get-styles {"instanceIds":["<instanceId>"],"includeTokens":true}\n- MCP tool: update-styles {"updates":"styles.json contents"}\n- MCP tool: attach-design-token {"designTokenId":"<tokenId>","instanceIds":"instances.json contents"}\n- MCP tool: update-project-settings {"meta":{"siteName":"Acme"}}\n\nNotes:\n\n- Use this for SEO metadata, accessibility labels, responsive behavior, token consistency, and project settings.\n\n## Connect external data\n\nCommands:\n\n- MCP tool: create-variable {"scopeInstanceId":"<instanceId>","name":"title","value":{"type":"string","value":"Hello"}}\n- MCP tool: create-variable {"scopeInstanceId":"<instanceId>","name":"tags","value":{"type":"string[]","value":["news","product"]}}\n- MCP tool: create-variable {"scopeInstanceId":"<instanceId>","name":"filters","value":{"type":"json","value":{"tag":"news"}}}\n- MCP tool: create-resource {"resource":{"name":"Posts","method":"get","url":"https://api.example.com/posts","searchParams":[{"name":"tag","value":"filters.tag"},{"name":"source","value":{"type":"literal","value":"website"}}],"headers":[]},"scopeInstanceId":"<instanceId>","dataSourceName":"posts"}\n- MCP tool: create-resource {"resource":{"name":"Post GraphQL","control":"graphql","method":"post","url":"https://api.example.com/graphql","headers":[{"name":"Content-Type","value":{"type":"literal","value":"application/json"}}],"body":"{ query: \\"query Post($slug: String!) { post(slug: $slug) { title } }\\", variables: { slug: system.params.slug } }"},"scopeInstanceId":"<instanceId>","dataSourceName":"post"}\n- MCP tool: create-resource {"resource":{"name":"Current Date","control":"system","method":"get","url":"/$resources/current-date","headers":[]},"scopeInstanceId":"<instanceId>","dataSourceName":"currentDate"}\n- MCP tool: update-resource {"resourceId":"<resourceId>","values":{"url":"https://api.example.com/posts"}}\n- MCP tool: bind-props {"bindings":"bindings.json contents"}\n- MCP tool: insert-fragment {"parentInstanceId":"<instanceId>","fragment":"<ws.collection>{/_ collection content _/}</ws.collection>"}\n\nNotes:\n\n- Use this for CMS sections, blog listings, Ghost/headless CMS pages, n8n-style integrations, and API URLs built from variables.\n- For read data, expose GET resources as scoped data variables with `scopeInstanceId`/`dataSourceName` and read the loaded result from the resource result wrapper, usually `.data`.\n- For writes, webhooks, GraphQL submissions, and deletes, prefer unscoped resources bound to Form `action` props so they become action resources instead of auto-loaded read resources.\n- Use direct props for fixed values and prop bindings only when a prop must read a data variable, resource, action, or documented runtime context value such as `system`.\n\n## Render an array or object as repeated content\n\nCommands:\n\n- MCP tool: insert-collection {"parentInstanceId":"<instanceId>","data":{"type":"expression","value":"posts.data.items"},"itemFragment":"<ws.element ws:tag=\\"article\\"><ws.element ws:tag=\\"h2\\">{expression`collectionItem.title`}</ws.element></ws.element>"}\n- MCP tool: inspect-instance {"instanceId":"<collectionId>","include":["props","bindings","children"]}\n\nNotes:\n\n- Use Collection whenever an array or object from a resource or data variable should render a list, grid, cards, table rows, options, tabs, or other repeated UI.\n- Pass `insert-collection` the complete array or object. Do not pass the resource response wrapper or one indexed item. External resource arrays are commonly nested under the scoped resource result\'s `data` field or deeper.\n- Pass one repeated-item Webstudio JSX root. The command creates the Collection, its private current-item/current-key parameters, the iterable binding, and descendant item bindings atomically.\n- Collection renders the item root once for every entry. Use `expression` values such as `collectionItem.title` in descendant text and props. Object iteration also exposes `collectionItemKey`.\n- Wrap multiple repeated sibling instances in one Element inside Collection.\n- For repeated Radix items such as accordion items, tabs, or menu options, bind a stable unique id or slug to every required `value` prop.\n- See the [Collection documentation](https://docs.webstudio.is/university/core-components/collection) for the equivalent Builder workflow.\n\n## Support dynamic runtime behavior\n\nCommands:\n\n- MCP tool: integrate-runtime-ui {"parentInstanceId":"<instanceId>","resources":[{"resource":{"name":"Seats","method":"get","url":"https://api.example.com/seats","headers":[]},"dataSourceName":"Seats","exposeAsDataSource":true}],"structure":{"type":"collection","data":{"type":"expression","value":"Seats.data"},"itemFragment":{"children":[{"type":"id","value":"seat"}],"instances":[{"type":"instance","id":"seat","component":"Text","children":[{"type":"expression","value":"collectionItem.label"}]}],"props":[],"dataSources":[],"resources":[],"styleSources":[],"styleSourceSelections":[],"styles":[],"breakpoints":[],"assets":[]}},"retainedBehavior":[{"instanceId":"<scriptInstanceId>","responsibility":"Seat selection behavior"}]}\n- MCP tool: update-props {"updates":"props.json contents"}\n- MCP tool: bind-props {"bindings":"bindings.json contents"}\n- MCP tool: create-resource {"resource":{"name":"Seats","method":"get","url":"https://api.example.com/seats","headers":[]}}\n- MCP tool: snapshot {"include":["instances","props","resources"]}\n- MCP tool: apply-patch {"baseVersion":"<version>","transactions":"patch.json contents"}\n\nNotes:\n\n- Use `integrate-runtime-ui` to create variables/resources, insert one editable fragment or Collection, and add safe data bindings in one transaction.\n- List existing script-owned responsibilities under `retainedBehavior`. The operation preserves those instances and never evaluates or accepts replacement script bodies.\n- `unsupportedConversions` records behavior that cannot be represented safely. Dry-run returns the complete transaction and the same retained/unsupported report without changing the project.\n- New actions and HtmlEmbed scripts are intentionally rejected. Create normal editable components and data bindings; keep opaque runtime behavior in existing script instances.\n\n## Build authenticated pages\n\nCommands:\n\n- MCP tool: meta.guide {"brief":"Build a Supabase-authenticated account page"}\n- MCP tool: create-page {"name":"Account","path":"/account"}\n- MCP tool: update-page {"pageId":"<pageId>","values":{"meta":{"auth":{"method":"basic","login":"<login>","password":"<password>"}}}}\n- MCP tool: create-resource {"resource":{"name":"Session","method":"get","url":"https://api.example.com/session","headers":[]}}\n- MCP tool: create-variable {"scopeInstanceId":"<instanceId>","name":"user","value":{"type":"json","value":{}}}\n- MCP tool: update-props {"updates":"props.json contents"}\n- MCP tool: bind-props {"bindings":"bindings.json contents"}\n\nNotes:\n\n- Inspect and reuse the project\'s existing auth convention before authoring. Do\n not add a second provider or session model implicitly.\n- Model signed-out, loading, signed-in, and failed-auth states explicitly.\n- Never store credentials, service-role keys, refresh tokens, private session\n values, or authenticated response bodies in project data, command output,\n screenshots, agent instructions, or error reports. Privileged provider calls\n and authorization enforcement belong server-side.\n- Basic auth is semantic today. Provider-specific Supabase/Firebase setup still\n uses the existing resource, variable, prop, binding, and embed tools; there is\n no provider-specific installer.\n\n## Generate from design input\n\nCommands:\n\n- MCP tool: meta.guide {"brief":"Recreate this Figma design as a responsive page"}\n- MCP tool: create-page {"name":"Landing","path":"/landing"}\n- MCP tool: create-design-token {"tokens":"tokens.json contents"}\n- MCP tool: define-css-variable {"vars":"vars.json contents"}\n- MCP tool: list-breakpoints {}\n- MCP tool: insert-fragment {"parentInstanceId":"<instanceId>","fragment":"<ws.element ws:tag=\\"section\\"><ws.element ws:tag=\\"p\\">Section copy</ws.element></ws.element>"}\n- MCP tool: update-styles {"updates":[{"instanceId":"<instanceId>","breakpointId":"<breakpointId-from-list-breakpoints>","property":"padding-left","value":{"type":"unit","unit":"px","value":24}}]}\n- MCP tool: preview.start {"host":"127.0.0.1","port":5173}\n- MCP tool: screenshot {"path":"/landing","output":"landing-desktop.png","viewport":{"width":1440,"height":900},"waitUntil":"load","waitForTimeout":250}\n- MCP tool: screenshot {"path":"/landing","output":"landing-mobile.png","viewport":{"width":390,"height":844},"waitUntil":"load","waitForTimeout":250}\n- MCP tool: screenshot {"baseUrl":"http://127.0.0.1:5177","path":"/landing","output":"landing-desktop.png","viewport":{"width":1440,"height":900},"waitUntil":"load","waitForTimeout":250}\n\nNotes:\n\n- Use this after the agent can inspect the supplied design. There is no direct\n Figma, screenshot, Inception, or `design.md` import command.\n- Inspect and reuse existing variables, tokens, styles, components, assets, and\n page patterns before authoring. Build semantic editable structure rather than\n flattening the design into an image or absolute-positioned approximation.\n- Verify one familiar viewport inside every distinct Builder breakpoint range,\n then run rendered audit and inspect the screenshots before completion.\n\n## Cross-project maintenance\n\nCommands:\n\n- webstudio mcp run .temp/projects.json\n- webstudio mcp run .temp/projects.json --dry-run\n- webstudio mcp run .temp/projects.json --approve-mutations --concurrency 2\n\nNotes:\n\n- Put shared `calls` and a `projects` array of independently linked project roots in the existing `mcp run` manifest. Project roots are relative to the manifest file.\n- Each project uses its own config, authentication, ProjectSession storage, checkpoint, and failure boundary. Confirmed successful calls are checkpointed. Reads can resume automatically; a mutation interrupted after dispatch is reported as ambiguous and is not replayed automatically, preventing silent duplicate writes.\n- Focus the manifest on bounded reads or audits first. Use per-call `dryRun`, global `--dry-run`, or explicitly approve committed mutations with `--approve-mutations` after reviewing the manifest.\n\n# Known CLI Gaps\n\n## Provider-specific authenticated pages\n\nMissing:\nCLI supports page basic auth and generic resources/props/embeds, but not guided Supabase/Firebase auth setup.\n\nCurrent fallback:\nCall `meta.guide` with the provider-authenticated page goal, then create the\npage, resources, variables, props, bindings, and embeds with existing semantic\ntools.\n\nSuggested commands:\n\n- setup-auth-page\n\n## Generate from design input\n\nMissing:\nNo command imports Figma, screenshots, Inception output, or design.md and turns it into pages/tokens/layout.\n\nCurrent fallback:\nCall `meta.guide` with the design-input goal, let the agent inspect the supplied\ndesign, then use semantic page, token, asset, fragment, style, preview,\nscreenshot, and audit tools. Use `apply-patch` only when no semantic operation\nfits.\n\nSuggested commands:\n\n- generate-from-design\n\n## Built-in cross-project maintenance\n\nMissing:\nPublic API and CLI intentionally operate on one configured project at a time; there is no built-in multi-project discovery or loop runner.\n\nCurrent fallback:\nRun the CLI from an external script that reconfigures one project/session at a time.\n\nSuggested commands:\n\n- none\n',
|
|
230243
|
+
"api-use-cases": '# CLI API Use Cases\n\n## Link/configure one project\n\nCommands:\n\n- webstudio init --link <api-share-link> --json\n\nNotes:\n\n- Writes local project id and global origin/token config.\n\n## Import synced project bundle into another project\n\nCommands:\n\n- webstudio sync\n- webstudio import --to <destination-share-link>\n- MCP tool: import {"to":"<destination-share-link>"}\n\nNotes:\n\n- Imports local `.webstudio/data.json` into the destination project.\n- Destination share link must allow build/import access.\n- Use `--skip-assets` only when asset rows and files should not be imported.\n\n## Identify current token\n\nCommands:\n\n- MCP tool: whoami {}\n\n## Check token permissions\n\nCommands:\n\n- webstudio permissions --json\n\n## Inspect project/build/version\n\nCommands:\n\n- MCP tool: inspect {}\n- MCP tool: snapshot {"include":["pages","instances","styles"]}\n\n## Discover CLI/API capabilities\n\nCommands:\n\n- webstudio schema api\n- webstudio schema mcp\n- webstudio man --json\n- webstudio man llm --json\n- MCP tool: meta.index {}\n- MCP tool: meta.guide {"brief":"Create a pricing page"}\n- MCP tool: meta.get_more_tools {"brief":"update-styles"}\n- webstudio mcp list-resources\n- webstudio mcp read-resource webstudio://project/guide\n- webstudio mcp read-resource webstudio://project/expressions\n\nNotes:\n\n- Use `webstudio schema mcp` for a compact machine-readable MCP tool overview. Add `--verbose` or use focused `meta.get_more_tools` calls only when exact input schemas are needed.\n- Use focused MCP tools for discovery first: `meta.index`, `meta.guide`, `meta.get_more_tools`, `components.list`, `components.summary`, `components.search`, `components.get`, `templates.list`, and `templates.get`. Protocol clients can use `resources/list` and `resources/read`; shell agents can use `webstudio mcp list-resources` and `webstudio mcp read-resource <uri>`. Read longer resources such as `webstudio://project/tools` and `webstudio://project/components` only when focused tools are insufficient.\n- `components.summary` returns counts by default; request `{"detail":"components","limit":20}` for paginated entries. Registry list tools return compact metadata, while `components.get` and `templates.get` return focused full details.\n- Read `webstudio://project/expressions` before authoring unfamiliar computed text, prop bindings, resource expressions, actions, or Collection item bindings.\n- From a shell, call one MCP tool with the shortcut form `webstudio <tool> \'<json>\'`, for example `webstudio components.summary`. The explicit equivalent is `webstudio mcp single-op-call <tool> \'<json>\'`. Use `--input-file` for large payloads.\n\n## Inspect external shadcn registry items\n\nCommands:\n\n- webstudio registry inspect --source https://example.com/r/registry.json --item button --json\n- webstudio registry inspect --source ./registry.json --item dialog --json\n- webstudio registry inspect --source https://example.com/r/button.json --json\n\nNotes:\n\n- Reads a local or remote registry item without installing files or changing the configured Webstudio project.\n- Returns the item name, description, package and registry dependencies, file paths/targets, available docs, and a read-only compatibility report.\n- The report explicitly says whether installation or editable-component conversion is supported, lists declared requirements and manual steps, and says when arbitrary source code was not analyzed.\n- This is an inspection step only. It does not install files or change the configured project.\n\n## Understand what MCP can do\n\nCommands:\n\n- webstudio man mcp\n- MCP tool: meta.index {}\n- MCP tool: meta.guide {"brief":"What can Webstudio MCP do?"}\n\nMCP lets agents work on one configured Webstudio project. Agents can:\n\n- Inspect the linked project, token permissions, and latest editable build.\n- Read selected project data for audits, migrations, and repair.\n- Search labels, text, props, resource URLs, asset metadata, and styles.\n- Audit accessibility, security, SEO, performance settings, unused assets, ineffective Collection styles, and unused or duplicate style data.\n- Create and edit pages, folders, redirects, breakpoints, and page templates.\n- Create pages from reusable templates.\n- Update page metadata, SEO fields, auth settings, and marketplace metadata.\n- Insert components and styled JSX sections.\n- Create data-driven lists, grids, cards, and similar repeated UI from array or object data in one Collection operation.\n- Move, copy, wrap, unwrap, convert, rename, retag, and delete elements.\n- Update text, rich text, props, bindings, and actions.\n- Create and update local styles, design tokens, style sources, and CSS variables.\n- Create static data variables and JSON variables.\n- Create HTTP, GraphQL, and system resources.\n- Use system resources for sitemap, current date, and assets.\n- Bind resources to rendered data or form/action props.\n- Manage nested asset folders and upload, inspect, move, duplicate, download, replace, delete, and inspect usage for assets.\n- Publish, unpublish, inspect publish jobs, and manage custom domains.\n- Start preview, capture screenshots, compare screenshot diffs, and use OCR when installed.\n\n## Inspect and refresh MCP session cache\n\nCommands:\n\n- MCP tool: status {}\n- MCP tool: status {"verbose":true}\n- MCP tool: refresh {"namespaces":["pages","instances","styles"]}\n- MCP tool: reset-session {}\n\nNotes:\n\n- Use status before a task to understand the cached ProjectSession state.\n- Use status with `{"verbose":true}` only when debugging full namespaces, freshness, compatibility, or diagnostics.\n- Use refresh when project data may have changed outside the current MCP session.\n- Use reset-session when local cached state is corrupt or incompatible.\n\n## Visually verify rendered work with AI vision\n\nCommands:\n\n- MCP tool: preview.start {"host":"127.0.0.1","port":5173}\n- MCP tool: preview.status {}\n- MCP tool: preview.stop {}\n- MCP tool: screenshot {"path":"/","output":".webstudio/screenshots/home-current.png","viewport":{"width":1440,"height":900},"waitUntil":"load","waitForTimeout":250}\n- MCP tool: screenshot {"path":"/pricing","output":".webstudio/screenshots/pricing-current.png","viewport":{"width":1440,"height":900},"waitUntil":"load","waitForTimeout":250}\n- MCP tool: screenshot {"baseUrl":"http://127.0.0.1:5177","path":"/pricing","output":".webstudio/screenshots/pricing-current.png","viewport":{"width":1440,"height":900},"waitUntil":"load","waitForTimeout":250}\n- MCP tool: screenshot.diff {"baselinePath":".webstudio/screenshots/home-before.png","currentPath":".webstudio/screenshots/home-current.png","outputDir":".webstudio/screenshots/diff"}\n- MCP tool: screenshot.diff {"baselinePath":".webstudio/screenshots/home-before.png","currentPath":".webstudio/screenshots/home-current.png","outputDir":".webstudio/screenshots/diff","expectedText":["Pricing","Start free"]}\n- MCP tool: screenshot.diff {"baselinePath":".webstudio/screenshots/home-before.png","currentPath":".webstudio/screenshots/home-current.png","outputDir":".webstudio/screenshots/diff","expectedVisual":{"maxMismatchPercentage":2,"maxChangedRegions":3,"dominantColorChange":{"channel":"luminance","direction":"increase","minMagnitude":10}}}\n- MCP tool: screenshot.diff {"baselinePath":".webstudio/screenshots/pricing-before.png","currentPath":".webstudio/screenshots/pricing-current.png","outputDir":".webstudio/screenshots/diff"}\n- MCP tool: vision.install-ocr {"confirm":true}\n\nNotes:\n\n- Use this after page/content/style mutations so a vision-capable AI can see the generated site from the current MCP session. Use `path`; never pass a Webstudio Builder/share URL or capture Builder chrome.\n- For multi-page work, capture every changed page by `path` through the same preview server; no click navigation is required.\n- Iterative mode is the default: after MCP mutations, path screenshots ensure generated project files are current, wait for the exact session version, and perform an ordinary page reload without Vite HMR. The preview server and browser stay alive. Use `{"mode":"production"}` only for release-like verification; rendered audit does this automatically.\n- Do not call `preview.start` through one-shot `webstudio mcp single-op-call`: it is long-lived. From a shell, use `webstudio mcp run` with preview.start, screenshot, and preview.stop in one shared process, or use a real long-running MCP client.\n- From one-shot shell calls or another process, pass `baseUrl` with `path` to capture an already-running preview/site without generating, building, starting, or restarting preview.\n- Use preview.stop only in the same long-running MCP server or `webstudio mcp run` process that started preview. A separate one-shot `single-op-call` process does not own another process\'s preview controller.\n- Use waitForSelector when the rendered app has a reliable ready marker, waitUntil:"networkidle" for network-heavy pages, and waitForTimeout only for final visual settling.\n- Preview installs generated app dependencies under `.webstudio/preview` and reuses them across regenerations.\n- Do not add generated-preview dependencies to the repository root `package.json` or `pnpm-lock.yaml`.\n- If dependency installation fails, check npm and network configuration, then reinstall or update the Webstudio CLI if the problem persists.\n- When a baseline exists, use screenshot.diff once per baseline/current page or viewport pair to get changed regions, OCR textAnalysis, and diff artifact paths before deciding whether the result matches. Pass expectedText for explicit pass/fail current-screen text assertions with found and missing text. Pass expectedVisual for pass/fail limits on pixel mismatch percentage, changed-region count, or the overall dominant color/brightness direction.\n- If screenshot.diff reports OCR unavailable and the user agrees to install it, call vision.install-ocr {"confirm":true}; otherwise continue with pixel diff and visual inspection.\n- Compare the PNG, OCR text evidence, and diff artifacts against the user\'s intent for layout, typography, colors, spacing, imagery, and responsive framing; then iterate with focused mutations.\n- Root CLI equivalent: `webstudio screenshot --path /pricing --output pricing.png` generates a temporary production preview, captures that route, and stops the server. For repeated captures, keep `webstudio preview` running and pass its absolute URL to `webstudio screenshot`.\n\n## List pages\n\nCommands:\n\n- MCP tool: list-pages {}\n- MCP tool: list-folders {}\n\n## Read page by id\n\nCommands:\n\n- MCP tool: get-page {"pageId":"<pageId>"}\n\n## Read page by path\n\nCommands:\n\n- MCP tool: get-page-by-path {"path":"/pricing"}\n\n## Create page\n\nCommands:\n\n- MCP tool: create-page {"name":"Pricing","path":"/pricing"}\n- MCP tool: create-page {"name":"Pricing","path":"/pricing","title":"Pricing","meta":{"description":"Plans for teams"}}\n\nNotes:\n\n- `name`, `path`, page `title`, and metadata text fields accept plain fixed values.\n- For computed page titles or metadata, send JavaScript expression code such as `pageTitle ?? "Pricing"`.\n\n## Update page settings/metadata\n\nCommands:\n\n- MCP tool: update-page {"pageId":"<pageId>","values":{"title":"Pricing","meta":{"description":"Plans","status":200}}}\n- MCP tool: update-page {"pageId":"<pageId>","values":{"meta":{"auth":{"method":"basic","login":"<login>","password":"<password>"}}}}\n\nNotes:\n\n- Page `title` and metadata text fields accept plain fixed values.\n- For computed page titles or metadata, send JavaScript expression code such as `pageTitle ?? "Pricing"`.\n- Page `status` accepts a fixed HTTP status code as a number from 200 through 599 or a JavaScript expression string for a dynamic status.\n\n## Read project settings\n\nCommands:\n\n- MCP tool: get-project-settings {}\n\nNotes:\n\n- Read `meta.agentInstructions` before making project changes. It contains the project\'s own guidance for AI agents.\n- Agent instructions are shared project guidance. Do not store credentials or other secrets there.\n\n## Update project settings\n\nCommands:\n\n- MCP tool: update-project-settings {"meta":{"siteName":"Acme"}}\n- MCP tool: update-project-settings {"meta":{"agentInstructions":"Use existing design tokens and keep product copy concise."}}\n\n## Read marketplace product\n\nCommands:\n\n- MCP tool: get-marketplace-product {}\n\n## Update marketplace product\n\nCommands:\n\n- MCP tool: update-marketplace-product {"category":"pageTemplates","name":"Acme Template","thumbnailAssetId":"asset-id","author":"Acme Studio","email":"hello@example.com","website":"https://example.com","issues":"","description":"Reusable template project for Acme landing pages."}\n\n## List redirects\n\nCommands:\n\n- MCP tool: list-redirects {}\n\n## Create redirect\n\nCommands:\n\n- MCP tool: create-redirect {"old":"/old","new":"/new","status":301}\n\n## Update redirect\n\nCommands:\n\n- MCP tool: update-redirect {"old":"/old","values":{"new":"/newer","status":302}}\n- MCP tool: update-redirect {"old":"/old","values":{"status":null}}\n\n## Delete redirect\n\nCommands:\n\n- MCP tool: delete-redirect {"old":"/old"}\n\n## Set redirects\n\nCommands:\n\n- MCP tool: set-redirects {"redirects":[{"old":"/old","new":"/new","status":"301"}]}\n\n## List breakpoints\n\nCommands:\n\n- MCP tool: list-breakpoints {}\n\n## Create breakpoint\n\nCommands:\n\n- MCP tool: create-breakpoint {"label":"Tablet","maxWidth":991}\n\n## Update breakpoint\n\nCommands:\n\n- MCP tool: update-breakpoint {"breakpointId":"tablet","values":{"label":"Tablet","maxWidth":1023}}\n- MCP tool: update-breakpoint {"breakpointId":"tablet","values":{"condition":null,"minWidth":768}}\n- MCP tool: update-breakpoint {"breakpointId":"tablet","values":{"minWidth":null,"maxWidth":null,"condition":"(hover: hover)"}}\n\n## Delete breakpoint\n\nCommands:\n\n- MCP tool: delete-breakpoint {"breakpointId":"tablet"}\n\n## Duplicate page\n\nCommands:\n\n- MCP tool: duplicate-page {"pageId":"<pageId>","name":"Pricing Copy","path":"/pricing-copy"}\n- MCP tool: duplicate-page {"pageId":"<pageId>","name":"Paris","path":"/paris","substitutions":{"text":{"London":"Paris"},"variables":{"city":{"type":"string","value":"Paris"}}}}\n- webstudio duplicate-page --page <pageId> --name Paris --path /paris --substitutions \'{"text":{"London":"Paris"},"variables":{"city":{"type":"string","value":"Paris"}}}\' --json\n\nNotes:\n\n- Text substitutions replace exact fixed text only in the duplicated page\'s text children, string props, title, and metadata.\n- Variable substitutions are keyed by copied source-variable name and use typed variable values. The operation rejects missing or ambiguous names without committing a partial duplicate.\n- Existing expressions and cloned variable/resource references keep their remapped ids.\n\n## List page templates\n\nCommands:\n\n- MCP tool: list-page-templates {}\n\n## Create page template\n\nCommands:\n\n- MCP tool: create-page-template {"name":"Landing Template","title":"Landing"}\n\n## Update page template\n\nCommands:\n\n- MCP tool: update-page-template {"templateId":"<templateId>","values":{"name":"Article Template","meta":{"description":"Reusable article layout"}}}\n\n## Delete page template\n\nCommands:\n\n- MCP tool: delete-page-template {"templateId":"<templateId>"}\n\n## Duplicate page template\n\nCommands:\n\n- MCP tool: duplicate-page-template {"templateId":"<templateId>"}\n\n## Reorder page template\n\nCommands:\n\n- MCP tool: reorder-page-template {"sourceTemplateId":"<sourceTemplateId>","targetTemplateId":"<targetTemplateId>","position":"before"}\n\n## Create page from template\n\nCommands:\n\n- MCP tool: create-page-from-template {"templateId":"<templateId>","name":"Landing","path":"/landing"}\n\n## Delete page\n\nCommands:\n\n- MCP tool: delete-page {"pageId":"<pageId>"}\n\n## List folders\n\nCommands:\n\n- MCP tool: list-folders {}\n- MCP tool: list-pages {}\n\n## Create folder\n\nCommands:\n\n- MCP tool: create-folder {"name":"Blog","slug":"blog"}\n\n## Update folder\n\nCommands:\n\n- MCP tool: update-folder {"folderId":"<folderId>","values":{"name":"Blog","slug":"blog"}}\n\n## Delete folder\n\nCommands:\n\n- MCP tool: delete-folder {"folderId":"<folderId>"}\n\n## List element instances\n\nCommands:\n\n- MCP tool: list-instances {"pagePath":"/","maxDepth":3}\n\n## Inspect one element instance\n\nCommands:\n\n- MCP tool: inspect-instance {"instanceId":"<instanceId>","include":["props","styles","children"]}\n\n## Insert authored JSX or one component template\n\nCommands:\n\n- MCP tool: insert-fragment {"parentInstanceId":"<instanceId>","fragment":"<ws.element ws:tag=\\"section\\" ws:style={css`padding: 32px;`}><ws.element ws:tag=\\"h2\\">Product OS</ws.element><radix.Switch><radix.SwitchThumb /></radix.Switch></ws.element>"}\n- MCP tool: insert-component {"parentInstanceId":"<instanceId>","component":"@webstudio-is/sdk-components-react-radix:Switch"}\n- MCP tool: insert-component {"parentInstanceId":"<instanceId>","component":"Form"}\n\nNotes:\n\n- Use MCP `insert-fragment` as the default way to author styled component trees. It converts JSX to a structured fragment before mutation.\n- Use only exact component ids returned by `components.search`, `components.get`, or `templates.get`. Never derive or guess component ids.\n- The `ws:` namespace contains specific Webstudio core components; it is not HTML-tag shorthand. Use `<ws.element ws:tag="div">` for a native `div` and `<ws.element ws:tag="form">` for a native form, never `<ws.div>` or `<ws.form>`.\n- For Webstudio\'s complete form structure, discover the Form component and insert its automatic template with `insert-component` using component `"Form"`.\n- MCP receives JSX as a JSON string because MCP arguments are JSON. The CLI converts it locally before the runtime mutation, so the project session receives structured Webstudio data, not JSX source.\n- In `insert-fragment` JSX, use `ws:style={css\\`...\\`}`for Webstudio-native CSS, or use React-style object syntax such as`style={{ padding: 24 }}` when that is simpler. Both forms create editable Webstudio style data.\n- Do not access host globals or dynamic code APIs in JSX fragments, including `process`, `globalThis`, `eval`, `Function`, or `constructor`.\n- Use Webstudio prop names such as `class` and `for`; do not use React aliases `className` or `htmlFor`.\n- Use Webstudio actions for event/action props, for example `onClick={new ActionValue(["event"], expression\\`console.log(event)\\`)}`. Do not pass JavaScript functions such as `onClick={() => ...}`.\n- Plain prop values must be JSON-compatible: `null`, strings, booleans, finite numbers, arrays, and plain objects. Do not pass `undefined`, `Symbol`, `BigInt`, `NaN`, `Infinity`, `Date`, `Map`, `Set`, class instances, or circular objects; omit the prop, use plain data, or use `expression`/`ActionValue` when the value is dynamic.\n- Template-backed components used in JSX must include required child/part components explicitly under the same parent structure as the template, for example `<radix.Switch><radix.SwitchThumb /></radix.Switch>`.\n- Webstudio applies a registered template automatically when using `insert-component`, so composed components such as Switch include required child parts and styles.\n- Use `components.list`, `components.summary`, `components.search`, `components.get`, `templates.list`, and `templates.get` to discover known registry items, component ids, props, templates, insertability, and content model. Read `webstudio://project/components` only when those focused tools are insufficient.\n- Component/template registry items use a shadcn-compatible top-level shape plus Webstudio-specific superset metadata in `meta`. They are for Builder/MCP discovery, not a published shadcn install registry yet.\n- Known components with `contentModel.category: "none"` are not standalone-insertable; insert their root component template instead so required providers/parents are included.\n- Unknown custom component ids are a low-level extension mechanism, not a discovery fallback. Agents must not synthesize them.\n\n## Make a region editable in Content mode\n\nCommands:\n\n- MCP tool: insert-component {"parentInstanceId":"<instanceId>","component":"ws:block"}\n- MCP tool: inspect-instance {"instanceId":"<instanceId>","include":["children"]}\n\nNotes:\n\n- When a page will be handed to a Content-mode editor, wrap every region they should be able to edit in a Content Block (`ws:block`). Content-mode editors can edit text and supported props only in Content Block descendants. Content outside those blocks remains read-only, even when it looks like ordinary editable text.\n- Put reusable insertable options inside the Content Block\'s `ws:block-template` child. A template is source material, not editor content: editors cannot edit or delete it directly. When an editor inserts a template, its copy becomes a direct child of the Content Block and is editable.\n- Before handing off a page, verify with `inspect-instance` that the intended text, images, and links are inside a Content Block, and that templates include all required styling because Content-mode editors cannot use the Style panel.\n\n## Move elements\n\nCommands:\n\n- MCP tool: move-instance {"moves":"moves.json contents"}\n\nNotes:\n\n- Use `position: "end"` to append an instance. Repeating this for A and then B preserves the final order A, B.\n- A numeric `insertIndex` addresses the target parent\'s children before the moved instance is removed. Use it for exact placement; do not calculate the last index to append.\n- Moves in one `moves` array are applied sequentially in array order.\n\n## Clone element subtree\n\nCommands:\n\n- MCP tool: clone-instance {"sourceInstanceId":"<instanceId>","targetParentInstanceId":"<targetParentId>"}\n\n## Delete element subtree\n\nCommands:\n\n- MCP tool: delete-instance {"instanceIds":["<instanceId>"]}\n\n## List text/expression children\n\nCommands:\n\n- MCP tool: list-texts {"pagePath":"/"}\n\n## Update text child\n\nCommands:\n\n- MCP tool: update-text {"instanceId":"<instanceId>","childIndex":0,"text":"Launch faster"}\n\n## Replace bounded literal text\n\nCommands:\n\n- MCP tool: replace-text {"find":"Start free","replace":"Get started","match":"exact","pagePath":"/pricing","limit":20}\n\nNotes:\n\n- This changes only literal text children, never expression children. Scope it to pagePath or pageId and set a limit before a broad replacement.\n\n## Replace bounded static prop text\n\nCommands:\n\n- MCP tool: replace-prop-text {"find":"old.example.com","replace":"www.example.com","match":"substring","names":["href","code"],"limit":20}\n\nNotes:\n\n- This changes only static string props such as href, alt, aria-label, title, and HTML embed code. It never changes expressions, resources, actions, assets, or other dynamic bindings. Use names or instanceIds and a limit to narrow the change.\n\n## Replace bounded resource text\n\nCommands:\n\n- MCP tool: replace-resource-text {"find":"api.old.example.com","replace":"api.example.com","fields":["url"],"limit":20}\n\nNotes:\n\n- This changes resource names and fixed URL literals only. It skips dynamic URL expressions, headers, search parameters, request bodies, and GraphQL query code.\n\n## Update props\n\nCommands:\n\n- MCP tool: update-props {"updates":"props.json contents"}\n- MCP tool: replace-prop-text {"find":"Old label","replace":"New label","names":["aria-label","title"],"limit":20}\n\nNotes:\n\n- Use this for fixed prop values such as `aria-label`, `alt`, `id`, static `href`, and other direct string/number/boolean/json prop values.\n\n## Add JSON-LD structured data\n\nCommands:\n\n- MCP tool: components.get {"component":"JsonLd"}\n- MCP tool: insert-component {"parentInstanceId":"<headSlotInstanceId>","component":"JsonLd"}\n- MCP tool: update-props {"updates":[{"instanceId":"<jsonLdInstanceId>","name":"code","type":"string","value":"{\\"@context\\":\\"https://schema.org\\",\\"@type\\":\\"Organization\\",\\"name\\":\\"Acme\\"}"}]}\n- MCP tool: audit {"scopes":["seo"],"pagePath":"/"}\n\nNotes:\n\n- Prefer placing `JsonLd` inside `HeadSlot`.\n- Store `code` as a JSON object or array encoded as a compact string. The Builder formats it for editing.\n- The semantic prop update rejects malformed JSON and structurally invalid fixed JSON-LD with a precise JSON path.\n- The SEO audit also warns about a missing top-level `@context`, unknown or superseded Schema.org terms, properties unsupported by the supplied type, and incompatible primitive value types.\n- Schema.org vocabulary findings are warnings because custom vocabularies and extensions remain valid. Dynamic JSON-LD is marked as skipped for rendered validation.\n- Do not use bindings just to set static text.\n\n## Delete props\n\nCommands:\n\n- MCP tool: delete-props {"deletions":"props.json contents"}\n\n## Bind props to expressions/resources/actions\n\nCommands:\n\n- MCP tool: bind-props {"bindings":"bindings.json contents"}\n\nNotes:\n\n- Use this only when the prop should remain dynamic: expression, resource, action, or an existing scoped runtime context value such as `system`.\n- For a fixed string value, use `update-props` with `type:"string"` and a direct `value` instead.\n\n## Read styles\n\nCommands:\n\n- MCP tool: get-styles {"instanceIds":["<instanceId>"],"includeTokens":true}\n\n## Update local styles\n\nCommands:\n\n- MCP tool: update-styles {"updates":"styles.json contents"}\n\n## Delete local styles\n\nCommands:\n\n- MCP tool: delete-styles {"deletions":"styles.json contents"}\n\n## Replace matching style values\n\nCommands:\n\n- MCP tool: replace-styles {"property":"color","fromValue":{"type":"keyword","value":"red"},"toValue":{"type":"keyword","value":"blue"}}\n\n## List design tokens\n\nCommands:\n\n- MCP tool: list-design-tokens {}\n- MCP tool: list-design-tokens {"withUsage":true}\n- MCP tool: list-design-tokens {"verbose":true}\n\nNotes:\n\n- The default response is compact and includes token id, name, declaration count, and optional usage count.\n- Use `verbose:true` only when you need the full inline style declarations.\n\n## Create design tokens\n\nCommands:\n\n- MCP tool: create-design-token {"tokens":"tokens.json contents"}\n\n## Update design token styles\n\nCommands:\n\n- MCP tool: update-design-token-styles {"designTokenId":"<tokenId>","updates":"styles.json contents"}\n\n## Delete design token styles\n\nCommands:\n\n- MCP tool: delete-design-token-styles {"designTokenId":"<tokenId>","deletions":"styles.json contents"}\n\n## Attach design token to instances\n\nCommands:\n\n- MCP tool: attach-design-token {"designTokenId":"<tokenId>","instanceIds":"instances.json contents"}\n\n## Detach design token from instances\n\nCommands:\n\n- MCP tool: detach-design-token {"designTokenId":"<tokenId>","instanceIds":"instances.json contents"}\n\n## Extract design token from local styles\n\nCommands:\n\n- MCP tool: extract-design-token {"instanceIds":["<instanceId>"],"name":"Brand Primary","removeLocalProps":["color"]}\n\n## List CSS variables\n\nCommands:\n\n- MCP tool: list-css-variables {"withUsage":true}\n\n## Define CSS variables\n\nCommands:\n\n- MCP tool: define-css-variable {"vars":"vars.json contents"}\n\n## Delete CSS variables\n\nCommands:\n\n- MCP tool: delete-css-variable {"names":"names.json contents","force":true}\n\n## Rewrite CSS variable references\n\nCommands:\n\n- MCP tool: rewrite-css-variable-refs {"map":"variables.json contents"}\n\n## List data variables\n\nCommands:\n\n- MCP tool: list-variables {}\n- MCP tool: list-variables {"scopeInstanceId":"<instanceId>"}\n\nNotes:\n\n- Data variables live in the internal `dataSources` namespace.\n- For raw `snapshot`, request the public `variables` namespace rather than the internal `dataSources` name. Raw patch payloads still use `dataSources` when applying direct changes.\n- Scope variables to the instance where they should become available. Descendants can use them in expressions, and nested variables with the same name mask outer variables.\n\n## Create data variable\n\nCommands:\n\n- MCP tool: create-variable {"scopeInstanceId":"<instanceId>","name":"title","value":{"type":"string","value":"Hello"}}\n- MCP tool: create-variable {"scopeInstanceId":"<instanceId>","name":"count","value":{"type":"number","value":3}}\n- MCP tool: create-variable {"scopeInstanceId":"<instanceId>","name":"featured","value":{"type":"boolean","value":true}}\n- MCP tool: create-variable {"scopeInstanceId":"<instanceId>","name":"tags","value":{"type":"string[]","value":["news","product"]}}\n- MCP tool: create-variable {"scopeInstanceId":"<instanceId>","name":"filters","value":{"type":"json","value":{"tag":"news"}}}\n\nNotes:\n\n- Data variable values support `string`, `number`, `boolean`, `string[]`, and `json`.\n- Parameters are internal scoped runtime values provided by pages, collections, or components. They are not a public authoring surface: do not create, update, or delete parameter records. Use data variables/resources for user-authored data, and reference documented context values such as `system` only where they are already in scope.\n\n## Update data variable\n\nCommands:\n\n- MCP tool: update-variable {"dataSourceId":"<variableId>","values":{"value":{"type":"json","value":{"count":1}}}}\n\n## Delete data variable\n\nCommands:\n\n- MCP tool: delete-variable {"dataSourceId":"<variableId>"}\n\n## List resources\n\nCommands:\n\n- MCP tool: list-resources {}\n- MCP tool: list-resources {"scopeInstanceId":"<instanceId>"}\n\n## Create resource\n\nCommands:\n\n- MCP tool: create-resource {"resource":{"name":"Posts","method":"get","url":"https://api.example.com/posts","headers":[]}}\n- MCP tool: create-resource {"resource":{"name":"Posts","method":"get","url":"\\"https://api.example.com/posts?tag=\\" + filters.tag","headers":[]},"scopeInstanceId":"<instanceId>","dataSourceName":"posts"}\n- MCP tool: create-resource {"resource":{"name":"Filtered Posts","method":"get","url":"https://api.example.com/posts","searchParams":[{"name":"tag","value":"filters.tag"},{"name":"source","value":{"type":"literal","value":"website"}}],"headers":[{"name":"Authorization","value":"\\"Bearer \\" + auth.token"}]},"scopeInstanceId":"<instanceId>","dataSourceName":"posts"}\n- MCP tool: create-resource {"resource":{"name":"Post GraphQL","control":"graphql","method":"post","url":"https://api.example.com/graphql","headers":[{"name":"Content-Type","value":{"type":"literal","value":"application/json"}}],"body":"{ query: \\"query Post($slug: String!) { post(slug: $slug) { title } }\\", variables: { slug: system.params.slug } }"},"scopeInstanceId":"<instanceId>","dataSourceName":"post"}\n- MCP tool: create-resource {"resource":{"name":"Current Date","control":"system","method":"get","url":"/$resources/current-date","headers":[]},"scopeInstanceId":"<instanceId>","dataSourceName":"currentDate"}\n\nNotes:\n\n- Resource `url` accepts plain fixed URLs and paths such as `https://api.example.com/posts` and `/$resources/current-date`.\n- Resource `url` can also be a JavaScript expression when it is computed, such as `"https://api.example.com/posts?tag=" + filters.tag`.\n- Header values, search parameter values, and body accept expressions for dynamic values. For fixed text, use `{"type":"literal","value":"application/json"}`; Webstudio stores the required string expression for you.\n- Search parameter values, header values, and body expressions can read scoped variables and documented runtime context values such as `system` when they are available at the resource scope.\n- Add `scopeInstanceId` and `dataSourceName` when the resource result should be exposed as a scoped read data variable. Scoped resources are generated into the page resource `data` map and may be loaded during page rendering. Use this for read-oriented resources such as GET CMS/API data.\n- For submit/write/action resources, create the resource without `scopeInstanceId`, then bind a component prop such as a Form `action` with `bind-props` and `binding.type: "resource"`. Prop-bound resources are generated into the page resource `action` map instead of the read `data` map. Use this for POST, PUT, DELETE, webhooks, GraphQL submissions, and other explicit action flows.\n- Resource `method` can be `get`, `post`, `put`, or `delete`. Use GET for read data, POST for creates/GraphQL/webhooks/form submissions, PUT for full updates or replacements, and DELETE for deletion actions.\n- Optional `control` values are `graphql` and `system`. Use `graphql` for GraphQL-style requests, usually POST with a query body. Use `system` for built-in resources such as `"/$resources/sitemap.xml"`, `"/$resources/current-date"`, and `"/$resources/assets"` and when the resource should use the built-in `system` parameter. System fields are `system.origin`, `system.pathname`, `system.params`, and `system.search`.\n\n## Update resource\n\nCommands:\n\n- MCP tool: update-resource {"resourceId":"<resourceId>","values":{"url":"https://api.example.com/posts"}}\n- MCP tool: replace-resource-text {"find":"api.old.example.com","replace":"api.example.com","fields":["url"],"limit":20}\n\n## Delete resource\n\nCommands:\n\n- MCP tool: delete-resource {"resourceId":"<resourceId>"}\n\n## List assets\n\nCommands:\n\n- MCP tool: list-assets {"withUsage":true}\n- MCP tool: list-assets {"verbose":true}\n\nNotes:\n\n- Compact results include each asset\'s folder id. Use `verbose:true` to include complete records for a page of assets, or `get-asset` to read one complete record including description, folder, creation time, and image/font metadata.\n- Image asset descriptions are the default alt text for asset-backed Image components.\n- To generate missing descriptions, inspect the image in its rendered page or asset source, write a concise description of its purpose, and save it on the asset rather than duplicating it on each Image instance.\n\n## Get asset\n\nCommands:\n\n- MCP tool: get-asset {"assetId":"<assetId>"}\n\n## List asset folders\n\nCommands:\n\n- MCP tool: list-asset-folders {}\n\n## Create asset folder\n\nCommands:\n\n- MCP tool: create-asset-folder {"name":"Marketing"}\n- MCP tool: create-asset-folder {"name":"Photos","parentId":"<parentFolderId>"}\n\n## Update asset folder\n\nCommands:\n\n- MCP tool: update-asset-folder {"folderId":"<folderId>","values":{"name":"Brand"}}\n- MCP tool: update-asset-folder {"folderId":"<folderId>","values":{"parentId":"<parentFolderId>"}}\n- MCP tool: update-asset-folder {"folderId":"<folderId>","values":{"parentId":null}}\n\nNotes:\n\n- Updating `parentId` is the folder equivalent of cut and paste. Use `null` to move a folder to Root.\n\n## Duplicate asset folder\n\nCommands:\n\n- MCP tool: duplicate-asset-folder {"folderId":"<folderId>"}\n- MCP tool: duplicate-asset-folder {"folderId":"<folderId>","parentId":"<targetFolderId>"}\n\nNotes:\n\n- Duplication recursively copies descendant folders and assets. This is the folder equivalent of copy and paste.\n\n## Delete asset folder\n\nCommands:\n\n- MCP tool: delete-asset-folder {"folderId":"<folderId>"}\n\nNotes:\n\n- Deleting a folder recursively deletes its descendant folders and assets.\n\n## Update asset metadata\n\nCommands:\n\n- MCP tool: update-asset {"assetId":"<assetId>","values":{"description":"Team collaborating around a whiteboard"}}\n- MCP tool: update-asset {"assetId":"<fontAssetId>","values":{"meta":{"family":"Rajdhani","style":"normal","weight":600}}}\n\nNotes:\n\n- Use an empty description only when the image is intentionally decorative.\n- Updating an image asset description updates the default alt text wherever that asset is used with an asset-backed alt prop.\n- Font metadata updates merge with the detected metadata and are validated before committing; use this to correct a family, style, or weight after upload.\n\n## Generate missing image descriptions with an agent\n\nCommands:\n\n- MCP tool: audit {"scopes":["accessibility"],"verbose":true}\n- MCP tool: set-image-descriptions {"updates":[{"assetId":"hero-id","description":"Team collaborating around a whiteboard"},{"assetId":"texture-id","decorative":true}]}\n- MCP tool: audit {"scopes":["accessibility"]}\n\nNotes:\n\n- Start from `missing-image-description` findings. Inspect each image in its rendered page context before writing text.\n- The vision-capable agent generates the wording; the CLI validates and stores it but does not contain its own vision model.\n- Use `decorative:true` only when the image adds no information. This intentionally stores an empty description so later audits do not report it as missing.\n- Re-run the accessibility audit after the update. Asset-backed Image components use the saved asset description as their default alt text.\n\n## Manage fonts\n\nCommands:\n\n- MCP tool: list-fonts {"includeSystem":true}\n- MCP tool: list-assets {"type":"font"}\n- MCP tool: upload-asset {"asset":{"name":"acme-sans.woff2","type":"font","format":"woff2","meta":{"family":"Acme Sans","style":"normal","weight":400}},"assetsDir":".webstudio/assets"}\n- MCP tool: update-styles {"updates":"styles.json contents"}\n\nNotes:\n\n- Use `list-fonts` to discover uploaded families and system stacks. Upload/delete fonts through the existing asset tools, then apply a family with a `font-family` style declaration.\n\n## Upload one asset\n\nCommands:\n\n- MCP tool: upload-asset {"asset":{"name":"image.png","type":"image","format":"png","meta":{"width":1200,"height":630}},"assetsDir":".webstudio/assets"}\n- MCP tool: upload-asset {"asset":{"name":"image.png","type":"image","format":"png","folderId":"<folderId>","meta":{"width":1200,"height":630}},"assetsDir":".webstudio/assets"}\n\n## Upload asset batch\n\nCommands:\n\n- MCP tool: upload-assets {"assets":[{"name":"image.png","type":"image","format":"png","meta":{"width":1200,"height":630}}],"assetsDir":".webstudio/assets"}\n\n## Duplicate asset\n\nCommands:\n\n- MCP tool: duplicate-asset {"assetId":"<assetId>"}\n- MCP tool: duplicate-asset {"assetId":"<assetId>","folderId":"<targetFolderId>"}\n- MCP tool: duplicate-asset {"assetId":"<assetId>","folderId":null}\n\nNotes:\n\n- Duplication is the asset equivalent of copy and paste. Updating `folderId` is the equivalent of cut and paste; use `null` for Root.\n\n## Download asset\n\nCommands:\n\n- MCP tool: download-asset {"assetId":"<assetId>"}\n\n## Find asset usage\n\nCommands:\n\n- MCP tool: find-asset-usage {"assetId":"<assetId>"}\n\n## Replace asset references\n\nCommands:\n\n- MCP tool: replace-asset {"fromAssetId":"<oldAssetId>","toAssetId":"<newAssetId>"}\n\n## Delete assets\n\nCommands:\n\n- MCP tool: delete-asset {"assetIdsOrPrefixes":["<assetId>"],"force":true}\n\n## Publish project\n\nCommands:\n\n- webstudio publish deploy --target production --json\n\n## List publishes\n\nCommands:\n\n- webstudio publish list --json\n\n## Check publish job\n\nCommands:\n\n- webstudio publish status --job <buildId> --json\n\n## Unpublish\n\nCommands:\n\n- webstudio publish unpublish --target production --confirm --json\n\n## List domains\n\nCommands:\n\n- webstudio domains list --json\n\n## Create domain\n\nCommands:\n\n- webstudio domains create --domain example.com --json\n\n## Update domain\n\nCommands:\n\n- webstudio domains update --domain-id <domainId> --domain www.example.com --json\n\n## Delete domain\n\nCommands:\n\n- webstudio domains delete --domain-id <domainId> --confirm --json\n\n## Verify domain\n\nCommands:\n\n- webstudio domains verify --domain-id <domainId> --json\n\n## Make arbitrary store-level changes\n\nCommands:\n\n- MCP tool: inspect {}\n- MCP tool: snapshot {"include":["<namespace>"]}\n- MCP tool: apply-patch {"baseVersion":"<version>","transactions":"patch.json contents"}\n\nNotes:\n\n- Use only when no semantic command exists.\n\n## Manage marketplace metadata\n\nCommands:\n\n- MCP tool: get-marketplace-product {}\n- MCP tool: update-marketplace-product {"category":"pageTemplates","name":"Acme Template","thumbnailAssetId":"asset-id","author":"Acme Studio","email":"hello@example.com","website":"https://example.com","issues":"","description":"Reusable template project for Acme landing pages."}\n\nPatch namespaces:\n\n- marketplaceProduct\n\n## Search and inspect safely\n\nCommands:\n\n- MCP tool: search-project {"query":"pricing"}\n- MCP tool: search-project {"query":"api.example.com","scopes":["resources"]}\n- MCP tool: list-instances {"pagePath":"/","maxDepth":5}\n- MCP tool: inspect-instance {"instanceId":"<instanceId>","include":["props","styles","children"]}\n- MCP tool: list-texts {"pagePath":"/"}\n- MCP tool: list-assets {"withUsage":true}\n- MCP tool: find-asset-usage {"assetId":"<assetId>"}\n- MCP tool: snapshot {"include":["pages","instances","props","resources","assets"]}\n\nNotes:\n\n- Use `search-project` for query-driven lookup across labels, text, prop values, resource URLs, asset metadata, and styles. Use `audit` for project health findings.\n\n## Audit project quality\n\nCommands:\n\n- webstudio audit --json\n- webstudio audit --scopes accessibility --scopes seo --json\n- webstudio audit --page-path /pricing --json\n- webstudio audit --scopes accessibility --verbose --json\n- webstudio audit --rendered --page-path /pricing --json\n- webstudio audit --rendered --route-example post=/blog/hello --json\n- webstudio audit --rendered --image-domain images.example.com --json\n- MCP tool: audit {}\n- MCP tool: audit {"scopes":["accessibility","security"],"severities":["error","warning"]}\n- MCP tool: audit {"scopes":["accessibility"],"verbose":true}\n- MCP tool: audit {"scopes":["craft"],"verbose":true}\n- MCP tool: audit {"rendered":true,"verbose":true}\n\nNotes:\n\n- With no scopes, `audit` checks accessibility, security, SEO, performance settings, unused assets, ineffective Collection styles, non-GET resources exposed as render-time data, and unused or duplicate style data.\n- Craft is opt-in and read-only. Run `audit` with `scopes:["craft"]` to detect whether the project is not using Craft, partially compatible, or compatible with the versioned Craft 1.2 profile. `profileStatuses` includes the University-doc provenance and the smallest safe next action. The audit never installs Craft or changes a non-Craft project.\n- The `performance` scope reports disabled atomic CSS generation. A rendered audit also measures broken, eager below-fold, and oversized images, browser-marked render-blocking resources, and legacy font formats.\n- Rendered image and resource metrics run only when the selected scopes include `performance`; responsive layout dimensions remain available whenever `rendered:true` is requested.\n- Compact findings include stable ids, severity, message, and location. Use `--verbose` or `{"verbose":true}` for evidence, explanation, suggested remediation, skipped-check details, and manual-check workflows.\n- `summary` counts all findings before severity filtering and pagination.\n- `contractVersion` identifies the audit response contract. Handle a new value before assuming existing fields retain the same meaning.\n- Expression-, resource-, and parameter-backed values that cannot be checked reliably appear in `skippedChecks`; they are not treated as passing or failing.\n- Page filters apply to page-owned accessibility, security, and SEO checks. Asset and style usage remain project-wide to avoid false unused findings.\n- Continue paginated results with `cursor`. Restart the audit if the project version changes.\n- Verbose skipped-check and manual-check details are included on the first findings page only; their total counts remain available on every page.\n- `manualChecks` describes responsive, hierarchy, and contrast checks that require preview screenshots and vision.\n- Focused audits return only manual checks relevant to their selected scopes.\n- In a long-lived MCP session, `{"rendered":true}` reuses preview and screenshot\n tools to capture every static page at mobile, desktop, and Builder breakpoint\n edges. Compact output reports rendered check/issue/failure counts; verbose\n output includes screenshot paths and measured layout dimensions.\n- Dynamic route templates are skipped unless `--route-example <pageId>=<path>`\n (or MCP `routeExamples`) supplies a concrete path. The path must not contain\n unresolved `:` or `*` parameters.\n- Plans above 120 captures return a short-lived confirmation token. Review the\n unchanged plan, then rerun with `--confirm-large-run` and\n `--confirmation-token`.\n- Detailed rendered evidence is stored in a versioned manifest under\n `.webstudio/audits`; compact output includes its path and screenshot count.\n- Rendered checks also report broken images, eager images below the fold, and\n image sources more than 2x their rendered dimensions in both axes, including\n Webstudio instance ids and measured dimensions when available.\n- Rendered checks include sanitized Resource Timing evidence and report\n browser-marked render-blocking resources plus legacy `.ttf`, `.otf`, and\n `.woff` fonts without applying a universal transfer-size threshold.\n- Fix findings through semantic mutation commands, then rerun `audit` to confirm their deterministic finding ids disappeared.\n\n## Verify dynamic bindings\n\nCommands:\n\n- webstudio verify-bindings --json\n- MCP tool: verify-bindings {"pagePath":"/pricing"}\n- MCP tool: verify-bindings {"instanceId":"<instanceId>","limit":50}\n\nNotes:\n\n- Statically checks persisted text expressions, expression/action/resource/parameter props, resource expressions, and page metadata.\n- Findings distinguish invalid syntax, unknown or out-of-scope variables, stale internal data-source ids, and missing resource or parameter references.\n- Page and instance filters can be combined when the instance belongs to the selected page. Continue findings with `cursor`.\n- This operation does not resolve rendered values or execute external resources. Preview representative loading, empty, error, and populated states after static findings are fixed.\n\n## Refactor targeted content\n\nCommands:\n\n- MCP tool: list-instances {"pagePath":"/"}\n- MCP tool: list-texts {"pagePath":"/"}\n- MCP tool: update-text {"instanceId":"<instanceId>","childIndex":0,"text":"Launch faster"}\n- MCP tool: replace-text {"find":"Old headline","replace":"New headline","match":"exact","pagePath":"/pricing","limit":20}\n- MCP tool: update-props {"updates":"props.json contents"}\n- MCP tool: update-page {"pageId":"<pageId>","values":{"title":"Pricing","meta":{"description":"Plans"}}}\n- MCP tool: update-resource {"resourceId":"<resourceId>","values":{"url":"https://api.example.com/posts"}}\n- MCP tool: replace-asset {"fromAssetId":"<oldAssetId>","toAssetId":"<newAssetId>"}\n- MCP tool: replace-styles {"property":"color","fromValue":{"type":"keyword","value":"red"},"toValue":{"type":"keyword","value":"blue"}}\n- MCP tool: rewrite-css-variable-refs {"map":"variables.json contents"}\n\nNotes:\n\n- Use focused reads first, then mutate only matching instances, props, metadata, resource URLs, assets, or style references. Use `replace-text` for bounded literal text changes, `replace-prop-text` for bounded static prop text, `replace-resource-text` for fixed resource names/URLs, and `update-text` for one known child or expressions.\n\n## Optimize existing project\n\nCommands:\n\n- MCP tool: list-pages {}\n- MCP tool: list-folders {}\n- MCP tool: update-page {"pageId":"<pageId>","values":{"title":"Pricing","meta":{"description":"Plans"}}}\n- MCP tool: update-props {"updates":"props.json contents"}\n- MCP tool: list-breakpoints {}\n- MCP tool: update-breakpoint {"breakpointId":"tablet","values":{"maxWidth":1023}}\n- MCP tool: get-styles {"instanceIds":["<instanceId>"],"includeTokens":true}\n- MCP tool: update-styles {"updates":"styles.json contents"}\n- MCP tool: attach-design-token {"designTokenId":"<tokenId>","instanceIds":"instances.json contents"}\n- MCP tool: update-project-settings {"meta":{"siteName":"Acme"}}\n\nNotes:\n\n- Use this for SEO metadata, accessibility labels, responsive behavior, token consistency, and project settings.\n\n## Connect external data\n\nCommands:\n\n- MCP tool: create-variable {"scopeInstanceId":"<instanceId>","name":"title","value":{"type":"string","value":"Hello"}}\n- MCP tool: create-variable {"scopeInstanceId":"<instanceId>","name":"tags","value":{"type":"string[]","value":["news","product"]}}\n- MCP tool: create-variable {"scopeInstanceId":"<instanceId>","name":"filters","value":{"type":"json","value":{"tag":"news"}}}\n- MCP tool: create-resource {"resource":{"name":"Posts","method":"get","url":"https://api.example.com/posts","searchParams":[{"name":"tag","value":"filters.tag"},{"name":"source","value":{"type":"literal","value":"website"}}],"headers":[]},"scopeInstanceId":"<instanceId>","dataSourceName":"posts"}\n- MCP tool: create-resource {"resource":{"name":"Post GraphQL","control":"graphql","method":"post","url":"https://api.example.com/graphql","headers":[{"name":"Content-Type","value":{"type":"literal","value":"application/json"}}],"body":"{ query: \\"query Post($slug: String!) { post(slug: $slug) { title } }\\", variables: { slug: system.params.slug } }"},"scopeInstanceId":"<instanceId>","dataSourceName":"post"}\n- MCP tool: create-resource {"resource":{"name":"Current Date","control":"system","method":"get","url":"/$resources/current-date","headers":[]},"scopeInstanceId":"<instanceId>","dataSourceName":"currentDate"}\n- MCP tool: update-resource {"resourceId":"<resourceId>","values":{"url":"https://api.example.com/posts"}}\n- MCP tool: bind-props {"bindings":"bindings.json contents"}\n- MCP tool: insert-fragment {"parentInstanceId":"<instanceId>","fragment":"<ws.collection>{/_ collection content _/}</ws.collection>"}\n\nNotes:\n\n- Use this for CMS sections, blog listings, Ghost/headless CMS pages, n8n-style integrations, and API URLs built from variables.\n- For read data, expose GET resources as scoped data variables with `scopeInstanceId`/`dataSourceName` and read the loaded result from the resource result wrapper, usually `.data`.\n- For writes, webhooks, GraphQL submissions, and deletes, prefer unscoped resources bound to Form `action` props so they become action resources instead of auto-loaded read resources.\n- Use direct props for fixed values and prop bindings only when a prop must read a data variable, resource, action, or documented runtime context value such as `system`.\n\n## Render an array or object as repeated content\n\nCommands:\n\n- MCP tool: insert-collection {"parentInstanceId":"<instanceId>","data":{"type":"expression","value":"posts.data.items"},"itemFragment":"<ws.element ws:tag=\\"article\\"><ws.element ws:tag=\\"h2\\">{expression`collectionItem.title`}</ws.element></ws.element>"}\n- MCP tool: inspect-instance {"instanceId":"<collectionId>","include":["props","bindings","children"]}\n\nNotes:\n\n- Use Collection whenever an array or object from a resource or data variable should render a list, grid, cards, table rows, options, tabs, or other repeated UI.\n- Pass `insert-collection` the complete array or object. Do not pass the resource response wrapper or one indexed item. External resource arrays are commonly nested under the scoped resource result\'s `data` field or deeper.\n- Pass one repeated-item Webstudio JSX root. The command creates the Collection, its private current-item/current-key parameters, the iterable binding, and descendant item bindings atomically.\n- Collection renders the item root once for every entry. Use `expression` values such as `collectionItem.title` in descendant text and props. Object iteration also exposes `collectionItemKey`.\n- Wrap multiple repeated sibling instances in one Element inside Collection.\n- For repeated Radix items such as accordion items, tabs, or menu options, bind a stable unique id or slug to every required `value` prop.\n- See the [Collection documentation](https://docs.webstudio.is/university/core-components/collection) for the equivalent Builder workflow.\n\n## Support dynamic runtime behavior\n\nCommands:\n\n- MCP tool: integrate-runtime-ui {"parentInstanceId":"<instanceId>","resources":[{"resource":{"name":"Seats","method":"get","url":"https://api.example.com/seats","headers":[]},"dataSourceName":"Seats","exposeAsDataSource":true}],"structure":{"type":"collection","data":{"type":"expression","value":"Seats.data"},"itemFragment":{"children":[{"type":"id","value":"seat"}],"instances":[{"type":"instance","id":"seat","component":"Text","children":[{"type":"expression","value":"collectionItem.label"}]}],"props":[],"dataSources":[],"resources":[],"styleSources":[],"styleSourceSelections":[],"styles":[],"breakpoints":[],"assets":[]}},"retainedBehavior":[{"instanceId":"<scriptInstanceId>","responsibility":"Seat selection behavior"}]}\n- MCP tool: update-props {"updates":"props.json contents"}\n- MCP tool: bind-props {"bindings":"bindings.json contents"}\n- MCP tool: create-resource {"resource":{"name":"Seats","method":"get","url":"https://api.example.com/seats","headers":[]}}\n- MCP tool: snapshot {"include":["instances","props","resources"]}\n- MCP tool: apply-patch {"baseVersion":"<version>","transactions":"patch.json contents"}\n\nNotes:\n\n- Use `integrate-runtime-ui` to create variables/resources, insert one editable fragment or Collection, and add safe data bindings in one transaction.\n- List existing script-owned responsibilities under `retainedBehavior`. The operation preserves those instances and never evaluates or accepts replacement script bodies.\n- `unsupportedConversions` records behavior that cannot be represented safely. Dry-run returns the complete transaction and the same retained/unsupported report without changing the project.\n- New actions and HtmlEmbed scripts are intentionally rejected. Create normal editable components and data bindings; keep opaque runtime behavior in existing script instances.\n\n## Build authenticated pages\n\nCommands:\n\n- MCP tool: meta.guide {"brief":"Build a Supabase-authenticated account page"}\n- MCP tool: create-page {"name":"Account","path":"/account"}\n- MCP tool: update-page {"pageId":"<pageId>","values":{"meta":{"auth":{"method":"basic","login":"<login>","password":"<password>"}}}}\n- MCP tool: create-resource {"resource":{"name":"Session","method":"get","url":"https://api.example.com/session","headers":[]}}\n- MCP tool: create-variable {"scopeInstanceId":"<instanceId>","name":"user","value":{"type":"json","value":{}}}\n- MCP tool: update-props {"updates":"props.json contents"}\n- MCP tool: bind-props {"bindings":"bindings.json contents"}\n\nNotes:\n\n- Inspect and reuse the project\'s existing auth convention before authoring. Do\n not add a second provider or session model implicitly.\n- Model signed-out, loading, signed-in, and failed-auth states explicitly.\n- Never store credentials, service-role keys, refresh tokens, private session\n values, or authenticated response bodies in project data, command output,\n screenshots, agent instructions, or error reports. Privileged provider calls\n and authorization enforcement belong server-side.\n- Basic auth is semantic today. Provider-specific Supabase/Firebase setup still\n uses the existing resource, variable, prop, binding, and embed tools; there is\n no provider-specific installer.\n\n## Generate from design input\n\nCommands:\n\n- MCP tool: meta.guide {"brief":"Recreate this Figma design as a responsive page"}\n- MCP tool: create-page {"name":"Landing","path":"/landing"}\n- MCP tool: create-design-token {"tokens":"tokens.json contents"}\n- MCP tool: define-css-variable {"vars":"vars.json contents"}\n- MCP tool: list-breakpoints {}\n- MCP tool: insert-fragment {"parentInstanceId":"<instanceId>","fragment":"<ws.element ws:tag=\\"section\\"><ws.element ws:tag=\\"p\\">Section copy</ws.element></ws.element>"}\n- MCP tool: update-styles {"updates":[{"instanceId":"<instanceId>","breakpointId":"<breakpointId-from-list-breakpoints>","property":"padding-left","value":{"type":"unit","unit":"px","value":24}}]}\n- MCP tool: preview.start {"host":"127.0.0.1","port":5173}\n- MCP tool: screenshot {"path":"/landing","output":"landing-desktop.png","viewport":{"width":1440,"height":900},"waitUntil":"load","waitForTimeout":250}\n- MCP tool: screenshot {"path":"/landing","output":"landing-mobile.png","viewport":{"width":390,"height":844},"waitUntil":"load","waitForTimeout":250}\n- MCP tool: screenshot {"baseUrl":"http://127.0.0.1:5177","path":"/landing","output":"landing-desktop.png","viewport":{"width":1440,"height":900},"waitUntil":"load","waitForTimeout":250}\n\nNotes:\n\n- Use this after the agent can inspect the supplied design. There is no direct\n Figma, screenshot, Inception, or `design.md` import command.\n- Inspect and reuse existing variables, tokens, styles, components, assets, and\n page patterns before authoring. Build semantic editable structure rather than\n flattening the design into an image or absolute-positioned approximation.\n- Verify one familiar viewport inside every distinct Builder breakpoint range,\n then run rendered audit and inspect the screenshots before completion.\n\n## Cross-project maintenance\n\nCommands:\n\n- webstudio mcp run .temp/projects.json\n- webstudio mcp run .temp/projects.json --dry-run\n- webstudio mcp run .temp/projects.json --approve-mutations --concurrency 2\n\nNotes:\n\n- Put shared `calls` and a `projects` array of independently linked project roots in the existing `mcp run` manifest. Project roots are relative to the manifest file.\n- Each project uses its own config, authentication, ProjectSession storage, checkpoint, and failure boundary. Confirmed successful calls are checkpointed. Reads can resume automatically; a mutation interrupted after dispatch is reported as ambiguous and is not replayed automatically, preventing silent duplicate writes.\n- Focus the manifest on bounded reads or audits first. Use per-call `dryRun`, global `--dry-run`, or explicitly approve committed mutations with `--approve-mutations` after reviewing the manifest.\n\n# Known CLI Gaps\n\n## Provider-specific authenticated pages\n\nMissing:\nCLI supports page basic auth and generic resources/props/embeds, but not guided Supabase/Firebase auth setup.\n\nCurrent fallback:\nCall `meta.guide` with the provider-authenticated page goal, then create the\npage, resources, variables, props, bindings, and embeds with existing semantic\ntools.\n\nSuggested commands:\n\n- setup-auth-page\n\n## Generate from design input\n\nMissing:\nNo command imports Figma, screenshots, Inception output, or design.md and turns it into pages/tokens/layout.\n\nCurrent fallback:\nCall `meta.guide` with the design-input goal, let the agent inspect the supplied\ndesign, then use semantic page, token, asset, fragment, style, preview,\nscreenshot, and audit tools. Use `apply-patch` only when no semantic operation\nfits.\n\nSuggested commands:\n\n- generate-from-design\n\n## Built-in cross-project maintenance\n\nMissing:\nPublic API and CLI intentionally operate on one configured project at a time; there is no built-in multi-project discovery or loop runner.\n\nCurrent fallback:\nRun the CLI from an external script that reconfigures one project/session at a time.\n\nSuggested commands:\n\n- none\n',
|
|
230018
230244
|
"manual-api": '# Webstudio API CLI Manual\n\nThe API commands operate on the single project configured by:\n\n- .webstudio/config.json: projectId\n- global Webstudio config: origin and token\n\n- Pass --json to API/discovery commands that support it. Do not add --json to top-level commands unless their help/schema documents it.\n- Never pass a project id. Commands use configured project only.\n- Read ids before writing. Do not invent ids for existing records.\n- stdout is one JSON object. stderr is diagnostics.\n- Prefer MCP semantic tools for detailed project edits. Use MCP apply-patch only when no semantic tool exists.\n\n## Start\n\n{{start}}\n\n## Read First\n\n{{readFirst}}\n\n## Project Session Cache\n\n- CLI commands use one local ProjectSession snapshot for the configured project.\n- Local-capable reads use cached namespaces when compatible and fetch only missing or stale namespaces.\n- Local-capable mutations build patches from the local snapshot, then commit with the cached build version.\n- Successful mutation commits update the local snapshot only after the remote commit succeeds.\n- Server-only commands run remotely and invalidate/refetch namespaces declared by the operation catalog.\n- Use --refresh on local-capable commands to refresh required namespaces before running.\n- Successful JSON responses include compact meta.session with operationId, buildId, version, source, committed, namespaceCounts, diagnosticCount, non-empty diagnostic summaries, and optional compatibilityVersion.\n\n## CLI Capability Inventory\n\nFor a short end-consumer summary of what MCP can do, see\n`manual mcp` / `webstudio man mcp`. The MCP inventory describes the same\nproject, page, element, style, data, asset, publish, domain, and visual\nverification capabilities without internal command names.\n\n### Top-Level Commands\n\n{{topLevelCapabilityIndex}}\n\n### High-Level API Commands By Area\n\n{{apiCapabilityIndex}}\n\n### MCP Tool Operations\n\nThese are MCP tools. From a shell, call them with the shortcut form `webstudio <tool> \'<json>\'` or with the explicit form `webstudio mcp single-op-call <tool> \'<json>\'`:\n\n{{mcpOnlyCommandIndex}}\n\n## Task Recipes\n\n{{taskRecipeIndex}}\n\n## Use Case Index\n\n{{useCaseIndex}}\n\n## Known CLI Gaps\n\n{{knownCliGapIndex}}\n\n## Input File Shapes\n\n{{inputFileShapeIndex}}\n\n## Raw Patch Fallback\n\napply-patch accepts either BuildPatchTransaction[] or { "transactions": BuildPatchTransaction[] }.\n\nEach transaction has:\n\n{\n"id": "patch-transaction-label",\n"payload": [\n{\n"namespace": "projectSettings",\n"patches": [\n{ "op": "replace", "path": ["meta", "siteName"], "value": "New Site" }\n]\n}\n]\n}\n\nThe transaction id is a patch label used for optimistic synchronization. It is\nnot a Builder record id. Do not invent ids for pages, instances, props,\nbreakpoints, resources, variables, folders, assets, or other project records.\n\nPatch paths are JSON-patch-like paths into Builder store data. Map-like namespaces use ids as the first path item.\n\nSupported namespaces:\n\n- pages: redirects, page records, and folders\n- projectSettings: project-wide metadata and compiler settings\n- instances: element instances and children, including text/expression children\n- props: element props, bindings, page references, resource bindings\n- styles: CSS declarations keyed by style declaration key\n- styleSources: local style sources and reusable design tokens\n- styleSourceSelections: instance-to-style-source connections\n- dataSources: data variables, parameters, and resource data sources\n- resources: data resource definitions\n- assets: project asset records handled by the existing asset patch path\n- breakpoints: responsive breakpoints\n- marketplaceProduct: marketplace metadata\n\n## Data Sources\n\n`dataSources` is the internal Builder namespace for variables. Public API, CLI,\nand MCP tools expose it through two user-facing groups:\n\n- data variables: `list-variables`, `create-variable`, `update-variable`, and\n `delete-variable`\n- data resources: `list-resources`, `create-resource`, `update-resource`, and\n `delete-resource`\n\nFor raw `snapshot`, request the public `variables` namespace rather than the\ninternal `dataSources` name. Raw patch payloads still use `dataSources` when\napplying direct changes.\n\nVariables can be scoped to an instance. Expressions under that instance can use\nthe variable by name; nested variables with the same name mask outer variables.\nVariable values support `string`, `number`, `boolean`, `string[]`, and `json`.\nUse `string[]` for lists of strings such as tags or selected categories; use\n`json` for objects, arrays with mixed shapes, or nested API filter state.\nParameters are internal scoped runtime values provided by pages, collections,\nor components. They are not a public authoring surface: do not create, update,\nor delete parameter records. Public tools should preserve existing parameter\nrecords and may reference documented context values such as `system` in\nexpressions where they are already in scope.\n\nResource `url` accepts plain fixed URLs and paths, for example\n`https://api.example.com/posts` or `/$resources/current-date`. Dynamic URLs can\ncombine strings and variables, for example\n`"https://api.example.com/posts?tag=" + filters.tag`. Prefer `searchParams` for\nquery parameters that should be encoded separately:\n`[{ "name": "tag", "value": "filters.tag" }]`. Header values, search parameter\nvalues, and bodies are expressions for dynamic content. For fixed text, use\n`{ "type": "literal", "value": "application/json" }`; Webstudio stores the\nrequired string expression. Headers can still read variables such as\n`"Bearer " + auth.token`, and GraphQL bodies can return objects such as\n`{ query: "...", variables: { slug: system.params.slug } }`.\n\nCreate a GET resource with `scopeInstanceId` when the fetched resource result\nshould be available as a read data variable. Scoped GET resources default to\n`exposeAsDataSource: true`, are generated into the page resource `data` map,\nand may be loaded during page rendering. Use `dataSourceName` to choose the\nvariable name.\n\nFor submit/write/action resources, create the resource without\n`scopeInstanceId`, then bind a component prop such as a Form `action` to the\nresource with `bind-props` and `binding.type: "resource"`. Prop-bound resources\nare generated into the page resource `action` map instead of the read `data`\nmap. Use this shape for POST, PUT, DELETE, webhook, and other resources that\nshould run only from an explicit form/action flow, not merely because the page\nrendered.\n\nPOST, PUT, and DELETE resources default to `exposeAsDataSource: false` even\nwhen a scope is supplied. Set `exposeAsDataSource: true` only when a write-method\nresource intentionally provides render-time data, such as a read-only GraphQL\nPOST query. A scope is required, and the result includes a warning because the\nrequest may execute during page rendering. Set `exposeAsDataSource: false` on\n`update-resource` to detach an existing render-time data source.\n\nResource `method` can be `get`, `post`, `put`, or `delete`. Use GET for read\ndata. Use POST for creates, GraphQL requests, webhooks, and form submissions.\nUse PUT for full updates/replacements. Use DELETE for deletion actions.\nOptional `control` values are `graphql` and `system`: `graphql` marks a\nGraphQL-style resource, usually POST with a query body; `system` marks a\nresource intended to use the built-in `system` parameter or one of the built-in\nlocal resource URLs: `"/$resources/sitemap.xml"`,\n`"/$resources/current-date"`, and `"/$resources/assets"`. The system parameter\nfields are `system.origin`, `system.pathname`, `system.params`, and\n`system.search`.\n\nUse prop bindings for dynamic values that read variables or resources; use\ndirect props for static values.\n\nCommit raw patch:\n\nMCP tool: apply-patch\n\n## Raw Patch Examples\n\nRename the site:\n\n[\n{\n"id": "patch-site-name",\n"payload": [\n{\n"namespace": "projectSettings",\n"patches": [\n{ "op": "add", "path": ["meta", "siteName"], "value": "Acme Studio" }\n]\n}\n]\n}\n]\n\nUpdate page title metadata:\n\n[\n{\n"id": "patch-page-title",\n"payload": [\n{\n"namespace": "pages",\n"patches": [\n{ "op": "replace", "path": ["pages", "page-id", "meta", "title"], "value": "Pricing" }\n]\n}\n]\n}\n]\n\nUpdate a text child on an element:\n\n[\n{\n"id": "patch-text",\n"payload": [\n{\n"namespace": "instances",\n"patches": [\n{ "op": "replace", "path": ["instance-id", "children", 0, "value"], "value": "Launch faster" }\n]\n}\n]\n}\n]\n\nCreate records with semantic operations such as create-variable,\ncreate-resource, create-design-token, create-page, create-folder,\nand create-breakpoint. Raw patch rejects generated record\ncreation, collection replacement, record replacement with a different `id`, and\nrecord id field mutations in id-keyed namespaces because Webstudio must generate\nand preserve record ids.\n\n## Safety Rules\n\n- For MCP apply-patch, read the latest version with MCP snapshot before writing.\n- Reuse ids from MCP snapshot output when updating existing records.\n- Do not create generated records, replace generated record collections, replace records with different ids, or mutate record id fields with raw patch. Use semantic create operations so Webstudio generates ids.\n- If apply-patch reports a version conflict, read the latest build and regenerate the patch.\n- Prefer semantic MCP read tools for discovery, then use MCP snapshot for exact patch paths.\n\n## Command Index\n\n{{commandIndex}}\n',
|
|
230019
230245
|
"manual-llm": '# Webstudio CLI Manual for LLMs\n\nUse this order. Stop only when a command returns ok:false.\n\nIf you are inside the Webstudio monorepo, the first command discovery should use\nthe local CLI exactly as `node packages/cli/local.js ...` from the repo root. Do\nnot use `packages/cli/bin.js` for local source-tree work; it is the packaged\nbuild entry and may use stale built output. Do not use `pnpm exec webstudio`,\n`pnpm --filter webstudio exec webstudio`, or a global `webstudio`: they can\nresolve an older binary.\n\nFor delegated design-system or “use every component” tasks, skip the generic warm-up sequence and start with exactly one MCP command: `webstudio workflow.next \'{"goal":"design-system-page"}\'`. Report that returned checkpoint to the parent/user and stop until continued.\n\n## Connect an MCP client\n\nWhen the user asks to connect the current folder to Webstudio, run the command\nfor the agent client you are currently using:\n\n- Claude Code: `webstudio connect claude`\n- Codex: `webstudio connect codex`\n- Cursor: `webstudio connect cursor`\n- VS Code or GitHub Copilot: `webstudio connect vscode`\n\nRun the command from the linked project root. If the folder is not linked, ask\nfor an editable Builder share link and run\n`webstudio init --link <share-link> --json`, followed by `webstudio sync`, then\nretry `webstudio connect <client>`. Treat the share link as a credential and do\nnot include it in committed files, logs, screenshots, or issue reports.\n\n`connect` verifies project access before changing client configuration. For\nClaude Code, Cursor, and VS Code it safely merges the `webstudio` server into\nthe client\'s project configuration. For Codex it runs both `codex mcp add` and\n`codex mcp get webstudio`; do not repeat those commands separately. Follow the\nreload, restart, or approval instruction printed by `connect`, then verify the\nloaded MCP connection by asking the client to use Webstudio MCP and list the\nproject pages. Use `--print` only to inspect the generated setup without\nchanging configuration or requiring project access.\n\n## Always\n\n1. webstudio permissions --json\n2. For bounded shell workflows, call MCP tools directly through the CLI shortcut, for example `webstudio meta.index` or `webstudio insert-fragment \'<json>\' --dry-run`. The explicit form `webstudio mcp single-op-call <tool> \'<json>\'` is equivalent and useful when you need to make the MCP boundary obvious. Use `webstudio mcp run \'[{"tool":"components.find","input":{"brief":"button"}}]\'` for multiple calls in one shared CLI session. Use a normal JSON file path for large batches. Use long-running `webstudio mcp` only when your environment is a real MCP client. Do not manually send raw JSON-RPC to `webstudio mcp` from a shell or PTY.\n3. Read MCP `meta.index`, for example `webstudio meta.index`.\n4. Use focused MCP calls with concrete JSON: `webstudio meta.guide \'{"brief":"Create a design system page using every component"}\'`, `webstudio meta.get_more_tools \'{"tools":["insert-fragment"]}\'`, `webstudio components.list \'{"source":"all"}\'`, `webstudio components.coverage-plan`, `webstudio components.search \'{"brief":"radix select"}\'`, `webstudio components.get \'{"component":"@webstudio-is/sdk-components-react-radix:Select"}\'`, `webstudio templates.list`, and `webstudio templates.get \'{"component":"@webstudio-is/sdk-components-react-radix:Select"}\'`.\n5. Read overview resources `webstudio://project/tools-overview` or `webstudio://project/components-overview` when useful. Read full resources `webstudio://project/tools` or `webstudio://project/components` only when focused tools are insufficient.\n6. Pick focused MCP read tool.\n7. Pick semantic MCP write tool.\n\nUse `webstudio schema mcp` for a compact MCP tool overview. Add `--verbose` only when exact input schemas for all tools are truly needed; otherwise prefer focused `meta.get_more_tools` and `components.*` calls.\n\nRun these commands from the linked project root. Use the MCP startup status line\'s absolute root for local files; write temporary scripts and artifacts under `<project root>/.temp`, not under a parent workspace.\n\nMonorepo quick path for a simple styled section:\n\n```sh\nnode packages/cli/local.js mcp single-op-call meta.index\nnode packages/cli/local.js mcp single-op-call meta.get_more_tools \'{"tools":["insert-fragment"]}\'\nnode packages/cli/local.js mcp single-op-call insert-fragment \'{"parentInstanceId":"parent-id","fragment":"<ws.element ws:tag=\\"section\\" ws:style={css`padding: 32px; display: grid; gap: 12px;`}><ws.element ws:tag="h2">Launch Kit</ws.element><ws.element ws:tag="p">A focused section created with Webstudio JSX.</ws.element><ws.element ws:tag="button">Get started</ws.element></ws.element>"}\' --dry-run\n```\n\nThe same local shortcut form is shorter and preferred for simple shell steps:\n\n```sh\nnode packages/cli/local.js meta.index\nnode packages/cli/local.js meta.get_more_tools \'{"tools":["insert-fragment"]}\'\nnode packages/cli/local.js insert-fragment \'{"parentInstanceId":"parent-id","fragment":"<ws.element ws:tag=\\"section\\" ws:style={css`padding: 32px; display: grid; gap: 12px;`}><ws.element ws:tag="h2">Launch Kit</ws.element><ws.element ws:tag="p">A focused section created with Webstudio JSX.</ws.element><ws.element ws:tag="button">Get started</ws.element></ws.element>"}\' --dry-run\n```\n\nFor this simple path, do not grep source files, dump full MCP resources, or write parser scripts first. Use `list-pages`, `get-page-by-path`, or `list-instances` only to get the target `parentInstanceId`.\n\nWhen authoring JSX for `insert-fragment`, use Webstudio component helpers and Webstudio style syntax. Use `ws:style={css\\`...\\`}`for Webstudio-native CSS, or use React-style object syntax such as`style={{ padding: 24 }}` when that is simpler. Both forms create editable Webstudio style data.\n\nWhen the task says another user will edit a page in Content mode, use a Content Block (`ws:block`) around every editable region. Content-mode users can edit text and supported props only in descendants of that block; content outside it is read-only. Put reusable insertable options in the block\'s `ws:block-template` child. Do not put intended editor content inside that template container: templates are protected source material, while an inserted template copy becomes an editable direct child of the Content Block. Verify this structure before handoff.\n\nDo not access host globals or dynamic code APIs in JSX fragments, including `process`, `globalThis`, `eval`, `Function`, or `constructor`. JSX fragments are declarative project data; use the built-in Webstudio helpers instead.\n\nUse Webstudio prop names in JSX: `class`, `for`, `aria-label`, and other HTML/Webstudio names. Do not use React-only aliases such as `className` or `htmlFor`; the runtime rejects them with the Webstudio prop name to use.\n\nUse Webstudio actions for event/action props. Do not pass JavaScript functions such as `onClick={() => ...}`; the runtime rejects them because functions cannot be persisted as Webstudio project data.\n\n```tsx\n<ws.element\n ws:tag="button"\n onClick={new ActionValue(["event"], expression`console.log(event)`)}\n>\n Open\n</ws.element>\n```\n\nPlain JSX prop values must be JSON-compatible: `null`, strings, booleans, finite numbers, arrays, and plain objects. Do not pass `undefined`, `Symbol`, `BigInt`, `NaN`, `Infinity`, `Date`, `Map`, `Set`, class instances, or circular objects; omit the prop, use plain data, or use `expression`/`ActionValue` when the value is dynamic.\n\nIf a component has a registered template with required parts, JSX must include those parts explicitly under the same parent structure as the template, for example `<radix.Switch><radix.SwitchThumb /></radix.Switch>`. Use `insert-component` when you want Webstudio to apply one component template automatically.\n\n## Animation Components\n\nBefore creating animation examples, inspect the exact components with focused discovery:\n\n```sh\nwebstudio components.get \'{"component":"@webstudio-is/sdk-components-animation:AnimateChildren"}\'\nwebstudio components.get \'{"component":"@webstudio-is/sdk-components-animation:AnimateText"}\'\nwebstudio components.get \'{"component":"@webstudio-is/sdk-components-animation:StaggerAnimation"}\'\nwebstudio components.get \'{"component":"@webstudio-is/sdk-components-animation:VideoAnimation"}\'\n```\n\nUse Animation Group (`AnimateChildren`) as the controller. Put normal instances directly inside it, or put Text Animation, Stagger Animation, or Video Animation directly inside it. Text, Stagger, and Video are helper components with `contentModel.category: "none"` and should not be used as standalone section roots.\n\nDefine timing and CSS changes on the Animation Group `action` prop. Use `type:"view"` for viewport entry/exit progress and `type:"scroll"` for scroll-progress timelines. For in animations, keep the canvas styles as the final state and use `fill:"backwards"` with keyframes that describe the starting state. For out animations, use `fill:"forwards"` with keyframes that describe the ending state.\n\nText Animation settings: `slidingWindow` defaults to `5`, `easing` defaults to `linear`, and `splitBy` defaults to `char`. Use `splitBy:"space"` for word-by-word animation. The parent Animation Group keyframes provide the actual opacity, translate, scale, or other styles.\n\nStagger Animation settings: `slidingWindow` defaults to `1` and `easing` defaults to `linear`. It applies parent Animation Group progress across its direct children. Use `slidingWindow:0` for instant sequential steps, `1` for one child at a time, and values above `1` for overlapping waves.\n\nVideo Animation settings: `timeline` is a boolean. Prefer `insert-component` for Video Animation so the Video child template is inserted, then configure the Video child asset/source. Use short, seek-friendly videos for smooth scroll-linked playback.\n\nUse JSX fragments for authored animation structures when you need styled, editable examples. Put the final visual state in `ws:style` and put the starting or ending animated state in the Animation Group `action` keyframes. Include an explicit `offset` on every keyframe: use `offset: 0` for starting-state keyframes with `fill:"backwards"` and `offset: 1` for ending-state keyframes with `fill:"forwards"`.\n\n```tsx\n<animation.AnimateChildren\n action={{\n type: "view",\n axis: "block",\n animations: [\n {\n name: "Fade up on entry",\n timing: {\n fill: "backwards",\n rangeStart: ["entry", { type: "unit", value: 0, unit: "%" }],\n rangeEnd: ["entry", { type: "unit", value: 100, unit: "%" }],\n },\n keyframes: [\n {\n offset: 0,\n styles: {\n opacity: { type: "unit", value: 0, unit: "number" },\n translate: {\n type: "tuple",\n value: [\n { type: "unit", value: 0, unit: "number" },\n { type: "unit", value: 24, unit: "px" },\n ],\n },\n },\n },\n ],\n },\n ],\n }}\n>\n <ws.element\n ws:tag="section"\n ws:style={css`\n display: grid;\n gap: 16px;\n padding: 48px;\n border-radius: 24px;\n background: #111827;\n color: white;\n `}\n >\n <ws.element ws:tag="h2">Launch metrics</ws.element>\n <ws.element ws:tag="p">\n A polished card that fades up as it enters the viewport.\n </ws.element>\n </ws.element>\n</animation.AnimateChildren>\n```\n\nFor Text Animation, keep `animation.AnimateText` as the direct child of Animation Group and place the text-containing element inside it:\n\n```tsx\n<animation.AnimateChildren\n action={{\n type: "view",\n animations: [\n {\n name: "Parallax In",\n timing: {\n fill: "backwards",\n rangeStart: ["cover", { type: "unit", value: 0, unit: "%" }],\n rangeEnd: ["cover", { type: "unit", value: 70, unit: "%" }],\n },\n keyframes: [\n {\n offset: 0,\n styles: {\n translate: {\n type: "tuple",\n value: [\n { type: "unit", value: 0, unit: "number" },\n { type: "unit", value: 100, unit: "px" },\n ],\n },\n },\n },\n ],\n },\n {\n name: "Opacity In",\n timing: {\n fill: "backwards",\n rangeStart: ["cover", { type: "unit", value: 0, unit: "%" }],\n rangeEnd: ["cover", { type: "unit", value: 70, unit: "%" }],\n },\n keyframes: [\n {\n offset: 0,\n styles: {\n opacity: { type: "unit", value: 0, unit: "number" },\n },\n },\n ],\n },\n {\n name: "Scale In",\n timing: {\n fill: "backwards",\n rangeStart: ["cover", { type: "unit", value: 0, unit: "%" }],\n rangeEnd: ["cover", { type: "unit", value: 70, unit: "%" }],\n },\n keyframes: [\n {\n offset: 0,\n styles: {\n scale: {\n type: "tuple",\n value: [\n { type: "unit", value: 5, unit: "number" },\n { type: "unit", value: 5, unit: "number" },\n ],\n },\n },\n },\n ],\n },\n {\n name: "Parallax Out",\n timing: {\n fill: "forwards",\n rangeStart: ["cover", { type: "unit", value: 50, unit: "%" }],\n rangeEnd: ["cover", { type: "unit", value: 100, unit: "%" }],\n },\n keyframes: [\n {\n offset: 1,\n styles: {\n translate: {\n type: "tuple",\n value: [\n { type: "unit", value: 0, unit: "number" },\n { type: "unit", value: -100, unit: "px" },\n ],\n },\n scale: {\n type: "tuple",\n value: [\n { type: "unit", value: 5, unit: "number" },\n { type: "unit", value: 5, unit: "number" },\n ],\n },\n opacity: { type: "unit", value: 0, unit: "number" },\n },\n },\n ],\n },\n ],\n insetStart: { type: "unit", value: 5, unit: "%" },\n insetEnd: { type: "unit", value: 5, unit: "%" },\n isPinned: true,\n }}\n>\n <animation.AnimateText\n splitBy="space"\n slidingWindow={5}\n easing="easeOutQuart"\n >\n <ws.element ws:tag="h2">Animate words with controlled rhythm</ws.element>\n </animation.AnimateText>\n</animation.AnimateChildren>\n```\n\nFor Stagger Animation, put the repeated cards or rows directly inside `animation.StaggerAnimation`:\n\n```tsx\n<animation.AnimateChildren\n action={{\n type: "view",\n animations: [\n {\n timing: {\n fill: "backwards",\n rangeStart: ["contain", { type: "unit", value: 0, unit: "%" }],\n rangeEnd: ["contain", { type: "unit", value: 30, unit: "%" }],\n },\n keyframes: [\n {\n offset: 0,\n styles: {\n opacity: { type: "unit", value: 0, unit: "number" },\n },\n },\n ],\n },\n ],\n }}\n>\n <animation.StaggerAnimation>\n <ws.element\n ws:tag="article"\n ws:style={css`\n padding: 20px;\n border: 1px solid #d1d5db;\n border-radius: 16px;\n `}\n >\n Plan\n </ws.element>\n <ws.element\n ws:tag="article"\n ws:style={css`\n padding: 20px;\n border: 1px solid #d1d5db;\n border-radius: 16px;\n `}\n >\n Build\n </ws.element>\n <ws.element\n ws:tag="article"\n ws:style={css`\n padding: 20px;\n border: 1px solid #d1d5db;\n border-radius: 16px;\n `}\n >\n Launch\n </ws.element>\n </animation.StaggerAnimation>\n</animation.AnimateChildren>\n```\n\nFor Video Animation, use the registered template via `insert-component` when possible. If you author JSX, include the Video child explicitly:\n\n```tsx\n<animation.AnimateChildren\n action={{\n type: "view",\n animations: [\n {\n name: "Video progress",\n timing: {\n fill: "both",\n rangeStart: ["cover", { type: "unit", value: 0, unit: "%" }],\n rangeEnd: ["cover", { type: "unit", value: 100, unit: "%" }],\n },\n keyframes: [{ offset: 0, styles: {} }],\n },\n ],\n }}\n>\n <animation.VideoAnimation timeline={true}>\n <$.Video\n preload="auto"\n autoPlay={true}\n muted={true}\n playsInline={true}\n crossOrigin="anonymous"\n />\n </animation.VideoAnimation>\n</animation.AnimateChildren>\n```\n\n## Command Surface Boundary\n\n- Use top-level `webstudio ...` shell commands for setup, sync/import/build/preview/screenshot, permissions, publish/domains, schema, registry inspection, man, and starting MCP.\n- Use MCP tools for Builder project data manipulation: pages, instances/components, props, text, styles, tokens, variables, resources, assets, breakpoints, redirects, and raw patches.\n- From a shell, call MCP tools with the shortcut form `webstudio <tool> \'<json>\'`, for example `webstudio insert-fragment \'<json>\' --dry-run`. The explicit equivalent is `webstudio mcp single-op-call <tool> \'<json>\'`. Use `--input-file` for large payloads.\n- Inside the Webstudio monorepo, call the local CLI as its own command: `node packages/cli/local.js ...`. Do not wrap the CLI call in `pwd && ...`, command substitution, `pnpm exec webstudio`, `pnpm --filter webstudio exec webstudio`, or a global `webstudio`.\n- For experiments, pass `--dry-run` to local-capable mutation calls. Read the computed transaction from `meta.session.transaction` and its base build version from `meta.session.version`. Copying a `.webstudio` folder is not an isolated project clone; `.webstudio/config.json` still points to the same remote project, so non-dry-run mutations can commit to that project.\n- For bounded multi-step shell work, run inline JSON with `webstudio mcp run \'[{"tool":"components.find","input":{"brief":"button"}}]\'`; this reuses one CLI session without raw JSON-RPC. For large batches, write `{ "calls": [{ "tool": "..." }] }` to a normal JSON file and run `webstudio mcp run .temp/mcp-calls.json`.\n- Use JSON strings for `brief` fields. Never pass boolean flags such as `{"brief":true}`.\n- Treat `webstudio mcp single-op-call` and `webstudio mcp run` stderr lines as progress checkpoints; stdout remains JSON on both success and failure. On failure, parse stdout for `{ "ok": false, "error": { "code": "...", "message": "..." } }` before deciding what to fix.\n- If a CLI/MCP tool crashes, hangs, gives a confusing error, needs an undocumented workaround, or forces source-code inspection for normal usage, ask the user to report it in Discord `#help` at https://wstd.us/community. Give them a complete copy-paste report with the goal, expected behavior, actual error, exact command/tool call, stdout JSON, stderr/lifecycle logs, environment, workaround, and secrets redacted.\n- Run one-shot `webstudio mcp single-op-call` commands sequentially against a linked `.webstudio` folder. If a command returns `PROJECT_SESSION_BUSY`, another CLI/MCP process is updating the local session; wait a moment and retry sequentially.\n- In delegated or non-streaming agent environments, do not batch many MCP calls silently and do not wrap many shortcut or `webstudio mcp single-op-call` commands in a shell loop. Treat each parent-visible checkpoint as the unit of work. If the parent asks for status within 30 seconds, run exactly one shortcut command such as `webstudio meta.index` or one explicit `webstudio mcp single-op-call` command, report that command/result, then wait for the parent to continue. Do not take a broad task such as creating a full design-system page as one execution unit. Call `workflow.next {"goal":"design-system-page"}`, report the returned phase/checkpoint, wait until the parent continues, call `checkpoint.ack {"reported":true,"continueAfterReport":true,"summary":"<what you reported>"}`, complete exactly that bounded phase, and return: discovery, page creation, one dry-run JSX section, one committed JSX section, one `components.coverage-insert-next` call, or one presentation pass. Phase commands do not include nextPhase in their own output. After the parent continues, acknowledge the previous checkpoint first, then call `workflow.next` with the next phase. For all-component design-system pages, checkpoint after workflow planning, discovery, page creation, call `components.coverage-insert-next` once before checkpointing again, then finish with `workflow.next {"goal":"design-system-page","phase":"presentation-pass"}`. Coverage 72/72 is necessary but not sufficient: the page must be organized into styled, real-world examples, not raw unstyled component dumps.\n- For design-system or “use every component” tasks, start with compact `webstudio components.coverage-plan`, checkpoint, then request component coverage details with `webstudio components.coverage-plan \'{"detail":"roots","offset":20}\'` or `{"detail":"parts"}` only when needed. Do not pass `detail` to `list-pages`; use `list-pages {}` or `get-page-by-path` for page lookup.\n- MCP tool shortcuts are only for MCP tools. If a shortcut is ambiguous with a real top-level command, the real top-level command wins; use `webstudio mcp single-op-call <tool> \'<json>\'` to force the MCP path.\n\n## LLM Implementation Process\n\nUse this process for user requests that change Webstudio content, layout, styles, assets, pages, redirects, resources, or publishing state:\n\n1. Discover capabilities with `webstudio man --json`, `webstudio schema api`, `webstudio schema mcp`, MCP `meta.index`, `meta.guide`, `meta.get_more_tools`, `components.list`, `components.summary`, `components.coverage-plan`, `components.search`, `components.get`, `templates.list`, and `templates.get`. From a shell, prefer shortcut calls such as `webstudio meta.index` and `webstudio components.search \'{"brief":"button"}\'` for these focused tool calls; use `webstudio mcp single-op-call` when you need the explicit MCP form. Read full resources such as `webstudio://project/tools` and `webstudio://project/components` only when needed. Do not write scripts to parse full MCP discovery JSON for normal lookup.\n2. Inspect current project state with semantic reads such as `get-project-settings`, `list-pages`, `get-page-by-path`, `list-instances`, `inspect-instance`, `get-styles`, `list-assets`, `list-breakpoints`, and `snapshot` only when needed. Before changing a project, read `get-project-settings` and follow any non-empty `meta.agentInstructions`. These are shared project instructions, not a place for secrets.\n3. Mutate the Webstudio project with semantic MCP write tools first. Prefer MCP `insert-fragment` for authored/styled sections, use `insert-component` only for one automatic component template, then `update-text`, `update-props`, `update-styles`, `upload-asset`, `create-page`, and page/project settings tools over raw patches.\n4. Use `apply-patch` only when no semantic tool covers the required change, and only after reading the latest snapshot/version.\n5. For visual/design work, regenerate or preview the generated app, capture a screenshot, inspect it with vision, and iterate before final response.\n6. Report what changed and what verification ran.\n\n## Visual Design Workflow\n\nFor requests involving visible HTML/CSS, layout, typography, colors, imagery, responsive behavior, or screenshots:\n\n1. Read editable Webstudio structure first: pages, instances, props, styles, breakpoints, assets, and relevant text.\n2. Do not use generated route/component files as the source of truth for editable content.\n3. Make edits through Webstudio semantic commands/MCP tools so the result stays editable in Builder and survives the next `webstudio build`.\n4. Keep generated project files current, start preview, and capture the changed page with `screenshot`.\n5. Use `screenshot.diff` when a baseline exists and inspect screenshot/diff artifacts with vision before finishing.\n6. If vision or screenshot tooling is unavailable, state that explicitly and explain what fallback verification was used.\n\n## Responsive Verification Workflow\n\nFor responsive page work, use Builder breakpoints as the source of truth:\n\n1. Read breakpoints with `list-breakpoints` before deciding responsive behavior.\n2. Apply responsive styles with existing Builder breakpoint ids; do not invent CSS media queries or breakpoint names when Webstudio breakpoint data exists.\n3. Pick screenshot viewport widths from the project breakpoints: include a desktop width, each defined max-width or min-width edge, and a narrow mobile width.\n4. Capture each viewport with `screenshot`, for example `{"path":"/","output":"home-375.png","viewport":{"width":375,"height":812}}` and `{"path":"/","output":"home-1440.png","viewport":{"width":1440,"height":900}}`.\n5. Inspect every viewport screenshot with vision before finishing, checking layout, overflow, hidden content, text wrapping, and breakpoint-specific style changes.\n6. If any viewport fails, update styles through semantic Webstudio tools and repeat screenshots for the affected breakpoints.\n\n## Generated Files Guardrails\n\n- Do not edit `app/__generated__`, generated route files, generated page files, generated CSS, or build output for normal Webstudio content/design requests.\n- Do not replace generated page components with handcrafted app code unless the user explicitly asks for code-only export customization.\n- Generated files are build artifacts and may be overwritten by `webstudio build`.\n- If a task truly requires generated app customization, keep it outside `app/__generated__` where possible and explain that it is not editable Webstudio content.\n\n## Values vs Bindings\n\nBefore authoring unfamiliar expressions, read `webstudio://project/expressions` with MCP `resources/read` or `webstudio mcp read-resource webstudio://project/expressions`. It documents the supported expression subset, method allowlist, scope, Collection context, and validation limits.\n\n- Use direct value tools for fixed content. For one visible text child, use `update-text` with plain `text`. For a bounded multi-instance literal replacement, use `replace-text` with `find`, `replace`, `pagePath` or `pageId`, and `limit`; it does not change expression children. Use `replace-prop-text` for bounded changes inside static string props, optionally limited to prop names or instance ids; it never changes dynamic bindings. For static props such as `aria-label`, `alt`, `id`, `class`, `href`, or button labels stored as props, use `update-props` with the prop\'s direct type/value.\n- Use `bind-props` only when the prop must stay dynamic: an expression, resource result, action, or existing scoped runtime context such as `system`. Do not use `bind-props` just to set a fixed string.\n- Direct prop string example: `{"updates":[{"instanceId":"button-id","name":"aria-label","type":"string","value":"Open menu"}]}`.\n- Expression binding example: `{"bindings":[{"instanceId":"link-id","name":"href","binding":{"type":"expression","value":"currentPost.url"}}]}`.\n- Page metadata fields such as `title`, `description`, `language`, `redirect`, and custom meta content accept plain fixed text. For computed values, pass JavaScript expression code such as `pageTitle ?? "Pricing | Acme"`.\n- Page `status` accepts a fixed HTTP status code as a number from 200 through 599, for example `302`. For a dynamic status, pass JavaScript expression code such as `system.status`.\n- Page metadata update example: use `update-page` with `{"pageId":"page-id","values":{"title":"Pricing | Acme","meta":{"description":"Plans for teams"}}}`.\n- Draft a page with `update-page` and `{"pageId":"page-id","values":{"isDraft":true}}`. It remains editable and previewable but is omitted from every publish target, including staging, and from sitemap output.\n- Stage a draft page for a future publish with `{"pageId":"page-id","values":{"isDraft":false}}`. This clears draft state but does not deploy the site. The home page and `/*` catch-all page cannot be drafts.\n- Resource `url` accepts plain fixed URLs and paths. For computed URLs, pass JavaScript expression code such as `"https://api.example.com/items?tag=" + filters.tag`. Resource header values, search parameter values, and text bodies accept expressions for dynamic values; for fixed text, use `{ "type": "literal", "value": "application/json" }`.\n- Resource update example: use `update-resource` with `{"resourceId":"resource-id","values":{"url":"https://api.example.com/items"}}`.\n- Data variable values support `string`, `number`, `boolean`, `string[]`, and `json`. Use `string[]` only for arrays where every item is a string; use `json` for objects, mixed arrays, filters, and nested data.\n- Parameters are internal scoped runtime values from pages, collections, or components. They are not a public authoring surface: do not create, update, or delete parameter records. Public tools should preserve existing parameter records and may reference documented context values such as `system` in expressions where they are already in scope.\n- Use scoped resources for read data. A GET resource created with `scopeInstanceId`/`dataSourceName` defaults to `exposeAsDataSource:true`, becomes a scoped resource data variable, is generated into the page resource `data` map, and may be loaded while rendering the page. Read the loaded resource result from its wrapper, usually `.data`.\n- Use prop-bound resources for actions. A resource created without `scopeInstanceId` and bound to a component prop such as Form `action` with `bind-props` and `binding.type: "resource"` becomes an action resource in the page resource `action` map. Use this for POST, PUT, DELETE, webhooks, GraphQL submissions, and anything that should run only from an explicit form/action flow.\n- POST, PUT, and DELETE resources default to `exposeAsDataSource:false`, even with a scope. Set `exposeAsDataSource:true` only for an intentional render-time read such as a GraphQL POST query; provide `scopeInstanceId` and inspect the returned warning. Set it to `false` during `update-resource` to detach existing render-time exposure.\n- For dynamic resource query parameters prefer `searchParams`, for example `{"name":"tag","value":"filters.tag"}`. Use `{"type":"literal","value":"website"}` for fixed request text. Header values can be expressions such as `"\\"Bearer \\" + auth.token"`. Body can be an object expression, including GraphQL payloads such as `{ query: "...", variables: { slug: system.params.slug } }`.\n- Resource methods are `get`, `post`, `put`, and `delete`. Optional resource controls are `graphql` and `system`. Use `control:"graphql"` for GraphQL POST resources with query bodies. Use `control:"system"` for built-in local resource URLs such as `"/$resources/current-date"` and for resources reading the built-in `system` parameter. The built-in system fields are `system.origin`, `system.pathname`, `system.params`, and `system.search`; do not use `system.path`.\n- Whenever an array or object from a resource or data variable should render repeated UI, call `insert-collection` with the complete iterable and one repeated-item JSX root. The command creates the Collection, private item parameters, iterable binding, and descendant item bindings atomically. Use `collectionItem` and `collectionItemKey` expressions in the item JSX. Wrap multiple repeated siblings in one Element, and give repeated Radix items stable unique `value` bindings.\n- Expressions are single JavaScript expressions, not statements or functions. Functions, arrow functions, classes, `new`, `this`, `await`, imports, arbitrary calls, increment/decrement, and assignment outside actions are unsupported. Prefer optional chaining, nullish coalescing, ternaries, property/index access, operators, and the documented string/array methods.\n\n## Pick Read Command\n\n{{readFirst}}\n\n## Pick Write Command\n\n{{taskRecipeIndex}}\n\n## Raw Patch Only If Needed\n\n1. Use MCP tool: snapshot.\n2. Write BuildPatchTransaction[].\n3. Use MCP tool: apply-patch.\n\n## MCP Argument Examples\n\nMCP tools receive JSON argument objects, not CLI flags. Use these shapes:\n\n{{mcpArgumentExampleIndex}}\n\n## Rules\n\n- Never guess ids for existing records. Read them first.\n- Never use project ids from user input. Commands use the configured project.\n- Use --refresh before a local-capable command when cached data may be stale.\n- Pass --json only to commands whose help/schema documents it. Do not add --json to top-level commands such as sync unless supported.\n- On VERSION_CONFLICT, read MCP snapshot again, regenerate the patch, then retry.\n- Treat stdout JSON as the API contract and stderr as diagnostics.\n- For visual/design work, verify the rendered result with vision before finishing.\n- Do not edit generated files for normal Webstudio content/design requests.\n- Use direct values for static strings and bindings only for dynamic expressions/resources/actions.\n- Use plain fixed text where documented. Only encode a quoted JavaScript string literal when a field is explicitly documented as an expression-only value.\n- Confirm destructive commands with --confirm only when user requested deletion/unpublish/replacement.\n- Use webstudio schema api for machine-readable top-level command metadata and webstudio schema mcp for MCP tool schemas.\n\n## Known Gaps\n\n{{knownCliGapIndex}}\n',
|
|
230020
230246
|
"manual-mcp": '# Webstudio MCP Manual\n\n`webstudio mcp` starts a stdio MCP server for real MCP clients. Shell users can call MCP tools with the shortcut form `webstudio <tool> \'<json>\'`, for example `webstudio meta.index` or `webstudio insert-fragment \'<json>\' --dry-run`. `webstudio mcp single-op-call` is the explicit equivalent and prints the structured JSON result. `webstudio mcp run` runs multiple MCP tool calls from inline JSON or a normal JSON file in one shared CLI session. Do not manually type or pipe raw JSON-RPC frames into `webstudio mcp` from an interactive shell or PTY.\n\n## Startup\n\nIf you are already working with an agent, ask it to connect the current folder\nto Webstudio. Give the editable Builder share link only when the trusted agent\nasks for it. The agent should perform the steps below, follow any\nclient-specific output from `webstudio connect`, and verify the connection by\nlisting the project pages. Treat the share link as a credential: do not include\nit in committed files, screenshots, logs, or issue reports.\n\n1. Configure a project with `webstudio init --link <api-share-link> --json`.\n2. Synchronize it with `webstudio sync`.\n3. Generate the client configuration with `webstudio connect claude`,\n `webstudio connect codex`, `webstudio connect cursor`, or\n `webstudio connect vscode`. Use `--print` to preview the generated setup.\n4. Check capabilities with `webstudio permissions --json`.\n5. For shell-driven agents, use shortcut calls such as `webstudio meta.index` and `webstudio insert-fragment \'<json>\' --dry-run` for individual MCP tool calls. Use the explicit equivalent `webstudio mcp single-op-call <tool> \'<json>\'` when you need to force the MCP path, or `webstudio mcp run \'[{"tool":"components.find","input":{"brief":"button"}}]\'` for bounded multi-call workflows. Use `webstudio mcp run .temp/mcp-calls.json` for large batches.\n6. For MCP clients, start the server with `webstudio mcp`.\n7. Start discovery with `meta.index`, then call focused tools with concrete JSON, for example `webstudio mcp single-op-call meta.guide \'{"brief":"Create a design system page using every component"}\'`.\n\nAfter linking and synchronization, run `webstudio connect <client>`, reload or\nrestart the client, then ask the agent to use Webstudio MCP to list the project\npages. The supported client names are `claude`, `codex`, `cursor`, and `vscode`.\nFor Codex, `connect` registers and verifies the server through the Codex CLI;\nthe resulting server appears in Codex settings. Use `--print` to inspect the\nexact registration command without changing configuration or requiring project\naccess. Before changing client configuration, `connect` verifies that the saved\nproject endpoint is reachable and its credential is accepted. If verification\nfails, follow the specific connection, compatibility, or relinking guidance in\nthe error.\n\nStart MCP from the linked Webstudio project root. The lifecycle status line prints that absolute root; create local scripts, screenshots, and temporary artifacts under that root, for example `<project root>/.temp/script.mjs`. If the shell starts in a parent workspace, `cd` into the project root first or use absolute paths.\n\nWhen developing inside the Webstudio monorepo, start the local CLI exactly as `node packages/cli/local.js mcp` from the repo root. Do not use `pnpm exec webstudio`, `pnpm --filter webstudio exec webstudio`, or a global `webstudio`: they can resolve an older binary.\n\nWhile the server is running, stdout is reserved for MCP JSON-RPC messages. Do not print human text from the server process. The server advertises MCP `logging` capability and emits sparse `notifications/message` logs for ready state and tool lifecycle checkpoints such as `tool preview.start started`, `tool preview.start still running after 10000ms`, and `tool preview.start succeeded in 1234ms`; stderr also mirrors these sparse lifecycle fallback lines prefixed with `[webstudio mcp]`.\n\n## One-Shot Tool Calls\n\nUse the shortcut `webstudio <tool> \'<json>\'` when you are operating from a shell and need one MCP tool result. The explicit form `webstudio mcp single-op-call <tool> \'<json>\'` is equivalent and avoids writing temporary Node.js stdio client scripts.\n\nExamples:\n\n```sh\nwebstudio mcp single-op-call meta.index\nwebstudio mcp single-op-call meta.guide \'{"brief":"Create a design system page using every component"}\'\nwebstudio mcp single-op-call meta.get_more_tools \'{"tools":["insert-fragment"]}\'\nwebstudio mcp single-op-call components.list \'{"source":"all"}\'\nwebstudio mcp single-op-call components.coverage-plan\nwebstudio mcp single-op-call components.search \'{"brief":"radix select"}\'\nwebstudio mcp single-op-call components.get \'{"component":"@webstudio-is/sdk-components-react-radix:Select"}\'\nwebstudio mcp single-op-call templates.list\nwebstudio mcp single-op-call templates.get \'{"component":"@webstudio-is/sdk-components-react-radix:Select"}\'\nwebstudio mcp single-op-call insert-fragment --input-file .temp/insert-fragment.json\n```\n\nShortcut equivalents:\n\n```sh\nwebstudio meta.index\nwebstudio meta.guide \'{"brief":"Create a design system page using every component"}\'\nwebstudio meta.get_more_tools \'{"tools":["insert-fragment"]}\'\nwebstudio components.list \'{"source":"all"}\'\nwebstudio components.coverage-plan\nwebstudio components.search \'{"brief":"radix select"}\'\nwebstudio components.get \'{"component":"@webstudio-is/sdk-components-react-radix:Select"}\'\nwebstudio templates.list\nwebstudio templates.get \'{"component":"@webstudio-is/sdk-components-react-radix:Select"}\'\nwebstudio insert-fragment --input-file .temp/insert-fragment.json\n```\n\nRules:\n\n- Inside the Webstudio monorepo, replace `webstudio` in the examples above with `node packages/cli/local.js`, for example `node packages/cli/local.js meta.index`.\n- For a simple authored/styled section, run `meta.index`, then `meta.get_more_tools \'{"tools":["insert-fragment"]}\'`, then `insert-fragment`. Do not grep source files, dump full MCP resources, or write parser scripts first.\n- In `insert-fragment` JSX, use `ws:style={css\\`...\\`}`for Webstudio-native CSS, or use React-style object syntax such as`style={{ padding: 24 }}` when that is simpler. Both forms create editable Webstudio style data.\n- Prefer JSX for authored/styled content. Common `insert-fragment` inputs:\n\n```jsonl\n{"parentInstanceId":"root-id","fragment":"<ws.element ws:tag=\\"section\\" ws:style={css`padding: 32px; display: grid; gap: 16px;`}><ws.element ws:tag="h2">Northstar Product OS</ws.element><ws.element ws:tag="p">Reusable patterns for teams.</ws.element></ws.element>"}\n{"parentInstanceId":"root-id","fragment":"<ws.element ws:tag=\\"section\\" style={{ padding: 32, borderRadius: 16 }}><ws.element ws:tag="h2">Operations Console</ws.element><ws.element ws:tag="p">React-style object styles become editable Webstudio styles.</ws.element></ws.element>"}\n{"parentInstanceId":"root-id","fragment":"<ws.element ws:tag=\\"section\\" ws:tokens={[token(\\"accent\\", css`color: #0f766e;`)]}><ws.element ws:tag="button" onClick={new ActionValue([\\"event\\"], expression`console.log(event)`)}>Track launch</ws.element></ws.element>"}\n{"parentInstanceId":"root-id","fragment":"<ws.element ws:tag=\\"section\\"><radix.Switch><radix.SwitchThumb /></radix.Switch></ws.element>"}\n```\n\n- Do not access host globals or dynamic code APIs in JSX fragments, including `process`, `globalThis`, `eval`, `Function`, or `constructor`.\n- Use Webstudio prop names such as `class` and `for`; do not use React aliases `className` or `htmlFor`.\n- Use Webstudio actions for event/action props, for example `onClick={new ActionValue(["event"], expression\\`console.log(event)\\`)}`. Do not pass JavaScript functions such as `onClick={() => ...}`.\n- Plain prop values must be JSON-compatible: `null`, strings, booleans, finite numbers, arrays, and plain objects. Do not pass `undefined`, `Symbol`, `BigInt`, `NaN`, `Infinity`, `Date`, `Map`, `Set`, class instances, or circular objects; omit the prop, use plain data, or use `expression`/`ActionValue` when the value is dynamic.\n- Template-backed components used in JSX must include required child/part components explicitly under the same parent structure as the template, for example `<radix.Switch><radix.SwitchThumb /></radix.Switch>`. Use `insert-component` when you want one automatic registered component template.\n- The positional input is JSON and defaults to `{}`.\n- Use `--input-file` for large mutation payloads.\n- Use `--dry-run` with local-capable mutation tools when you need a patch plan without committing. The computed transaction is returned in `meta.session.transaction`, and `meta.session.version` is its base build version. Copying a `.webstudio` folder is not an isolated project clone; `.webstudio/config.json` still points to the same remote project, so non-dry-run mutations can commit to that project.\n- The command prints JSON to stdout for both success and failure. Success uses the same `structuredContent` shape MCP tools return: `{ "ok": true, "data": ..., "meta": ... }`. Failure prints `{ "ok": false, "error": { "code": "...", "message": "..." }, "meta": ... }` and exits nonzero.\n- The command writes sparse progress to stderr, including start, success/failure, elapsed time, and committed status when the tool returns session metadata.\n- Invalid argument types fail loudly with path-specific messages, for example `meta.guide input.brief must be a string when provided`.\n- Run one-shot shortcut or `mcp single-op-call` commands sequentially against the same linked `.webstudio` folder. If you receive `PROJECT_SESSION_BUSY`, another CLI/MCP process is updating the local session; wait a moment and retry sequentially.\n- To work with another previously linked project without changing the directory\'s default link, start MCP or a shell call with `--project <projectId>`, for example `webstudio mcp --project <projectId>` or `webstudio mcp single-op-call list-pages --project <projectId>`. Selected projects use isolated local session and checkpoint files.\n- If you are a delegated agent and your parent cannot see live stderr/stdout, do not run a long sequence of shortcut or `mcp single-op-call` commands silently and do not wrap many calls in a shell loop. Treat each parent-visible checkpoint as the unit of work. If the parent asks for status within 30 seconds, run exactly one `webstudio <tool>` or `webstudio mcp single-op-call` command, report that command/result, then wait before the next MCP command. For all-component design-system pages, checkpoint after discovery, checkpoint after page creation, call `components.coverage-insert-next` once before checkpointing again, then finish with the `presentation-pass` workflow phase. Coverage alone is not completion; organize examples into styled sections/cards.\n\n## Reporting CLI/MCP Issues\n\nIf a CLI/MCP tool gives a confusing error, crashes, hangs, produces invalid output, requires an undocumented workaround, or makes you inspect source code to understand normal usage, ask the user to report it in the Webstudio Discord `#help` channel: https://wstd.us/community.\n\nGive the user a complete copy-paste report. Include only non-secret values: never include auth tokens, private URLs, cookies, API keys, passwords, or proprietary project data. Redact them as `<redacted>`.\n\nCopy-paste template:\n\n````md\nWebstudio CLI/MCP issue report\n\nWhat I was trying to do:\n<short user goal, for example "Create a resource from an external API and render it in a collection">\n\nWhat I expected:\n<what should have happened>\n\nWhat happened instead:\n<exact error, confusing behavior, hang, missing docs, or workaround required>\n\nCommand/tool used:\n\n```sh\n<exact command or MCP tool call, with tokens/secrets redacted>\n```\n\nStructured output / error:\n\n```json\n<stdout JSON or MCP structuredContent, if available, with secrets redacted>\n```\n\nStderr / lifecycle logs:\n\n```txt\n<stderr lines, timings, checkpoint messages, or stack trace, with secrets redacted>\n```\n\nEnvironment:\n\n- CLI command path: <webstudio / node packages/cli/local.js / other>\n- Webstudio CLI version: <from command output if known>\n- OS: <macOS / Windows / Linux / unknown>\n- Node version: <node -v if known>\n- Project/session state: <linked project, local .webstudio session, preview, MCP server, or unknown>\n\nWorkaround tried:\n<what the agent/user tried next, and whether it worked>\n\nWhy this should be improved:\n<one sentence: better error message, docs, schema, tool behavior, etc.>\n````\n\n## Shared-Session Shell Runs\n\nUse `webstudio mcp run \'[{"tool":"components.find","input":{"brief":"button"}}]\'` when you are operating from a shell and need several MCP tool calls to share one CLI session without hand-writing JSON-RPC. For large batches, pass a normal JSON file path such as `.temp/mcp-calls.json`. Do not use shell process substitution like `<(...)`; use inline JSON or a real file.\n\nUse `mcp run` for long-lived tools such as `preview.start`. A one-shot `mcp single-op-call preview.start` cannot keep ownership of a preview server for a later screenshot or stop call. Put `preview.start`, `screenshot`, and `preview.stop` in one shared `mcp run` process, or use a real long-running MCP client.\n\nInput shape:\n\n```json\n{\n "calls": [\n { "tool": "meta.index" },\n { "tool": "components.find", "input": { "brief": "radix select" } }\n ]\n}\n```\n\nRules:\n\n- The command prints JSON to stdout for both success and failure. It stops at the first failed call and prints partial results in `{ "ok": false, "error": ..., "data": { "completedCalls": ..., "results": [...] }, "meta": ... }`, then exits nonzero.\n- If a call returns `checkpoint.required`, read-only discovery and inspection remain available, but mutations and state-changing session tools return `CHECKPOINT_REQUIRED`. Stop and report the checkpoint to the parent/user. Only after the parent/user continues, call `checkpoint.ack {"reported":true,"continueAfterReport":true,"summary":"<what you reported>"}` before continuing mutations.\n- For `mcp single-op-call`, checkpoint requirements persist across later one-shot CLI processes until you call `checkpoint.ack {"reported":true,"continueAfterReport":true,"summary":"<what you reported>"}`.\n- Use this instead of manually sending JSON-RPC frames to `webstudio mcp` from a shell.\n\n### Cross-project batches\n\nAdd `projects` to the same `mcp run` manifest to run focused reads, audits, or dry runs across independently linked project roots:\n\n```json\n{\n "concurrency": 2,\n "calls": [\n { "tool": "status" },\n { "tool": "audit", "input": {} },\n {\n "tool": "update-project-settings",\n "input": { "meta": { "siteName": "Reviewed" } },\n "dryRun": true\n }\n ],\n "projects": [\n { "id": "site-a", "root": "../site-a" },\n { "id": "site-b", "root": "../site-b" }\n ]\n}\n```\n\nProject roots and an optional `progressFile` are resolved relative to the manifest file. Each project may provide its own `calls` instead of using the top-level calls. Each root must already be linked with its own `.webstudio/config.json`; the runner creates an independently authenticated ProjectSession and uses root-scoped session, audit, preview-data, and checkpoint paths without changing the process working directory.\n\nConcurrency defaults to 2, is capped at 16, and can be set in the manifest or overridden with `--concurrency`. A failure is reported for that project while other projects continue. Progress is saved after every successful call; rerunning with the default `--resume` skips completed projects and starts failed projects after their last confirmed successful call. Reads and dry runs may be retried. A committed mutation interrupted after dispatch is marked `AMBIGUOUS_MUTATION_RESULT` and is never replayed automatically; inspect that project before deciding how to continue. Use `--no-resume` only to intentionally start the complete manifest over.\n\nCommitted mutation tools are rejected in a projects batch unless the command includes `--approve-mutations`. Review the complete manifest before granting approval. `--dry-run` applies to every call and does not require mutation approval. The final stdout object is compact: project counts, one status/error record per project, elapsed time, and the progress-file path rather than every tool result.\n\n## Discovery\n\nUse MCP itself after startup, or call the same tools with `webstudio mcp single-op-call`:\n\n- `tools/list`: machine-readable available tools\n- `resources/list`: available overview and full JSON resources\n- `meta.index`: concise capability catalog\n- `meta.guide`: workflow for a user goal; call with a string brief such as `{"brief":"Create a pricing page"}`\n- `meta.get_more_tools`: detailed params, examples, namespaces, and local/server behavior; prefer exact names such as `{"tools":["insert-fragment"]}` when you know them\n- `components.list`: compact registry metadata for visible components and templates; use a focused get tool for complete details\n- `components.summary`: component counts by default; use `{"detail":"components","limit":20}` for paginated entries\n- `components.coverage-plan`: compact paged plan for design-system coverage tasks that need every component; default returns counts plus the first root page, use `{"detail":"roots"}`, `{"detail":"parts"}`, or `{"detail":"full"}` for more\n- `components.coverage-status`: page-specific covered/missing component report with `missingRoots` and `missingParts`\n- `components.search`: focused component/template search by id, namespace, label, category, or content model\n- `components.find`: compatibility alias for focused component search\n- `components.get`: full metadata for one component id\n- `templates.list`: compact metadata for template-backed insertions only\n- `templates.get`: full registry item and payload metadata for one template\n\nComponent and template registry items use a shadcn-compatible top-level shape plus Webstudio-specific superset metadata in `meta`. Use `meta.runtime` for component ids, props, states, content model, and source identity; `meta.authoring` for composition and accessibility guidance; and `meta.builder` for template insertion details and expected project-data namespaces. These items are for Builder/MCP discovery and are not a published shadcn install registry yet.\n\nPrefer the focused `components.*` tools over dumping `webstudio://project/components`. Do not write local scripts to parse full MCP discovery JSON for common component lookup.\nFor “use every component” or design-system pages, start with compact `components.coverage-plan`, checkpoint, then page through roots/parts instead of dumping the full catalog.\n\n## Consumer Capabilities\n\nMCP lets agents work on one configured Webstudio project at a time. In consumer\nterms, agents can:\n\n- Check which project they are connected to.\n- Check what the share link is allowed to do.\n- Inspect project metadata and the latest editable build.\n- Read selected project data for audits and repair.\n- Apply precise project changes against a known version.\n- List, inspect, create, update, delete, duplicate, copy, and reorder pages.\n- Set the home page.\n- Preserve old page paths for redirects or history.\n- Read and update page titles, descriptions, metadata, auth settings, and SEO fields.\n- List, create, update, duplicate, move, and delete page folders.\n- List, create, update, delete, duplicate, reorder, and reuse page templates.\n- Create pages from reusable templates.\n- Read and update project site settings.\n- Read and update marketplace product metadata.\n- List, create, update, delete, and replace redirects.\n- List, create, update, and delete responsive breakpoints.\n- List and inspect page elements.\n- Insert registered components.\n- Insert styled JSX fragments.\n- Move, reparent, clone, duplicate, wrap, unwrap, convert, rename, retag, and delete elements.\n- Fill grid cells.\n- List and update text children.\n- Update plain text and expression text.\n- Update structured rich text.\n- Add, update, delete, and bind element props.\n- Bind props to expressions, resources, actions, and runtime system values.\n- Read, add, update, delete, and replace local styles.\n- Update selected style-source styles.\n- List, create, update, attach, detach, extract, duplicate, rename, lock, unlock, reorder, clear, and delete design tokens and style sources.\n- List, define, rename, delete, and rewrite CSS variables.\n- List, create, update, and delete static data variables.\n- Create string, number, boolean, string list, and JSON variables.\n- Delete unused data variables.\n- List, create, update, upsert, bind, and delete resources.\n- Create HTTP resources.\n- Create GraphQL resources.\n- Create system resources.\n- Use built-in system resources for sitemap, current date, and assets.\n- List and inspect complete asset metadata; upload, download, update, move, duplicate, find usage for, replace, and delete assets.\n- List, create, rename, move, recursively duplicate, and recursively delete nested asset folders.\n- Publish to staging or production.\n- Publish to selected domains.\n- List publish builds.\n- Check publish job status.\n- Unpublish staging or production deployments.\n- List, create, update, delete, and verify custom domains.\n- Start and stop preview.\n- Capture screenshots of generated pages.\n- Compare screenshots against baselines.\n- Install OCR support for richer visual checks.\n\nUseful resources:\n\n- `webstudio://project/status`: compact current ProjectSession status\n- `webstudio://project/tools-overview`: small operation overview by capability area\n- `webstudio://project/components-overview`: small component overview with ids, labels, namespaces, and categories\n- `webstudio://project/tools`: full operation catalog; read only when focused metadata is insufficient\n- `webstudio://project/components`: full component catalog with props, states, and content model composition constraints; read only when `components.summary`, `components.find`, and `components.get` are insufficient\n- `webstudio://project/guide`: concise discovery guide\n- `webstudio://project/expressions`: expression syntax, scope, supported methods, bindings, Collection iteration context, and verification\n- `webstudio://project/accessibility-review`: evidence-based LLM accessibility-review workflow using project checks, preview, and screenshots\n\n## MCP SDK Client Imports\n\nWhen writing a local Node.js MCP client script, use the official MCP SDK package and these exact ESM imports:\n\nInside the Webstudio monorepo this package is available at the repo root. In another project, install it first with `pnpm add -D @modelcontextprotocol/sdk`.\n\n```js\nimport { Client } from "@modelcontextprotocol/sdk/client/index.js";\nimport { StdioClientTransport } from "@modelcontextprotocol/sdk/client/stdio.js";\nimport { LoggingMessageNotificationSchema } from "@modelcontextprotocol/sdk/types.js";\n```\n\nMinimal stdio client for the local Webstudio CLI:\n\n```js\nconst client = new Client({ name: "webstudio-agent", version: "1.0.0" });\n\nclient.setNotificationHandler(\n LoggingMessageNotificationSchema,\n (notification) => {\n console.error(`[mcp] ${notification.params.data}`);\n }\n);\n\nconst transport = new StdioClientTransport({\n command: "node",\n args: ["packages/cli/local.js", "mcp"],\n cwd: process.cwd(),\n stderr: "inherit",\n});\n\nawait client.connect(transport);\n\nconst index = await client.callTool({\n name: "meta.index",\n arguments: {},\n});\nconsole.log(JSON.stringify(index.structuredContent, null, 2));\n\nawait client.close();\n```\n\nUse `node packages/cli/local.js mcp` from the Webstudio monorepo root for local development, or `webstudio mcp` from a linked project where the CLI is installed. Keep stdout for JSON-RPC/structured results and surface MCP logging notifications or stderr lifecycle lines as progress.\n\n## Core Rules\n\n- stdout is reserved for MCP JSON-RPC while the server is running.\n- Operate on the configured project only.\n- Read ids before writing.\n- Prefer semantic tools over `apply-patch`.\n- Use `status` and `refresh` when cached namespaces may be stale. Pass `status {"verbose":true}` only when debugging full namespace arrays, freshness, compatibility, or diagnostic details.\n- A mutation is durable only when `meta.session.committed` is true.\n- For visual/design work, verify the rendered result with vision before finishing.\n\n## Vision Verification Loop\n\nVision-capable AI can use MCP to see what it is building:\n\n{{mcpVisionVerificationLoopMarkdown}}\n\nGenerated app setup:\n\n{{mcpGeneratedAppDependencyNotes}}\n\n## MCP Argument Examples\n\nMCP tools receive JSON argument objects:\n\n{{mcpArgumentExampleIndex}}\n\n## Screenshot Verification\n\n{{screenshotVerificationSummary}}\n',
|
|
230021
230247
|
"mcp-startup-epilogue": 'If you are inside the Webstudio monorepo, use the local CLI exactly as `node packages/cli/local.js ...` as your first command path. Do not use `packages/cli/bin.js` for local source-tree work; it is the packaged build entry and may use stale built output.\n\nPlain `webstudio mcp` starts the stdio MCP server for real MCP clients. Do not manually type or pipe raw JSON-RPC frames into it from an interactive shell or PTY. From a shell, use shortcut calls such as `webstudio meta.index` and `webstudio insert-fragment \'<json>\' --dry-run` for one bounded tool call. The explicit equivalent is `webstudio mcp single-op-call <tool> \'<json>\'`. Use `webstudio mcp run \'[{"tool":"components.find","input":{"brief":"button"}}]\'` for small multi-call batches in one shared CLI session. For large batches, pass a normal JSON file path such as `.temp/mcp-calls.json`. Do not use shell process substitution like `<(...)`; use inline JSON or a real file.\n\nPut each local CLI call in its own shell command; do not chain helper commands with `&&`, `;`, command substitution, or shell wrappers around the CLI when reporting a CLI step. Do not use `pnpm exec webstudio`, `pnpm --filter webstudio exec webstudio`, or a global `webstudio`; those can resolve an older binary. For example:\n\n```sh\nnode packages/cli/local.js mcp single-op-call meta.index\nnode packages/cli/local.js mcp single-op-call meta.get_more_tools \'{"tools":["insert-fragment"]}\'\nnode packages/cli/local.js mcp single-op-call insert-fragment \'{"parentInstanceId":"parent-id","fragment":"<ws.element ws:tag=\\"section\\" ws:style={css`padding: 32px; display: grid; gap: 12px;`}><ws.element ws:tag="h2">Launch Kit</ws.element><ws.element ws:tag="p">A focused section created with Webstudio JSX.</ws.element><ws.element ws:tag="button">Get started</ws.element></ws.element>"}\' --dry-run\n```\n\nThe shorter local shortcut form is preferred for simple shell steps:\n\n```sh\nnode packages/cli/local.js meta.index\nnode packages/cli/local.js meta.get_more_tools \'{"tools":["insert-fragment"]}\'\nnode packages/cli/local.js insert-fragment \'{"parentInstanceId":"parent-id","fragment":"<ws.element ws:tag=\\"section\\" ws:style={css`padding: 32px; display: grid; gap: 12px;`}><ws.element ws:tag="h2">Launch Kit</ws.element><ws.element ws:tag="p">A focused section created with Webstudio JSX.</ws.element><ws.element ws:tag="button">Get started</ws.element></ws.element>"}\' --dry-run\n```\n\nFor simple authored/styled sections, run the three commands above. Do not grep source files, dump full MCP resources, or write parser scripts first. Use `list-pages`, `get-page-by-path`, or `list-instances` only when you still need the target `parentInstanceId`.\n\nWhen building for a Content-mode editor, use a Content Block (`ws:block`) around every region that editor must change. Content-mode text and supported props are editable only in Content Block descendants; content outside is read-only. Keep reusable insertable source options in the block\'s `ws:block-template` child. Templates themselves are protected; an editor\'s inserted copy becomes an editable direct child of the Content Block. Verify this structure before handoff.\n\nRun it from the linked Webstudio project root. The startup status line prints that absolute root; use it for local files such as `<project root>/.temp/script.mjs`, screenshots, and generated artifacts.\n\nFor experiments, pass `--dry-run` to local-capable mutation calls. Read the computed transaction from `meta.session.transaction` and its base build version from `meta.session.version`. Copying a `.webstudio` folder is not an isolated project clone; `.webstudio/config.json` still points to the same remote project, so non-dry-run mutations can commit to that project.\n\nStartup marks cached ProjectSession data stale so MCP tools read the current Builder dev build.\n\nAfter startup, use focused discovery tools with concrete JSON. For delegated design-system or “use every component” tasks, start with exactly one command: `webstudio workflow.next \'{"goal":"design-system-page"}\'`; report the returned checkpoint to the parent/user and stop until continued. For other tasks, read `meta.index` first. From a shell, `webstudio mcp list-tools` is a concise alias for the initial tool catalog. Then call shortcuts such as `webstudio meta.guide \'{"brief":"Create a design system page using every component"}\'`, `webstudio workflow.next \'{"goal":"design-system-page"}\'`, `webstudio meta.get_more_tools \'{"tools":["insert-fragment"]}\'`, `webstudio components.list \'{"source":"all"}\'`, `webstudio components.summary`, `webstudio components.search \'{"brief":"radix select"}\'`, `webstudio components.get \'{"component":"@webstudio-is/sdk-components-react-radix:Select"}\'`, `webstudio templates.list`, and `webstudio templates.get \'{"component":"@webstudio-is/sdk-components-react-radix:Select"}\'`. Use `webstudio mcp single-op-call` when you need the explicit MCP form. Prefer `insert-fragment` for authored/styled sections; use `insert-component` only when inserting one automatic component template. In JSX, use `ws:style={css\\`...\\`}`for styles,`class`/`for`instead of`className`/`htmlFor`, `ActionValue`for actions instead of JavaScript functions such as`onClick={() => ...}`, only JSON-compatible plain prop values, and no host globals or dynamic code APIs. For bounded multi-step shell work, run inline JSON like `webstudio mcp run \'[{"tool":"meta.index"},{"tool":"components.search","input":{"brief":"button"}}]\'`; this reuses one CLI session without raw JSON-RPC. For larger batches, write `{ "calls": [{ "tool": "..." }] }`to`.temp/mcp-calls.json`and run`webstudio mcp run .temp/mcp-calls.json`. If any call returns `checkpoint.required`, `mcp run`stops immediately before later calls; report the checkpoint and call`checkpoint.ack {"reported":true,"continueAfterReport":true,"summary":"<what you reported>"}`before continuing. For design-system or “use every component” tasks, call`workflow.next {"goal":"design-system-page"}`for the next bounded phase, report its checkpoint, wait until the parent/user continues, call`checkpoint.ack {"reported":true,"continueAfterReport":true,"summary":"<what you reported>"}`, then run only that phase. Start coverage phases with compact`webstudio components.coverage-plan`, checkpoint, then request component coverage details with `components.coverage-plan {"detail":"roots"}`or`components.coverage-plan {"detail":"parts"}`. Do not pass `detail`to`list-pages`; use `list-pages {}`or`get-page-by-path`for page lookup. Read MCP overview resources`webstudio://project/guide`, `webstudio://project/tools-overview`, and `webstudio://project/components-overview`when useful. Read full resources`webstudio://project/tools`and`webstudio://project/components` only when focused tools are insufficient; do not dump or parse full discovery JSON for common lookup.\n\nAfter startup, MCP clients discover capabilities with `tools/list`, `resources/list`, `meta.index`, `meta.guide`, and `meta.get_more_tools`.\n\nstdout is reserved for MCP JSON-RPC messages while the server is running.\n\nThe server advertises MCP `logging` capability and sends sparse `notifications/message` logs for ready state and tool lifecycle checkpoints such as `tool preview.start started`, `tool preview.start still running after 10000ms`, and `tool preview.start succeeded in 1234ms`. It also writes the same sparse lifecycle status lines to stderr, prefixed with `[webstudio mcp]`, including a final ready line. Treat the process as healthy and long-running after either ready signal; surface tool lifecycle logs as progress checkpoints and interact through MCP JSON-RPC on stdin/stdout.\n\n`webstudio mcp single-op-call` also writes sparse lifecycle lines to stderr for each one-shot call. Use those stderr lines as progress checkpoints and parse stdout as JSON on both success and failure. Failed one-shot calls print `{ "ok": false, "error": { "code": "...", "message": "..." }, "meta": ... }` to stdout and exit nonzero. If a one-shot call returns checkpoint.required, read-only discovery remains available, while later mutations fail with `CHECKPOINT_REQUIRED` until you report the checkpoint and call `webstudio mcp single-op-call checkpoint.ack \'{"reported":true,"continueAfterReport":true,"summary":"<what you reported>"}\'`.\n\n`webstudio mcp run` also writes sparse lifecycle lines to stderr and prints one JSON result on success or failure. It stops at the first failed call or checkpoint requirement, including `CHECKPOINT_REQUIRED`, and preserves partial results so delegated agents can report exactly where they stopped.\n\nIf a CLI/MCP tool crashes, hangs, gives a confusing error, needs an undocumented workaround, or forces source-code inspection for normal usage, ask the user to report it in the Webstudio Discord `#help` channel at https://wstd.us/community. Give the user a complete copy-paste report with the goal, expected behavior, actual error, exact command/tool call, stdout JSON, stderr/lifecycle logs, environment, workaround, and secrets redacted.\n\nIf you are running as a delegated or non-streaming agent whose parent cannot see live stderr/stdout, do not batch many MCP calls silently and do not run long shell loops of shortcut or `webstudio mcp single-op-call` commands. Treat each parent-visible checkpoint as the unit of work. If the parent asks for status within 30 seconds, run exactly one shortcut command such as `webstudio meta.index` or one explicit `webstudio mcp single-op-call` command, return a concise checkpoint with that command/result, and wait for the parent to continue. Do not take a broad task such as creating a full design-system page as one execution unit. Call `workflow.next {"goal":"design-system-page"}`, report the returned phase/checkpoint, wait until the parent/user continues, call `checkpoint.ack {"reported":true,"continueAfterReport":true,"summary":"<what you reported>"}`, complete exactly that bounded phase, and return: discovery, page creation, one dry-run JSX section, one committed JSX section, one `components.coverage-insert-next` call, or one presentation pass. Phase commands do not include nextPhase in their own output. After the parent continues, acknowledge the previous checkpoint first, then call `workflow.next` with the next phase. For all-component design-system pages, checkpoint after workflow planning, discovery, page creation, call `components.coverage-insert-next` once before checkpointing again, then finish with the `presentation-pass` workflow phase.\n',
|
|
230022
|
-
"mcp-vision": '# MCP Vision Verification\n\n## Generated App Dependency Notes\n\n- `preview.start` and `webstudio preview` install generated app dependencies under `.webstudio/preview` and reuse them across regenerations.\n- Do not add generated-preview dependencies to the repository root `package.json` or `pnpm-lock.yaml`.\n- If dependency installation fails, check npm and network configuration, then reinstall or update the Webstudio CLI if the problem persists.\n\n## Visual Verification Rule\n\nFor visual/design work, use preview.start and screenshot
|
|
230248
|
+
"mcp-vision": '# MCP Vision Verification\n\n## Generated App Dependency Notes\n\n- `preview.start` and `webstudio preview` install generated app dependencies under `.webstudio/preview` and reuse them across regenerations.\n- Do not add generated-preview dependencies to the repository root `package.json` or `pnpm-lock.yaml`.\n- If dependency installation fails, check npm and network configuration, then reinstall or update the Webstudio CLI if the problem persists.\n\n## Visual Verification Rule\n\nFor visual/design work, use `preview.start` and `screenshot({ path })` so vision can inspect the current MCP session before finishing and verify that generated project files are current. Iterative preview is the default: it keeps one generated-site server and browser alive, regenerates changed files, and performs an ordinary page reload without Vite HMR. Use `mode: "production"` only for release-like verification; rendered audit selects it automatically. `preview.start` is long-lived and cannot be used through one-shot `mcp single-op-call`; from a shell, use `webstudio mcp run` for preview.start/screenshot/preview.stop in one shared process, or use a long-running MCP server. When a baseline exists, use screenshot.diff to get pixel regions, OCR text changes, and diff PNG artifacts.\n\nAn authenticated project share URL is used with `webstudio init --link`; it is\nnot a generated-site preview URL. Project screenshots and rendered audits use\nthe generated local preview owned by the current CLI/MCP process. Do not pass a\nBuilder/share URL to `screenshot`, even without query parameters. Use `path`\nafter starting preview, or use `baseUrl` only for an intentional generated site\nthat is already running. Path captures verify the generated-site root marker\nand fail instead of returning a screenshot of Builder chrome.\n\n## Vision Verification Loop\n\n- Make focused page/content/style changes with semantic MCP tools.\n- Call preview.start once to keep the iterative generated site running. In shell-driven workflows, run preview.start, screenshot, and preview.stop inside one `webstudio mcp run` call so they share the same preview owner.\n- {{dependency-notes}}\n- After MCP mutations, path-based screenshots regenerate the current session in place, wait for its exact project version, and normally reload the route. The server and browser remain alive. From one-shot shell calls or another process, pass `baseUrl` with `path` to capture an already-running generated site without starting it. Use preview.stop only in the same long-running MCP server or `webstudio mcp run` process that started preview; a separate one-shot `single-op-call` process does not own another process\'s preview controller.\n- For multi-page work, capture each changed page by path through the same preview server, for example screenshot({ path: "/" }), screenshot({ path: "/pricing" }), and screenshot({ path: "/about" }). The screenshot tool navigates directly to the requested route; no browser click navigation is required.\n- For responsive work, call list-breakpoints first, then capture screenshots at viewport widths based on the Builder breakpoints plus a narrow mobile and desktop width.\n- Call screenshot with { path: "/" } or the changed page path and viewport such as { width: 375, height: 812 } and { width: 1440, height: 900 }. For an existing preview in another process, call screenshot with { baseUrl: "http://127.0.0.1:5177", path: "/" }. Use waitForSelector when the page has a reliable ready marker, waitUntil:"networkidle" for network-heavy pages, and waitForTimeout only for final visual settling.\n- {{diff}} When a baseline PNG exists, call screenshot.diff with baselinePath, currentPath, and outputDir for each page/viewport pair. Add expectedText when a specific visible phrase must be present; its assertions report pass/fail plus found and missing text. Add expectedVisual to set pass/fail limits for mismatch percentage, the number of changed regions, or an overall dominant color/brightness direction.\n- {{diff}} Read screenshot.diff textAnalysis: it reports OCR status plus text that appeared, disappeared, moved, changed content, or changed font/style geometry. If OCR is unavailable, expectedText assertions fail and textAnalysis reports why; ask the user for permission to install Tesseract, then call vision.install-ocr with { "confirm": true }, or rely on visual inspection.\n- Inspect every viewport PNG and any diff artifacts with vision, then compare layout, OCR text evidence, color, spacing, imagery, and responsive framing against the user intent.\n- If the screenshot does not match, apply another focused mutation and repeat screenshot verification.\n\n## Workflow Summary With Diff\n\nFor visual/design work, call preview.start once to start the iterative generated-site preview, then screenshot({ path, viewport }) after each focused mutation; path screenshots regenerate changed files and reload the route in the existing server and browser. For responsive work, use list-breakpoints and capture each changed page at Builder breakpoint widths plus mobile and desktop widths. Use screenshot.diff on each baseline/current page or viewport pair when a baseline exists, then inspect pixel regions, OCR textAnalysis, and PNG/diff artifacts with vision before finishing. Use mode: "production" only for release-like verification.\n\n## Workflow Summary Without Diff\n\nFor visual/design work, call preview.start once to start the iterative generated-site preview, then screenshot({ path, viewport }) after each focused mutation; path screenshots regenerate changed files and reload the route in the existing server and browser. For responsive work, use list-breakpoints and capture each changed page at Builder breakpoint widths plus mobile and desktop widths. Inspect every PNG with vision before finishing. Use mode: "production" only for release-like verification.\n\nEach screenshot result includes rendered `layout` metrics when the local browser\nprovides them. `layout.horizontalOverflow: true` is deterministic evidence that\nthe rendered document exceeds the requested viewport width. Use vision for\nclipping, wrapping, hierarchy, and other judgments that layout dimensions alone\ncannot establish.\n\nPass `includeImageMetrics: true` when an ordinary screenshot needs\n`layout.images`; rendered audit enables it automatically. The array includes\neach rendered image\'s Webstudio instance id when available, loading mode,\ncompletion state, natural dimensions, rendered dimensions, and document\nposition. Rendered audits use this evidence to report broken images, eager\nloading below the fold, and sources more than 2x the rendered dimensions in\nboth axes. Oversized-source results are optimization evidence, not universal\nperformance conformance.\n\nPass `includeResourceMetrics: true` when an ordinary screenshot needs sanitized\nResource Timing evidence; rendered audit enables it automatically. Resource\nmetrics contain only the URL pathname, initiator type, transfer/body sizes,\nduration, and browser-provided render-blocking status. Origins and query strings\nare omitted. Rendered audits report explicitly blocking resources and legacy\n`.ttf`, `.otf`, or `.woff` font files without applying a universal byte-size\nbudget.\n\n## Screenshot Verification Summary\n\nInside a long-running MCP server, call preview.start once, then use screenshot({ path, viewport }) for fast repeated checks across multiple pages. Iterative mode is the default: after MCP mutations, path screenshots regenerate changed files and reload the requested route while keeping the server and browser alive. Use mode: "production" only for release-like verification. From one-shot shell calls or another process, use screenshot({ baseUrl, path, viewport }) to capture an already-running preview/site without generating, building, starting, or restarting preview. Use path values such as "/", "/pricing", or "/about" to capture specific generated routes. For responsive work, read list-breakpoints and capture one familiar device viewport inside each Builder breakpoint range before using vision. Screenshot waits for load by default, then fonts and two layout frames; pass waitForSelector for app readiness, waitUntil:"networkidle" for network-heavy pages, and waitForTimeout for final settling. When a baseline exists, use screenshot.diff for changed regions, OCR textAnalysis, and diff artifacts on each baseline/current screenshot pair. Outside MCP, use `webstudio screenshot --path /pricing --output pricing.png` for one temporary generated preview capture, or keep `webstudio preview` running and pass its absolute URL to `webstudio screenshot` for repeated captures.\n\n## Screenshot Diff Evidence\n\n- Pixel evidence: total mismatch, changed regions, dominant color/luminance direction, diffPath, and contextDiffPath.\n- OCR evidence: textAnalysis.status, provider, and changes for appeared/disappeared/content_changed/moved/font_changed text. expectedText adds pass/fail assertions plus found and missing current-screen text. expectedVisual adds pass/fail quantitative checks for mismatch percentage, changed-region count, and the overall dominant color/brightness direction.\n- OCR dependency: screenshot.diff uses the system tesseract binary when available. If missing, it returns ocr_unavailable_tesseract_not_found_or_failed and still returns pixel evidence.\n- OCR install: MCP cannot prompt. Ask the user first; if they agree, call vision.install-ocr with { "confirm": true }. If automatic install is unavailable, follow the returned installUrl.\n- Final judgment: OCR and pixel diff are evidence. A vision-capable model must still inspect screenshots/diff artifacts and compare the rendered result to user intent.\n'
|
|
230023
230249
|
};
|
|
230024
230250
|
const cliDocTitles = {
|
|
230025
230251
|
"api-use-cases": "CLI API Use Cases",
|
|
@@ -238235,7 +238461,7 @@ const getAncestorBinPaths = (directory) => {
|
|
|
238235
238461
|
join(currentDirectory, "node_modules", ".pnpm", "node_modules", ".bin")
|
|
238236
238462
|
);
|
|
238237
238463
|
const parentDirectory = dirname(currentDirectory);
|
|
238238
|
-
if (parentDirectory === currentDirectory || currentDirectory === parse$
|
|
238464
|
+
if (parentDirectory === currentDirectory || currentDirectory === parse$V(currentDirectory).root) {
|
|
238239
238465
|
return paths;
|
|
238240
238466
|
}
|
|
238241
238467
|
currentDirectory = parentDirectory;
|
|
@@ -238257,10 +238483,16 @@ const getPreviewUrl = ({
|
|
|
238257
238483
|
path: path2 = "/"
|
|
238258
238484
|
}) => new URL(path2, `http://${host}:${port}`).toString();
|
|
238259
238485
|
const getPreviewBuildArgs = () => ["run", "build"];
|
|
238260
|
-
const getPreviewStartArgs = (
|
|
238486
|
+
const getPreviewStartArgs = (options) => options.mode === "iterative" ? [
|
|
238261
238487
|
"run",
|
|
238262
|
-
"
|
|
238263
|
-
|
|
238488
|
+
"dev",
|
|
238489
|
+
"--",
|
|
238490
|
+
"--host",
|
|
238491
|
+
options.host,
|
|
238492
|
+
"--port",
|
|
238493
|
+
String(options.port),
|
|
238494
|
+
"--strictPort"
|
|
238495
|
+
] : ["run", "start"];
|
|
238264
238496
|
const getPreviewCommand = (platform2 = process.platform) => platform2 === "win32" ? "npm.cmd" : "npm";
|
|
238265
238497
|
const runPreviewBuild = async (dependencies2 = defaultPreviewServerDependencies, cwd2, stdio = "inherit") => {
|
|
238266
238498
|
const buildProcess = dependencies2.spawn(
|
|
@@ -238319,7 +238551,7 @@ const materializePreviewAssets = async (cwd2, dependencies2 = defaultPreviewServ
|
|
|
238319
238551
|
const startPreviewServer = (options, dependencies2 = defaultPreviewServerDependencies) => {
|
|
238320
238552
|
const previewProcess = dependencies2.spawn(
|
|
238321
238553
|
getPreviewCommand(dependencies2.platform),
|
|
238322
|
-
getPreviewStartArgs(),
|
|
238554
|
+
getPreviewStartArgs(options),
|
|
238323
238555
|
{
|
|
238324
238556
|
cwd: options.cwd,
|
|
238325
238557
|
stdio: options.stdio ?? "inherit",
|
|
@@ -238328,7 +238560,8 @@ const startPreviewServer = (options, dependencies2 = defaultPreviewServerDepende
|
|
|
238328
238560
|
HOST: options.host,
|
|
238329
238561
|
PORT: String(options.port),
|
|
238330
238562
|
...options.imageDomains === void 0 ? {} : { DOMAINS: options.imageDomains.join(",") },
|
|
238331
|
-
NODE_ENV: "production"
|
|
238563
|
+
NODE_ENV: options.mode === "iterative" ? "development" : "production",
|
|
238564
|
+
...options.mode === "iterative" ? { WEBSTUDIO_PREVIEW_HMR: "disabled" } : {}
|
|
238332
238565
|
})
|
|
238333
238566
|
}
|
|
238334
238567
|
);
|
|
@@ -238346,9 +238579,9 @@ const waitForPreviewExit = async (process2) => {
|
|
|
238346
238579
|
throw new Error(`Preview server exited with code ${code2}.`);
|
|
238347
238580
|
}
|
|
238348
238581
|
};
|
|
238349
|
-
const
|
|
238582
|
+
const arePreviewImageDomainsEqual = (left, right) => left === right || left !== void 0 && right !== void 0 && left.length === right.length && left.every((value2, index2) => value2 === right[index2]);
|
|
238350
238583
|
const previewBuildCacheMarker = ".webstudio-preview-build";
|
|
238351
|
-
const
|
|
238584
|
+
const getPreviewProjectIdentity = async (cwd2, dependencies2 = defaultPreviewServerDependencies) => {
|
|
238352
238585
|
if (cwd2 === void 0) {
|
|
238353
238586
|
return void 0;
|
|
238354
238587
|
}
|
|
@@ -238359,7 +238592,10 @@ const getPreviewProjectId = async (cwd2, dependencies2 = defaultPreviewServerDep
|
|
|
238359
238592
|
if (typeof data2.build?.projectId !== "string") {
|
|
238360
238593
|
throw new Error("projectId is missing");
|
|
238361
238594
|
}
|
|
238362
|
-
return
|
|
238595
|
+
return {
|
|
238596
|
+
projectId: data2.build.projectId,
|
|
238597
|
+
...typeof data2.build.version === "number" ? { version: data2.build.version } : {}
|
|
238598
|
+
};
|
|
238363
238599
|
} catch (error) {
|
|
238364
238600
|
throw new Error(
|
|
238365
238601
|
`Could not identify the generated preview project in ${join(cwd2, ".webstudio", "data.json")}.`,
|
|
@@ -238367,18 +238603,40 @@ const getPreviewProjectId = async (cwd2, dependencies2 = defaultPreviewServerDep
|
|
|
238367
238603
|
);
|
|
238368
238604
|
}
|
|
238369
238605
|
};
|
|
238370
|
-
const
|
|
238371
|
-
const
|
|
238372
|
-
|
|
238373
|
-
|
|
238374
|
-
|
|
238606
|
+
const getGeneratedSiteIdentity = (html2) => {
|
|
238607
|
+
const document2 = parse$U(html2);
|
|
238608
|
+
const visit = (node2) => {
|
|
238609
|
+
if ("attrs" in node2 && Array.isArray(node2.attrs)) {
|
|
238610
|
+
const attributes = new Map(
|
|
238611
|
+
node2.attrs.map(({ name: name2, value: value2 }) => [name2, value2])
|
|
238612
|
+
);
|
|
238613
|
+
const projectId = attributes.get("data-ws-project");
|
|
238614
|
+
const versionValue = attributes.get("data-ws-version");
|
|
238615
|
+
if (projectId !== void 0) {
|
|
238616
|
+
const version2 = Number(versionValue);
|
|
238617
|
+
return {
|
|
238618
|
+
projectId,
|
|
238619
|
+
...Number.isFinite(version2) ? { version: version2 } : {}
|
|
238620
|
+
};
|
|
238621
|
+
}
|
|
238622
|
+
}
|
|
238623
|
+
if ("childNodes" in node2) {
|
|
238624
|
+
for (const child of node2.childNodes) {
|
|
238625
|
+
const identity = visit(child);
|
|
238626
|
+
if (identity !== void 0) {
|
|
238627
|
+
return identity;
|
|
238628
|
+
}
|
|
238629
|
+
}
|
|
238630
|
+
}
|
|
238631
|
+
};
|
|
238632
|
+
return visit(document2);
|
|
238375
238633
|
};
|
|
238376
238634
|
const waitForPreviewReady = async (url2, {
|
|
238377
238635
|
timeoutMs = 3e4,
|
|
238378
238636
|
intervalMs = 250,
|
|
238379
238637
|
isRunning,
|
|
238380
238638
|
requiredAssetNames = [],
|
|
238381
|
-
|
|
238639
|
+
requiredProject
|
|
238382
238640
|
} = {}, dependencies2 = defaultPreviewServerDependencies) => {
|
|
238383
238641
|
const deadline = Date.now() + timeoutMs;
|
|
238384
238642
|
let sawStaleServer = false;
|
|
@@ -238399,11 +238657,12 @@ const waitForPreviewReady = async (url2, {
|
|
|
238399
238657
|
signal: AbortSignal.timeout(attemptTimeoutMs)
|
|
238400
238658
|
});
|
|
238401
238659
|
if (response.status < 500) {
|
|
238402
|
-
if (requiredAssetNames.length === 0 &&
|
|
238660
|
+
if (requiredAssetNames.length === 0 && requiredProject === void 0) {
|
|
238403
238661
|
return;
|
|
238404
238662
|
}
|
|
238405
238663
|
const html2 = await response.text();
|
|
238406
|
-
const
|
|
238664
|
+
const identity = getGeneratedSiteIdentity(html2);
|
|
238665
|
+
const servesExpectedProject = requiredProject === void 0 || identity?.projectId === requiredProject.projectId && (requiredProject.version === void 0 || identity.version === requiredProject.version);
|
|
238407
238666
|
const servesLatestAssets = requiredAssetNames.length === 0 || requiredAssetNames.some((name2) => html2.includes(name2));
|
|
238408
238667
|
if (servesExpectedProject && servesLatestAssets) {
|
|
238409
238668
|
return;
|
|
@@ -238462,8 +238721,29 @@ const createPreviewController = (defaults2, dependencies2 = defaultPreviewServer
|
|
|
238462
238721
|
const getStatus = () => ({
|
|
238463
238722
|
url: getPreviewUrl(currentOptions),
|
|
238464
238723
|
pid: server?.process.pid,
|
|
238465
|
-
running: isRunning()
|
|
238724
|
+
running: isRunning(),
|
|
238725
|
+
mode: currentOptions.mode ?? "production"
|
|
238466
238726
|
});
|
|
238727
|
+
const resolveOptions = (options) => {
|
|
238728
|
+
const running = isRunning();
|
|
238729
|
+
return {
|
|
238730
|
+
host: options.host ?? (running ? currentOptions.host : defaults2.host),
|
|
238731
|
+
port: options.port ?? (running ? currentOptions.port : defaults2.port),
|
|
238732
|
+
cwd: options.cwd ?? (running ? currentCwd : defaults2.cwd),
|
|
238733
|
+
imageDomains: options.imageDomains ?? (running ? currentOptions.imageDomains : defaults2.imageDomains),
|
|
238734
|
+
mode: options.mode ?? (running ? currentOptions.mode : defaults2.mode) ?? "production"
|
|
238735
|
+
};
|
|
238736
|
+
};
|
|
238737
|
+
const canReuse = (options = {}) => {
|
|
238738
|
+
if (isRunning() === false) {
|
|
238739
|
+
return false;
|
|
238740
|
+
}
|
|
238741
|
+
const nextOptions = resolveOptions(options);
|
|
238742
|
+
return nextOptions.host === currentOptions.host && nextOptions.port === currentOptions.port && nextOptions.cwd === currentCwd && nextOptions.mode === (currentOptions.mode ?? "production") && arePreviewImageDomainsEqual(
|
|
238743
|
+
nextOptions.imageDomains,
|
|
238744
|
+
currentOptions.imageDomains
|
|
238745
|
+
);
|
|
238746
|
+
};
|
|
238467
238747
|
const stop = async () => {
|
|
238468
238748
|
if (server === void 0) {
|
|
238469
238749
|
return;
|
|
@@ -238483,18 +238763,10 @@ const createPreviewController = (defaults2, dependencies2 = defaultPreviewServer
|
|
|
238483
238763
|
};
|
|
238484
238764
|
const start = async (options = {}) => {
|
|
238485
238765
|
const running = isRunning();
|
|
238486
|
-
const nextOptions =
|
|
238487
|
-
host: options.host ?? (running ? currentOptions.host : defaults2.host),
|
|
238488
|
-
port: options.port ?? (running ? currentOptions.port : defaults2.port),
|
|
238489
|
-
cwd: options.cwd ?? (running ? currentCwd : defaults2.cwd),
|
|
238490
|
-
imageDomains: options.imageDomains ?? (running ? currentOptions.imageDomains : defaults2.imageDomains)
|
|
238491
|
-
};
|
|
238766
|
+
const nextOptions = resolveOptions(options);
|
|
238492
238767
|
if (running) {
|
|
238493
238768
|
if (options.restart !== true) {
|
|
238494
|
-
if (
|
|
238495
|
-
nextOptions.imageDomains,
|
|
238496
|
-
currentOptions.imageDomains
|
|
238497
|
-
) === false) {
|
|
238769
|
+
if (canReuse(options) === false) {
|
|
238498
238770
|
throw new Error(
|
|
238499
238771
|
`Preview server is already running at ${getPreviewUrl(currentOptions)}. Stop it before starting a different preview server.`
|
|
238500
238772
|
);
|
|
@@ -238506,7 +238778,7 @@ const createPreviewController = (defaults2, dependencies2 = defaultPreviewServer
|
|
|
238506
238778
|
currentOptions = nextOptions;
|
|
238507
238779
|
currentCwd = nextOptions.cwd;
|
|
238508
238780
|
const cachedBuildKey = options.buildCacheKey === void 0 || currentCwd === void 0 ? void 0 : await dependencies2.readFile(join(currentCwd, previewBuildCacheMarker), "utf8").catch(() => void 0);
|
|
238509
|
-
if (options.buildCacheKey === void 0 || cachedBuildKey !== options.buildCacheKey) {
|
|
238781
|
+
if (nextOptions.mode === "production" && (options.buildCacheKey === void 0 || cachedBuildKey !== options.buildCacheKey)) {
|
|
238510
238782
|
await runPreviewBuild(dependencies2, currentCwd, [
|
|
238511
238783
|
"ignore",
|
|
238512
238784
|
"pipe",
|
|
@@ -238520,37 +238792,38 @@ const createPreviewController = (defaults2, dependencies2 = defaultPreviewServer
|
|
|
238520
238792
|
}
|
|
238521
238793
|
}
|
|
238522
238794
|
serverOutput = "";
|
|
238523
|
-
|
|
238795
|
+
const startedServer = startPreviewServer(
|
|
238524
238796
|
{
|
|
238525
238797
|
...nextOptions,
|
|
238526
238798
|
stdio: ["ignore", "pipe", "pipe"]
|
|
238527
238799
|
},
|
|
238528
238800
|
dependencies2
|
|
238529
238801
|
);
|
|
238530
|
-
server
|
|
238531
|
-
|
|
238532
|
-
|
|
238533
|
-
|
|
238802
|
+
server = startedServer;
|
|
238803
|
+
startedServer.process.stdout?.on("data", appendServerOutput);
|
|
238804
|
+
startedServer.process.stderr?.on("data", appendServerOutput);
|
|
238805
|
+
startedServer.process.once("exit", () => {
|
|
238806
|
+
if (server === startedServer) {
|
|
238807
|
+
server = void 0;
|
|
238808
|
+
}
|
|
238534
238809
|
});
|
|
238535
238810
|
return getStatus();
|
|
238536
238811
|
};
|
|
238537
238812
|
return {
|
|
238813
|
+
canReuse,
|
|
238538
238814
|
start,
|
|
238539
238815
|
async startAndWait(options = {}) {
|
|
238540
238816
|
const nextCwd = options.cwd ?? (isRunning() ? currentCwd : defaults2.cwd);
|
|
238541
|
-
const
|
|
238817
|
+
const requiredProject = await getPreviewProjectIdentity(
|
|
238542
238818
|
nextCwd,
|
|
238543
238819
|
dependencies2
|
|
238544
238820
|
);
|
|
238545
238821
|
const result = await start(options);
|
|
238546
|
-
const requiredAssetNames = await getPreviewCssAssetNames(
|
|
238547
|
-
currentCwd,
|
|
238548
|
-
dependencies2
|
|
238549
|
-
);
|
|
238822
|
+
const requiredAssetNames = result.mode === "production" ? await getPreviewCssAssetNames(currentCwd, dependencies2) : [];
|
|
238550
238823
|
try {
|
|
238551
238824
|
await waitForPreviewReady(
|
|
238552
238825
|
result.url,
|
|
238553
|
-
{ isRunning, requiredAssetNames,
|
|
238826
|
+
{ isRunning, requiredAssetNames, requiredProject },
|
|
238554
238827
|
dependencies2
|
|
238555
238828
|
);
|
|
238556
238829
|
} catch (error) {
|
|
@@ -238812,6 +239085,14 @@ const waitForFontsAndFrames = async (cdp, timeout) => {
|
|
|
238812
239085
|
documentReadyState: document.readyState,
|
|
238813
239086
|
generatedSiteRootPresent:
|
|
238814
239087
|
document.documentElement.hasAttribute("data-ws-project"),
|
|
239088
|
+
projectId:
|
|
239089
|
+
document.documentElement.getAttribute("data-ws-project") ?? undefined,
|
|
239090
|
+
projectVersion: (() => {
|
|
239091
|
+
const attribute = document.documentElement.getAttribute("data-ws-version");
|
|
239092
|
+
if (attribute === null) return undefined;
|
|
239093
|
+
const value = Number(attribute);
|
|
239094
|
+
return Number.isFinite(value) ? value : undefined;
|
|
239095
|
+
})(),
|
|
238815
239096
|
width: document.documentElement.scrollWidth,
|
|
238816
239097
|
height: document.documentElement.scrollHeight,
|
|
238817
239098
|
}))`,
|
|
@@ -238823,7 +239104,7 @@ const waitForFontsAndFrames = async (cdp, timeout) => {
|
|
|
238823
239104
|
);
|
|
238824
239105
|
return response.result?.value;
|
|
238825
239106
|
};
|
|
238826
|
-
const isLayoutSample = (value2) => typeof value2 === "object" && value2 !== null && "documentReadyState" in value2 && typeof value2.documentReadyState === "string" && "generatedSiteRootPresent" in value2 && typeof value2.generatedSiteRootPresent === "boolean" && "width" in value2 && typeof value2.width === "number" && "height" in value2 && typeof value2.height === "number";
|
|
239107
|
+
const isLayoutSample = (value2) => typeof value2 === "object" && value2 !== null && "documentReadyState" in value2 && typeof value2.documentReadyState === "string" && "generatedSiteRootPresent" in value2 && typeof value2.generatedSiteRootPresent === "boolean" && ("projectId" in value2 === false || value2.projectId === void 0 || typeof value2.projectId === "string") && ("projectVersion" in value2 === false || value2.projectVersion === void 0 || typeof value2.projectVersion === "number") && "width" in value2 && typeof value2.width === "number" && "height" in value2 && typeof value2.height === "number";
|
|
238827
239108
|
const initial = await measure();
|
|
238828
239109
|
if (isLayoutSample(initial) === false) {
|
|
238829
239110
|
throw new Error(
|
|
@@ -238844,6 +239125,8 @@ const waitForFontsAndFrames = async (cdp, timeout) => {
|
|
|
238844
239125
|
return {
|
|
238845
239126
|
documentReadyState: value2.documentReadyState,
|
|
238846
239127
|
generatedSiteRootPresent: value2.generatedSiteRootPresent,
|
|
239128
|
+
...value2.projectId === void 0 ? {} : { projectId: value2.projectId },
|
|
239129
|
+
...value2.projectVersion === void 0 ? {} : { projectVersion: value2.projectVersion },
|
|
238847
239130
|
layoutStable: true
|
|
238848
239131
|
};
|
|
238849
239132
|
}
|
|
@@ -238851,6 +239134,8 @@ const waitForFontsAndFrames = async (cdp, timeout) => {
|
|
|
238851
239134
|
return {
|
|
238852
239135
|
documentReadyState: value2.documentReadyState,
|
|
238853
239136
|
generatedSiteRootPresent: value2.generatedSiteRootPresent,
|
|
239137
|
+
...value2.projectId === void 0 ? {} : { projectId: value2.projectId },
|
|
239138
|
+
...value2.projectVersion === void 0 ? {} : { projectVersion: value2.projectVersion },
|
|
238854
239139
|
layoutStable: false
|
|
238855
239140
|
};
|
|
238856
239141
|
}
|
|
@@ -240106,6 +240391,22 @@ const createScreenshotCaptureSession = (dependencies2 = defaultScreenshotDepende
|
|
|
240106
240391
|
let browserPromise;
|
|
240107
240392
|
let browserSession;
|
|
240108
240393
|
let browserSessionPromise;
|
|
240394
|
+
const getBrowserSession = async (options) => {
|
|
240395
|
+
if (browserSession !== void 0) {
|
|
240396
|
+
return browserSession;
|
|
240397
|
+
}
|
|
240398
|
+
const pendingSession = browserSessionPromise ?? createBrowserScreenshotSession(options, dependencies2);
|
|
240399
|
+
browserSessionPromise = pendingSession;
|
|
240400
|
+
try {
|
|
240401
|
+
browserSession = await pendingSession;
|
|
240402
|
+
return browserSession;
|
|
240403
|
+
} catch (error) {
|
|
240404
|
+
if (browserSessionPromise === pendingSession) {
|
|
240405
|
+
browserSessionPromise = void 0;
|
|
240406
|
+
}
|
|
240407
|
+
throw error;
|
|
240408
|
+
}
|
|
240409
|
+
};
|
|
240109
240410
|
return {
|
|
240110
240411
|
async capture(options) {
|
|
240111
240412
|
browserPromise ??= resolveScreenshotBrowser(options, dependencies2);
|
|
@@ -240115,21 +240416,19 @@ const createScreenshotCaptureSession = (dependencies2 = defaultScreenshotDepende
|
|
|
240115
240416
|
"A reusable screenshot session cannot switch browser executables."
|
|
240116
240417
|
);
|
|
240117
240418
|
}
|
|
240118
|
-
|
|
240419
|
+
const activeBrowserSession = await getBrowserSession(
|
|
240119
240420
|
getBrowserScreenshotOptions(
|
|
240120
240421
|
options,
|
|
240121
240422
|
resolvedBrowser.path,
|
|
240122
240423
|
options.output ?? "",
|
|
240123
240424
|
dependencies2
|
|
240124
|
-
)
|
|
240125
|
-
dependencies2
|
|
240425
|
+
)
|
|
240126
240426
|
);
|
|
240127
|
-
browserSession ??= await browserSessionPromise;
|
|
240128
240427
|
return await captureResolvedScreenshot(
|
|
240129
240428
|
options,
|
|
240130
240429
|
resolvedBrowser,
|
|
240131
240430
|
dependencies2,
|
|
240132
|
-
|
|
240431
|
+
activeBrowserSession
|
|
240133
240432
|
);
|
|
240134
240433
|
},
|
|
240135
240434
|
async capturePage(optionsList) {
|
|
@@ -240170,12 +240469,10 @@ const createScreenshotCaptureSession = (dependencies2 = defaultScreenshotDepende
|
|
|
240170
240469
|
};
|
|
240171
240470
|
})
|
|
240172
240471
|
);
|
|
240173
|
-
|
|
240174
|
-
captures[0].browserOptions
|
|
240175
|
-
dependencies2
|
|
240472
|
+
const activeBrowserSession = await getBrowserSession(
|
|
240473
|
+
captures[0].browserOptions
|
|
240176
240474
|
);
|
|
240177
|
-
|
|
240178
|
-
const layouts = await browserSession.capturePage(
|
|
240475
|
+
const layouts = await activeBrowserSession.capturePage(
|
|
240179
240476
|
captures.map((capture) => capture.browserOptions)
|
|
240180
240477
|
);
|
|
240181
240478
|
return captures.map(({ options, output }, index2) => {
|
|
@@ -240543,14 +240840,26 @@ const inspectGeneratedBuildMetrics = async (projectDirectory) => {
|
|
|
240543
240840
|
largestFiles: files2.slice(0, 20)
|
|
240544
240841
|
};
|
|
240545
240842
|
};
|
|
240546
|
-
const
|
|
240547
|
-
|
|
240843
|
+
const createExclusiveAsyncRunner = () => {
|
|
240844
|
+
let queue = Promise.resolve();
|
|
240845
|
+
return async (callback) => {
|
|
240846
|
+
const previousRun = queue;
|
|
240847
|
+
let releaseCurrentRun = () => void 0;
|
|
240848
|
+
queue = new Promise((resolve2) => {
|
|
240849
|
+
releaseCurrentRun = resolve2;
|
|
240850
|
+
});
|
|
240851
|
+
await previousRun.catch(() => void 0);
|
|
240852
|
+
try {
|
|
240853
|
+
return await callback();
|
|
240854
|
+
} finally {
|
|
240855
|
+
releaseCurrentRun();
|
|
240856
|
+
}
|
|
240857
|
+
};
|
|
240858
|
+
};
|
|
240859
|
+
const previewDefaultTemplate = ["react-router"];
|
|
240860
|
+
const previewSources = projectPreviewSources;
|
|
240548
240861
|
const getPreviewTemplates = (template) => {
|
|
240549
|
-
|
|
240550
|
-
if (templates2.includes("react-router") && templates2.includes("defaults") === false) {
|
|
240551
|
-
templates2.unshift("defaults");
|
|
240552
|
-
}
|
|
240553
|
-
return templates2;
|
|
240862
|
+
return template.length === 0 ? [...previewDefaultTemplate] : [...template];
|
|
240554
240863
|
};
|
|
240555
240864
|
const previewOptions = (yargs) => buildOptions(yargs).option("host", {
|
|
240556
240865
|
type: "string",
|
|
@@ -240721,29 +241030,8 @@ const runInDirectory = async (directory, callback) => {
|
|
|
240721
241030
|
chdir(previousDirectory);
|
|
240722
241031
|
}
|
|
240723
241032
|
};
|
|
240724
|
-
|
|
240725
|
-
const
|
|
240726
|
-
const previousRun = runInDirectoryQueue;
|
|
240727
|
-
let releaseCurrentRun = () => void 0;
|
|
240728
|
-
runInDirectoryQueue = new Promise((resolve2) => {
|
|
240729
|
-
releaseCurrentRun = resolve2;
|
|
240730
|
-
});
|
|
240731
|
-
await previousRun.catch(() => void 0);
|
|
240732
|
-
try {
|
|
240733
|
-
return await callback();
|
|
240734
|
-
} finally {
|
|
240735
|
-
releaseCurrentRun();
|
|
240736
|
-
}
|
|
240737
|
-
};
|
|
240738
|
-
const preparePreviewDirectory = async (projectDir) => {
|
|
240739
|
-
const previewProjectDir = getPreviewProjectDir(projectDir);
|
|
240740
|
-
await mkdir(previewProjectDir, { recursive: true });
|
|
240741
|
-
const entries = await readdir(previewProjectDir);
|
|
240742
|
-
await Promise.all(
|
|
240743
|
-
entries.filter((entry2) => entry2 !== "node_modules").map(
|
|
240744
|
-
(entry2) => rm(join(previewProjectDir, entry2), { recursive: true, force: true })
|
|
240745
|
-
)
|
|
240746
|
-
);
|
|
241033
|
+
const runExclusive = createExclusiveAsyncRunner();
|
|
241034
|
+
const copyPreviewProjectFiles = async (projectDir, previewProjectDir) => {
|
|
240747
241035
|
await mkdir(join(previewProjectDir, ".webstudio"), { recursive: true });
|
|
240748
241036
|
for (const file2 of localPreviewFiles) {
|
|
240749
241037
|
await copyFile(join(projectDir, file2), join(previewProjectDir, file2)).catch(
|
|
@@ -240755,6 +241043,28 @@ const preparePreviewDirectory = async (projectDir) => {
|
|
|
240755
241043
|
}
|
|
240756
241044
|
);
|
|
240757
241045
|
}
|
|
241046
|
+
};
|
|
241047
|
+
const hasIncrementalGenerationInputs = async (previewProjectDir) => {
|
|
241048
|
+
return await Promise.all([
|
|
241049
|
+
access(join(previewProjectDir, "app", "route-templates")),
|
|
241050
|
+
access(join(previewProjectDir, generatedFilesManifest))
|
|
241051
|
+
]).then(
|
|
241052
|
+
() => true,
|
|
241053
|
+
() => false
|
|
241054
|
+
);
|
|
241055
|
+
};
|
|
241056
|
+
const preparePreviewDirectory = async (projectDir, preserveGeneratedProject) => {
|
|
241057
|
+
const previewProjectDir = getPreviewProjectDir(projectDir);
|
|
241058
|
+
await mkdir(previewProjectDir, { recursive: true });
|
|
241059
|
+
if (preserveGeneratedProject === false) {
|
|
241060
|
+
const entries = await readdir(previewProjectDir);
|
|
241061
|
+
await Promise.all(
|
|
241062
|
+
entries.filter((entry2) => entry2 !== "node_modules").map(
|
|
241063
|
+
(entry2) => rm(join(previewProjectDir, entry2), { recursive: true, force: true })
|
|
241064
|
+
)
|
|
241065
|
+
);
|
|
241066
|
+
}
|
|
241067
|
+
await copyPreviewProjectFiles(projectDir, previewProjectDir);
|
|
240758
241068
|
return previewProjectDir;
|
|
240759
241069
|
};
|
|
240760
241070
|
const getAssetFileMetadata = async (directory, relativeDirectory = "") => {
|
|
@@ -240825,6 +241135,8 @@ const preparePreviewProject = async ({
|
|
|
240825
241135
|
getBuildCacheKey = getPreviewBuildCacheKey,
|
|
240826
241136
|
silent = false,
|
|
240827
241137
|
includeDraftPages = false,
|
|
241138
|
+
preserveGeneratedProject = false,
|
|
241139
|
+
prepareForIncrementalGeneration = false,
|
|
240828
241140
|
prepareSessionDataFile = async () => {
|
|
240829
241141
|
const connection = await resolveApiConnection();
|
|
240830
241142
|
const session = createCliProjectSession({ connection });
|
|
@@ -240871,25 +241183,30 @@ const preparePreviewProject = async ({
|
|
|
240871
241183
|
template,
|
|
240872
241184
|
includeDraftPages
|
|
240873
241185
|
});
|
|
241186
|
+
const hasIncrementalInputs = await hasIncrementalGenerationInputs(previewProjectDir);
|
|
241187
|
+
const canReuseCachedProject = prepareForIncrementalGeneration === false || hasIncrementalInputs;
|
|
240874
241188
|
if (buildCacheKey !== void 0) {
|
|
240875
241189
|
const cachedBuildKey = await readFile(
|
|
240876
241190
|
join(previewProjectDir, previewBuildCacheMarker),
|
|
240877
241191
|
"utf8"
|
|
240878
241192
|
).catch(() => void 0);
|
|
240879
|
-
if (cachedBuildKey === buildCacheKey) {
|
|
241193
|
+
if (cachedBuildKey === buildCacheKey && canReuseCachedProject) {
|
|
240880
241194
|
await ensureDependencies(previewProjectDir);
|
|
240881
241195
|
return { cwd: previewProjectDir, buildCacheKey, buildRequired: false };
|
|
240882
241196
|
}
|
|
240883
241197
|
}
|
|
240884
241198
|
if (generate2) {
|
|
240885
241199
|
await runExclusive(async () => {
|
|
240886
|
-
|
|
241200
|
+
const reuseGeneratedProject = preserveGeneratedProject && hasIncrementalInputs;
|
|
241201
|
+
await preparePreviewDirectory(projectDir, reuseGeneratedProject);
|
|
240887
241202
|
await runInDirectory(previewProjectDir, async () => {
|
|
240888
241203
|
await prebuildProject({
|
|
240889
241204
|
assets,
|
|
240890
241205
|
template: getPreviewTemplates(template),
|
|
240891
241206
|
...silent ? { silent: true } : {},
|
|
240892
|
-
...includeDraftPages ? { includeDraftPages: true } : {}
|
|
241207
|
+
...includeDraftPages ? { includeDraftPages: true } : {},
|
|
241208
|
+
...reuseGeneratedProject ? { incremental: true } : {},
|
|
241209
|
+
...prepareForIncrementalGeneration ? { preserveRouteTemplates: true } : {}
|
|
240893
241210
|
});
|
|
240894
241211
|
});
|
|
240895
241212
|
await ensureDependencies(previewProjectDir);
|
|
@@ -240936,7 +241253,41 @@ const preview = async (options) => {
|
|
|
240936
241253
|
});
|
|
240937
241254
|
await waitForPreviewExit(server.process);
|
|
240938
241255
|
};
|
|
240939
|
-
const
|
|
241256
|
+
const createPreviewFreshness = () => {
|
|
241257
|
+
let revision = 0;
|
|
241258
|
+
let freshRevision = -1;
|
|
241259
|
+
return {
|
|
241260
|
+
markStale() {
|
|
241261
|
+
revision += 1;
|
|
241262
|
+
},
|
|
241263
|
+
isStale: () => freshRevision !== revision,
|
|
241264
|
+
capture: () => revision,
|
|
241265
|
+
markFresh(capturedRevision) {
|
|
241266
|
+
if (capturedRevision === revision) {
|
|
241267
|
+
freshRevision = revision;
|
|
241268
|
+
}
|
|
241269
|
+
}
|
|
241270
|
+
};
|
|
241271
|
+
};
|
|
241272
|
+
const getCaptureSessionConfig = (input2) => ({
|
|
241273
|
+
browser: input2.browser ?? "auto",
|
|
241274
|
+
browserPath: input2.browserPath
|
|
241275
|
+
});
|
|
241276
|
+
const isSameCaptureSessionConfig = (left, right) => left.browser === right.browser && left.browserPath === right.browserPath;
|
|
241277
|
+
const defaultPreviewSource = "session";
|
|
241278
|
+
const getPreviewSource = (source) => source ?? defaultPreviewSource;
|
|
241279
|
+
const getPreviewTarget = (input2) => ({
|
|
241280
|
+
source: getPreviewSource(input2.source),
|
|
241281
|
+
mode: input2.mode ?? "iterative",
|
|
241282
|
+
host: input2.host ?? "127.0.0.1",
|
|
241283
|
+
port: input2.port ?? 5173,
|
|
241284
|
+
imageDomains: input2.imageDomains
|
|
241285
|
+
});
|
|
241286
|
+
const isSamePreviewTarget = (left, right) => left.source === right.source && left.mode === right.mode && left.host === right.host && left.port === right.port && arePreviewImageDomainsEqual(left.imageDomains, right.imageDomains);
|
|
241287
|
+
const prepareDefaultPreviewProject = (source = defaultPreviewSource, prepareSessionDataFile, {
|
|
241288
|
+
preserveGeneratedProject = false,
|
|
241289
|
+
prepareForIncrementalGeneration = false
|
|
241290
|
+
} = {}) => preparePreviewProject({
|
|
240940
241291
|
assets: true,
|
|
240941
241292
|
template: [...previewDefaultTemplate],
|
|
240942
241293
|
generate: true,
|
|
@@ -240944,11 +241295,14 @@ const prepareDefaultPreviewProject = (source = "local", prepareSessionDataFile)
|
|
|
240944
241295
|
syncIfMissing: true,
|
|
240945
241296
|
silent: true,
|
|
240946
241297
|
includeDraftPages: true,
|
|
240947
|
-
prepareSessionDataFile
|
|
241298
|
+
prepareSessionDataFile,
|
|
241299
|
+
preserveGeneratedProject,
|
|
241300
|
+
prepareForIncrementalGeneration
|
|
240948
241301
|
});
|
|
240949
241302
|
const createMcpPreviewHandlers = ({
|
|
240950
241303
|
preview: preview2,
|
|
240951
241304
|
isStale = () => true,
|
|
241305
|
+
captureFreshness = () => 0,
|
|
240952
241306
|
markFresh = () => void 0,
|
|
240953
241307
|
preparePreview = prepareDefaultPreviewProject,
|
|
240954
241308
|
prepareSessionDataFile,
|
|
@@ -240956,13 +241310,37 @@ const createMcpPreviewHandlers = ({
|
|
|
240956
241310
|
createCaptureSession
|
|
240957
241311
|
}) => {
|
|
240958
241312
|
let captureSession;
|
|
241313
|
+
let captureSessionConfig;
|
|
241314
|
+
let activeSource;
|
|
241315
|
+
const runPreviewLifecycle = createExclusiveAsyncRunner();
|
|
240959
241316
|
const closeCaptureSession = async () => {
|
|
240960
241317
|
try {
|
|
240961
241318
|
await captureSession?.close();
|
|
240962
241319
|
} finally {
|
|
240963
241320
|
captureSession = void 0;
|
|
241321
|
+
captureSessionConfig = void 0;
|
|
240964
241322
|
}
|
|
240965
241323
|
};
|
|
241324
|
+
const getCaptureSession = async (input2) => {
|
|
241325
|
+
if (createCaptureSession === void 0) {
|
|
241326
|
+
throw new Error("Reusable screenshot capture is unavailable.");
|
|
241327
|
+
}
|
|
241328
|
+
const nextConfig = getCaptureSessionConfig(input2);
|
|
241329
|
+
if (captureSessionConfig !== void 0 && isSameCaptureSessionConfig(captureSessionConfig, nextConfig) === false) {
|
|
241330
|
+
await closeCaptureSession();
|
|
241331
|
+
}
|
|
241332
|
+
captureSession ??= createCaptureSession();
|
|
241333
|
+
captureSessionConfig = nextConfig;
|
|
241334
|
+
return captureSession;
|
|
241335
|
+
};
|
|
241336
|
+
const isPreviewTargetCompatible = (input2, mode, status) => {
|
|
241337
|
+
return preview2.canReuse?.({
|
|
241338
|
+
host: input2.host,
|
|
241339
|
+
port: input2.port,
|
|
241340
|
+
imageDomains: input2.imageDomains,
|
|
241341
|
+
mode
|
|
241342
|
+
}) ?? (status.running && status.mode === mode && input2.host === void 0 && input2.port === void 0 && input2.imageDomains === void 0);
|
|
241343
|
+
};
|
|
240966
241344
|
const rejectBuilderUrl = (value2) => {
|
|
240967
241345
|
let url2;
|
|
240968
241346
|
try {
|
|
@@ -240971,10 +241349,10 @@ const createMcpPreviewHandlers = ({
|
|
|
240971
241349
|
return;
|
|
240972
241350
|
}
|
|
240973
241351
|
const isProjectHost = url2.hostname.startsWith("p-") && (url2.hostname.endsWith(".wstd.dev") || url2.hostname.endsWith(".apps.webstudio.is"));
|
|
240974
|
-
if (isProjectHost
|
|
241352
|
+
if (isProjectHost) {
|
|
240975
241353
|
throw Object.assign(
|
|
240976
241354
|
new Error(
|
|
240977
|
-
|
|
241355
|
+
'This is a Webstudio Builder/share URL, not a generated site. Link the project with webstudio init --link, then capture only the generated site with screenshot { path: "/" }. Do not screenshot the Builder UI.'
|
|
240978
241356
|
),
|
|
240979
241357
|
{ code: "BUILDER_URL_IS_NOT_SITE_PREVIEW" }
|
|
240980
241358
|
);
|
|
@@ -240992,29 +241370,48 @@ const createMcpPreviewHandlers = ({
|
|
|
240992
241370
|
rejectBuilderUrl(input2.baseUrl);
|
|
240993
241371
|
return new URL(input2.path, input2.baseUrl).toString();
|
|
240994
241372
|
}
|
|
240995
|
-
const
|
|
240996
|
-
|
|
240997
|
-
|
|
241373
|
+
const mode = input2.mode ?? "iterative";
|
|
241374
|
+
const source = getPreviewSource(input2.source);
|
|
241375
|
+
const previewStatus = preview2.status();
|
|
241376
|
+
const targetCompatible = isPreviewTargetCompatible(
|
|
241377
|
+
input2,
|
|
241378
|
+
mode,
|
|
241379
|
+
previewStatus
|
|
241380
|
+
);
|
|
241381
|
+
if (previewStatus.running === false || targetCompatible === false || activeSource !== void 0 && activeSource !== source || isStale()) {
|
|
241382
|
+
const canReusePreview = mode === "iterative" && targetCompatible;
|
|
241383
|
+
if (canReusePreview === false) {
|
|
241384
|
+
await closeCaptureSession();
|
|
241385
|
+
}
|
|
240998
241386
|
validatePreviewServerOptions({
|
|
240999
241387
|
host: input2.host ?? "127.0.0.1",
|
|
241000
241388
|
port: input2.port ?? 5173,
|
|
241001
241389
|
imageDomains: input2.imageDomains
|
|
241002
241390
|
});
|
|
241003
241391
|
progress2?.report("tool screenshot preparing generated preview project");
|
|
241392
|
+
const freshness = captureFreshness();
|
|
241004
241393
|
const previewProject = await preparePreview(
|
|
241005
|
-
|
|
241006
|
-
prepareSessionDataFile
|
|
241394
|
+
source,
|
|
241395
|
+
prepareSessionDataFile,
|
|
241396
|
+
{
|
|
241397
|
+
preserveGeneratedProject: canReusePreview && mode === "iterative",
|
|
241398
|
+
prepareForIncrementalGeneration: mode === "iterative"
|
|
241399
|
+
}
|
|
241400
|
+
);
|
|
241401
|
+
progress2?.report(
|
|
241402
|
+
`tool screenshot ${canReusePreview ? "refreshing" : "starting"} ${mode} preview server`
|
|
241007
241403
|
);
|
|
241008
|
-
progress2?.report("tool screenshot starting production preview server");
|
|
241009
241404
|
await preview2.startAndWait({
|
|
241010
241405
|
cwd: previewProject.cwd,
|
|
241011
241406
|
buildCacheKey: previewProject.buildCacheKey,
|
|
241012
241407
|
host: input2.host,
|
|
241013
241408
|
port: input2.port,
|
|
241014
241409
|
imageDomains: input2.imageDomains,
|
|
241015
|
-
|
|
241410
|
+
mode,
|
|
241411
|
+
restart: canReusePreview === false
|
|
241016
241412
|
});
|
|
241017
|
-
|
|
241413
|
+
activeSource = source;
|
|
241414
|
+
markFresh(freshness);
|
|
241018
241415
|
}
|
|
241019
241416
|
return preview2.resolveUrl(input2.path);
|
|
241020
241417
|
};
|
|
@@ -241037,109 +241434,177 @@ const createMcpPreviewHandlers = ({
|
|
|
241037
241434
|
quality: input2.quality,
|
|
241038
241435
|
scale: input2.scale
|
|
241039
241436
|
});
|
|
241437
|
+
const assertGeneratedSiteCapture = (input2, result) => {
|
|
241438
|
+
if (input2.path !== void 0 && input2.baseUrl === void 0 && result.navigation?.generatedSiteRootPresent === false) {
|
|
241439
|
+
throw Object.assign(
|
|
241440
|
+
new Error(
|
|
241441
|
+
'Screenshot did not render the generated Webstudio site. Capture the route with screenshot { path: "/" }; do not capture the Builder UI.'
|
|
241442
|
+
),
|
|
241443
|
+
{ code: "SCREENSHOT_NOT_GENERATED_SITE" }
|
|
241444
|
+
);
|
|
241445
|
+
}
|
|
241446
|
+
return result;
|
|
241447
|
+
};
|
|
241040
241448
|
return {
|
|
241041
241449
|
async startPreview(input2, progress2) {
|
|
241042
|
-
await
|
|
241043
|
-
|
|
241044
|
-
|
|
241045
|
-
|
|
241046
|
-
|
|
241047
|
-
|
|
241048
|
-
|
|
241049
|
-
|
|
241050
|
-
|
|
241051
|
-
|
|
241052
|
-
|
|
241053
|
-
|
|
241054
|
-
|
|
241055
|
-
|
|
241056
|
-
|
|
241057
|
-
|
|
241058
|
-
|
|
241059
|
-
|
|
241060
|
-
|
|
241450
|
+
return await runPreviewLifecycle(async () => {
|
|
241451
|
+
const mode = input2.mode ?? "iterative";
|
|
241452
|
+
const source = getPreviewSource(input2.source);
|
|
241453
|
+
const canReusePreview = mode === "iterative" && isPreviewTargetCompatible(input2, mode, preview2.status());
|
|
241454
|
+
if (canReusePreview === false) {
|
|
241455
|
+
await closeCaptureSession();
|
|
241456
|
+
}
|
|
241457
|
+
validatePreviewServerOptions({
|
|
241458
|
+
host: input2.host ?? "127.0.0.1",
|
|
241459
|
+
port: input2.port ?? 5173,
|
|
241460
|
+
imageDomains: input2.imageDomains
|
|
241461
|
+
});
|
|
241462
|
+
progress2?.report(
|
|
241463
|
+
"tool preview.start preparing generated preview project"
|
|
241464
|
+
);
|
|
241465
|
+
const freshness = captureFreshness();
|
|
241466
|
+
const previewProject = await preparePreview(
|
|
241467
|
+
source,
|
|
241468
|
+
prepareSessionDataFile,
|
|
241469
|
+
{
|
|
241470
|
+
preserveGeneratedProject: canReusePreview && mode === "iterative",
|
|
241471
|
+
prepareForIncrementalGeneration: mode === "iterative"
|
|
241472
|
+
}
|
|
241473
|
+
);
|
|
241474
|
+
progress2?.report(
|
|
241475
|
+
`tool preview.start ${canReusePreview ? "refreshing" : "starting"} ${mode} preview server`
|
|
241476
|
+
);
|
|
241477
|
+
const result = await preview2.startAndWait({
|
|
241478
|
+
...input2,
|
|
241479
|
+
mode,
|
|
241480
|
+
cwd: previewProject.cwd,
|
|
241481
|
+
buildCacheKey: previewProject.buildCacheKey,
|
|
241482
|
+
restart: canReusePreview === false
|
|
241483
|
+
});
|
|
241484
|
+
activeSource = source;
|
|
241485
|
+
markFresh(freshness);
|
|
241486
|
+
return {
|
|
241487
|
+
...result,
|
|
241488
|
+
...mode === "production" ? {
|
|
241489
|
+
generatedBuildMetrics: await inspectGeneratedBuildMetrics(
|
|
241490
|
+
previewProject.cwd
|
|
241491
|
+
)
|
|
241492
|
+
} : {}
|
|
241493
|
+
};
|
|
241061
241494
|
});
|
|
241062
|
-
markFresh();
|
|
241063
|
-
return {
|
|
241064
|
-
...result,
|
|
241065
|
-
generatedBuildMetrics: await inspectGeneratedBuildMetrics(
|
|
241066
|
-
previewProject.cwd
|
|
241067
|
-
)
|
|
241068
|
-
};
|
|
241069
241495
|
},
|
|
241070
241496
|
async captureScreenshot(input2, progress2) {
|
|
241071
|
-
|
|
241072
|
-
|
|
241073
|
-
|
|
241074
|
-
|
|
241075
|
-
|
|
241076
|
-
|
|
241077
|
-
|
|
241078
|
-
|
|
241079
|
-
|
|
241080
|
-
|
|
241081
|
-
|
|
241082
|
-
|
|
241083
|
-
|
|
241497
|
+
return await runPreviewLifecycle(async () => {
|
|
241498
|
+
const startedAt = Date.now();
|
|
241499
|
+
const url2 = await resolveScreenshotUrl(input2, progress2);
|
|
241500
|
+
const previewReadyAt = Date.now();
|
|
241501
|
+
progress2?.report(`tool screenshot capturing ${url2}`);
|
|
241502
|
+
const captureOptions = getCaptureOptions(input2, url2);
|
|
241503
|
+
let result;
|
|
241504
|
+
if (getPreviewSource(input2.source) !== "local" && createCaptureSession !== void 0) {
|
|
241505
|
+
result = await (await getCaptureSession(input2)).capture(captureOptions);
|
|
241506
|
+
} else {
|
|
241507
|
+
result = await captureScreenshot2({
|
|
241508
|
+
...captureOptions,
|
|
241509
|
+
isJson: false,
|
|
241510
|
+
isMcp: true,
|
|
241511
|
+
isInteractive: false,
|
|
241512
|
+
confirmInstall: async () => false
|
|
241513
|
+
});
|
|
241514
|
+
}
|
|
241515
|
+
const completedAt = Date.now();
|
|
241516
|
+
return {
|
|
241517
|
+
...assertGeneratedSiteCapture(input2, result),
|
|
241518
|
+
...input2.path !== void 0 && input2.baseUrl === void 0 ? { previewMode: preview2.status().mode } : {},
|
|
241519
|
+
lifecycleTimings: {
|
|
241520
|
+
previewRefreshMs: previewReadyAt - startedAt,
|
|
241521
|
+
captureMs: completedAt - previewReadyAt,
|
|
241522
|
+
totalMs: completedAt - startedAt
|
|
241523
|
+
}
|
|
241524
|
+
};
|
|
241084
241525
|
});
|
|
241085
241526
|
},
|
|
241086
241527
|
async capturePageScreenshots(inputs, progress2) {
|
|
241087
|
-
|
|
241088
|
-
|
|
241089
|
-
|
|
241090
|
-
|
|
241091
|
-
|
|
241092
|
-
|
|
241093
|
-
|
|
241528
|
+
return await runPreviewLifecycle(async () => {
|
|
241529
|
+
const firstInput = inputs[0];
|
|
241530
|
+
if (firstInput === void 0) {
|
|
241531
|
+
return [];
|
|
241532
|
+
}
|
|
241533
|
+
const previewTarget = getPreviewTarget(firstInput);
|
|
241534
|
+
if (createCaptureSession === void 0 || previewTarget.source === "local" || inputs.some(
|
|
241535
|
+
(input2) => isSamePreviewTarget(getPreviewTarget(input2), previewTarget) === false || isSameCaptureSessionConfig(
|
|
241536
|
+
getCaptureSessionConfig(input2),
|
|
241537
|
+
getCaptureSessionConfig(firstInput)
|
|
241538
|
+
) === false
|
|
241539
|
+
)) {
|
|
241540
|
+
throw new Error(
|
|
241541
|
+
"Resized screenshot capture requires one session preview target and browser configuration."
|
|
241542
|
+
);
|
|
241543
|
+
}
|
|
241544
|
+
const urls = [];
|
|
241545
|
+
for (const input2 of inputs) {
|
|
241546
|
+
urls.push(await resolveScreenshotUrl(input2, progress2));
|
|
241547
|
+
}
|
|
241548
|
+
progress2?.report(
|
|
241549
|
+
`tool screenshot capturing ${new Set(urls).size} pages across ${inputs.length} viewport widths`
|
|
241094
241550
|
);
|
|
241095
|
-
|
|
241096
|
-
|
|
241097
|
-
|
|
241098
|
-
|
|
241099
|
-
|
|
241100
|
-
|
|
241101
|
-
|
|
241102
|
-
|
|
241103
|
-
|
|
241104
|
-
|
|
241105
|
-
|
|
241106
|
-
|
|
241107
|
-
|
|
241108
|
-
|
|
241109
|
-
|
|
241110
|
-
|
|
241111
|
-
|
|
241112
|
-
|
|
241551
|
+
const results = await (await getCaptureSession(firstInput)).capturePage(
|
|
241552
|
+
inputs.map((input2, index2) => {
|
|
241553
|
+
const url2 = urls[index2];
|
|
241554
|
+
if (url2 === void 0) {
|
|
241555
|
+
throw new Error("Screenshot URL resolution was incomplete.");
|
|
241556
|
+
}
|
|
241557
|
+
return getCaptureOptions(input2, url2);
|
|
241558
|
+
})
|
|
241559
|
+
);
|
|
241560
|
+
return results.map((result, index2) => {
|
|
241561
|
+
const input2 = inputs[index2];
|
|
241562
|
+
if (input2 === void 0) {
|
|
241563
|
+
throw new Error("Screenshot input was omitted from the batch.");
|
|
241564
|
+
}
|
|
241565
|
+
return {
|
|
241566
|
+
...assertGeneratedSiteCapture(input2, result),
|
|
241567
|
+
...input2.path !== void 0 && input2.baseUrl === void 0 ? { previewMode: preview2.status().mode } : {}
|
|
241568
|
+
};
|
|
241569
|
+
});
|
|
241570
|
+
});
|
|
241113
241571
|
},
|
|
241114
241572
|
async stopPreview() {
|
|
241115
|
-
|
|
241116
|
-
|
|
241117
|
-
|
|
241118
|
-
|
|
241119
|
-
|
|
241120
|
-
|
|
241121
|
-
let result;
|
|
241122
|
-
try {
|
|
241123
|
-
if (preview2.stop === void 0) {
|
|
241124
|
-
throw new Error("Preview controller cannot stop its owned preview.");
|
|
241573
|
+
return await runPreviewLifecycle(async () => {
|
|
241574
|
+
const errors = [];
|
|
241575
|
+
try {
|
|
241576
|
+
await closeCaptureSession();
|
|
241577
|
+
} catch (error) {
|
|
241578
|
+
errors.push(error);
|
|
241125
241579
|
}
|
|
241126
|
-
result
|
|
241127
|
-
|
|
241128
|
-
|
|
241129
|
-
|
|
241130
|
-
|
|
241131
|
-
|
|
241132
|
-
|
|
241133
|
-
|
|
241134
|
-
|
|
241135
|
-
|
|
241136
|
-
|
|
241137
|
-
|
|
241138
|
-
|
|
241139
|
-
|
|
241140
|
-
|
|
241141
|
-
|
|
241142
|
-
|
|
241580
|
+
let result;
|
|
241581
|
+
try {
|
|
241582
|
+
if (preview2.stop === void 0) {
|
|
241583
|
+
throw new Error(
|
|
241584
|
+
"Preview controller cannot stop its owned preview."
|
|
241585
|
+
);
|
|
241586
|
+
}
|
|
241587
|
+
result = await preview2.stop();
|
|
241588
|
+
activeSource = void 0;
|
|
241589
|
+
} catch (error) {
|
|
241590
|
+
errors.push(error);
|
|
241591
|
+
}
|
|
241592
|
+
if (errors.length === 1) {
|
|
241593
|
+
throw errors[0];
|
|
241594
|
+
}
|
|
241595
|
+
if (errors.length > 1) {
|
|
241596
|
+
throw new AggregateError(
|
|
241597
|
+
errors,
|
|
241598
|
+
"Could not clean up screenshot capture or stop the owned preview."
|
|
241599
|
+
);
|
|
241600
|
+
}
|
|
241601
|
+
if (result === void 0) {
|
|
241602
|
+
throw new Error(
|
|
241603
|
+
"Preview controller did not return its stopped state."
|
|
241604
|
+
);
|
|
241605
|
+
}
|
|
241606
|
+
return result;
|
|
241607
|
+
});
|
|
241143
241608
|
}
|
|
241144
241609
|
};
|
|
241145
241610
|
};
|
|
@@ -241705,17 +242170,13 @@ const createCliMcpHost = async ({
|
|
|
241705
242170
|
);
|
|
241706
242171
|
await prepareMcpProjectSession(session);
|
|
241707
242172
|
const preview2 = createPreviewController({ host: "127.0.0.1", port: 5173 });
|
|
241708
|
-
|
|
241709
|
-
const markPreviewStale = () => {
|
|
241710
|
-
isPreviewStale = true;
|
|
241711
|
-
};
|
|
242173
|
+
const previewFreshness = createPreviewFreshness();
|
|
241712
242174
|
const previewHandlers = createMcpPreviewHandlers({
|
|
241713
242175
|
preview: preview2,
|
|
241714
242176
|
createCaptureSession: createScreenshotCaptureSession,
|
|
241715
|
-
isStale:
|
|
241716
|
-
|
|
241717
|
-
|
|
241718
|
-
},
|
|
242177
|
+
isStale: previewFreshness.isStale,
|
|
242178
|
+
captureFreshness: previewFreshness.capture,
|
|
242179
|
+
markFresh: previewFreshness.markFresh,
|
|
241719
242180
|
prepareSessionDataFile: async () => {
|
|
241720
242181
|
await writeCliProjectSessionDataFile(
|
|
241721
242182
|
getLoadedProjectSessionSnapshot(session),
|
|
@@ -241724,21 +242185,29 @@ const createCliMcpHost = async ({
|
|
|
241724
242185
|
);
|
|
241725
242186
|
}
|
|
241726
242187
|
});
|
|
241727
|
-
const toProjectSessionScreenshotResult = (result) =>
|
|
241728
|
-
|
|
241729
|
-
|
|
241730
|
-
|
|
241731
|
-
|
|
241732
|
-
|
|
241733
|
-
|
|
241734
|
-
|
|
241735
|
-
|
|
241736
|
-
|
|
241737
|
-
|
|
241738
|
-
|
|
242188
|
+
const toProjectSessionScreenshotResult = (result) => {
|
|
242189
|
+
const navigation = result.navigation ?? result.layout?.navigation;
|
|
242190
|
+
return {
|
|
242191
|
+
output: result.output,
|
|
242192
|
+
browserPath: result.browser.path,
|
|
242193
|
+
browser: result.browser.browser,
|
|
242194
|
+
viewport: result.viewport,
|
|
242195
|
+
fullPage: result.fullPage,
|
|
242196
|
+
elapsedMs: result.elapsedMs,
|
|
242197
|
+
warnings: result.warnings,
|
|
242198
|
+
previewMode: result.previewMode,
|
|
242199
|
+
renderedProjectId: navigation?.projectId,
|
|
242200
|
+
renderedProjectVersion: navigation?.projectVersion,
|
|
242201
|
+
..."lifecycleTimings" in result ? { lifecycleTimings: result.lifecycleTimings } : {},
|
|
242202
|
+
navigation: result.navigation,
|
|
242203
|
+
layout: result.layout,
|
|
242204
|
+
timings: result.timings
|
|
242205
|
+
};
|
|
242206
|
+
};
|
|
241739
242207
|
const host = {
|
|
241740
242208
|
operations,
|
|
241741
242209
|
createProjectSession: () => session,
|
|
242210
|
+
onProjectSessionChange: previewFreshness.markStale,
|
|
241742
242211
|
executeOperation: async ({ command, input: input2, dryRun }) => {
|
|
241743
242212
|
const result = await executeProjectSessionApiOperation({
|
|
241744
242213
|
command,
|
|
@@ -241748,7 +242217,7 @@ const createCliMcpHost = async ({
|
|
|
241748
242217
|
dryRun
|
|
241749
242218
|
});
|
|
241750
242219
|
if (dryRun !== true && shouldInvalidatePreview(command)) {
|
|
241751
|
-
|
|
242220
|
+
previewFreshness.markStale();
|
|
241752
242221
|
}
|
|
241753
242222
|
return result;
|
|
241754
242223
|
},
|
|
@@ -241772,7 +242241,11 @@ const createCliMcpHost = async ({
|
|
|
241772
242241
|
code: "NOT_FOUND"
|
|
241773
242242
|
});
|
|
241774
242243
|
}
|
|
241775
|
-
|
|
242244
|
+
const result = await session.restoreSnapshot(restorePoint, { dryRun });
|
|
242245
|
+
if (dryRun !== true) {
|
|
242246
|
+
previewFreshness.markStale();
|
|
242247
|
+
}
|
|
242248
|
+
return result;
|
|
241776
242249
|
}
|
|
241777
242250
|
},
|
|
241778
242251
|
async importProject(input2) {
|
|
@@ -241803,7 +242276,7 @@ const createCliMcpHost = async ({
|
|
|
241803
242276
|
}
|
|
241804
242277
|
throw error;
|
|
241805
242278
|
}
|
|
241806
|
-
|
|
242279
|
+
previewFreshness.markStale();
|
|
241807
242280
|
return { imported: true };
|
|
241808
242281
|
},
|
|
241809
242282
|
async downloadAsset(input2) {
|