Skip to content

Open source website builder and Webflow alternative. Webstudio is an advanced visual builder that connects to any headless CMS, supports all CSS properties, and can be hosted anywhere, including with us.

fix: Capture preview failure diagnostics (#6206)

Oleg Isonendf3601c26a1d
diff --git a/apps/builder/app/services/github-issue-report.server.test.ts b/apps/builder/app/services/github-issue-report.server.test.ts
index a07a79e0fe..64d6d73568 100644
--- a/apps/builder/app/services/github-issue-report.server.test.ts
+++ b/apps/builder/app/services/github-issue-report.server.test.ts
@@ -26,6 +26,18 @@ const report: IssueReportInput = {
architecture: "arm64",
executionMode: "mcp",
apiContractVersion: "public-api:client",
+ bundleVersion: "bundle:client",
+ recentFailure: {
+ tool: "preview.start",
+ code: "PROJECT_BUNDLE_INVALID",
+ issues: [
+ {
+ path: ["assets", "0", "type"],
+ code: "invalid_value",
+ constraint: 'one of "font"|"image"|"video"|"file"',
+ },
+ ],
+ },
},
report: {
userStory:
@@ -55,6 +67,13 @@ describe("GitHub issue reports", () => {
expect(body).toContain("- Operating system: linux 6 (arm64)");
expect(body).toContain("- Execution mode: mcp");
expect(body).toContain("- API contract: public-api:client");
+ expect(body).toContain("- Bundle contract: bundle:client");
+ expect(body).toContain("## Captured failure diagnostics");
+ expect(body).toContain("- Tool: `preview.start`");
+ expect(body).toContain("- Error code: `PROJECT_BUNDLE_INVALID`");
+ expect(body).toContain(
+ '- `assets.0.type`: `invalid_value` (one of "font"|"image"|"video"|"file")'
+ );
expect(body).toContain("- Model: gpt-5.6-sol");
expect(body).toContain("- Reasoning effort: medium");
expect(body).toContain(
diff --git a/apps/builder/app/services/github-issue-report.server.ts b/apps/builder/app/services/github-issue-report.server.ts
index 353d9940a2..1744433444 100644
--- a/apps/builder/app/services/github-issue-report.server.ts
+++ b/apps/builder/app/services/github-issue-report.server.ts
@@ -35,9 +35,34 @@ const formatRuntime = (runtime: IssueReportInput["runtime"]) =>
`- Operating system: ${runtime.os} ${runtime.osVersion} (${runtime.architecture})`,
`- Execution mode: ${runtime.executionMode}`,
`- API contract: ${runtime.apiContractVersion}`,
+ `- Bundle contract: ${runtime.bundleVersion ?? "unknown"}`,
]),
].join("\n");
+const formatFailureDiagnostics = (runtime: IssueReportInput["runtime"]) => {
+ const failure = runtime?.recentFailure;
+ if (failure === undefined) {
+ return "";
+ }
+ const issues = failure.issues ?? [];
+ return [
+ "## Captured failure diagnostics",
+ "",
+ `- Tool: \`${failure.tool}\``,
+ `- Error code: \`${failure.code}\``,
+ ...(issues.length === 0
+ ? []
+ : [
+ "- Invalid fields:",
+ ...issues.map(
+ (issue) =>
+ ` - \`${issue.path.join(".") || "input"}\`: \`${issue.code}\` (${issue.constraint})`
+ ),
+ ]),
+ "",
+ ].join("\n");
+};
+
export const formatIssueReport = ({
agent,
category,
@@ -90,6 +115,8 @@ ${report.technicalContext}
${formatRuntime(runtime)}
+${formatFailureDiagnostics(runtime)}
+
## Acceptance criteria
${formatItems(report.acceptanceCriteria)}
diff --git a/packages/cli/src/commands/mcp.test.ts b/packages/cli/src/commands/mcp.test.ts
index 6caabfd525..7fd85d22e4 100644
--- a/packages/cli/src/commands/mcp.test.ts
+++ b/packages/cli/src/commands/mcp.test.ts
@@ -157,17 +157,26 @@ test("keeps every MCP API tool aligned with its public API contract", () => {
? ["confirmDestructive", "confirmationToken"]
: []),
];
+ const cliOwnedFields =
+ operation.command === "report-issue" ? ["runtime"] : [];
const schemaMetadata = getInputJsonSchemaMetadata(schema);
const semanticFields = schemaMetadata.inputFields.filter(
(field) => transportFields.includes(field) === false
);
expect(new Set(semanticFields), operation.command).toEqual(
- new Set(operation.inputFields)
+ new Set(
+ operation.inputFields.filter(
+ (field) => cliOwnedFields.includes(field) === false
+ )
+ )
);
const apiProperties = getInputJsonSchemaProperties(operation.inputSchema);
const mcpProperties = getInputJsonSchemaProperties(schema);
for (const field of operation.inputFields) {
+ if (cliOwnedFields.includes(field)) {
+ continue;
+ }
const isRepresentationOverride =
(operation.command === "insert-fragment" &&
["parentInstanceId", "fragment"].includes(field)) ||
@@ -181,7 +190,9 @@ test("keeps every MCP API tool aligned with its public API contract", () => {
).toEqual(apiProperties?.[field]);
}
- const requiredFields = [...operation.requiredInputFields];
+ const requiredFields = operation.requiredInputFields.filter(
+ (field) => cliOwnedFields.includes(field) === false
+ );
if (
operation.command === "insert-fragment" &&
requiredFields.includes("parentInstanceId") === false
diff --git a/packages/cli/src/commands/mcp.ts b/packages/cli/src/commands/mcp.ts
index 27e568f080..34cebb46a0 100644
--- a/packages/cli/src/commands/mcp.ts
+++ b/packages/cli/src/commands/mcp.ts
@@ -15,6 +15,7 @@ import { diffPngFiles } from "@webstudio-is/vision/diff";
import {
publicApiOperationRequiresServerSupport,
publicApiOperations,
+ type IssueReportRecentFailure,
} from "@webstudio-is/protocol";
import * as httpClient from "@webstudio-is/http-client";
import packageJson from "../../package.json" with { type: "json" };
@@ -33,6 +34,8 @@ import {
assertCliServerOperationSupported,
createCliProjectRestorePointStorage,
createCliProjectSession,
+ createIssueReportFailure,
+ createIssueReportRuntime,
getCliProjectRestorePointsFile,
getCliServerApiContract,
getSupportedPublicApiOperations,
@@ -985,10 +988,12 @@ const createCliMcpHost = async ({
};
const apiContract = await getCliServerApiContract(apiConnection);
const operations = getSupportedPublicApiOperations(apiContract);
+ let recentFailure: IssueReportRecentFailure | undefined;
const session = createCliProjectSession({
connection: apiConnection,
projectRoot,
sessionProjectId: projectId,
+ issueReportRuntime: () => createIssueReportRuntime(recentFailure),
});
const restorePointStorage = createCliProjectRestorePointStorage(
getCliProjectRestorePointsFile(projectRoot, projectId)
@@ -1229,6 +1234,9 @@ const createCliMcpHost = async ({
host,
apiContract,
toolCount: operations.length,
+ recordToolFailure(canonicalTool: string, error: unknown) {
+ recentFailure = createIssueReportFailure(canonicalTool, error);
+ },
reportLog(message: string) {
if (message.startsWith("ready with ")) {
return;
@@ -1806,10 +1814,16 @@ export const mcp = async (
stdin.once("end", reportClose);
stdin.once("close", reportClose);
status.starting();
- const { host, toolCount, reportLog, apiContract, dispose } =
- await createCliMcpHost({
- projectId: options.project,
- });
+ const {
+ host,
+ toolCount,
+ reportLog,
+ recordToolFailure,
+ apiContract,
+ dispose,
+ } = await createCliMcpHost({
+ projectId: options.project,
+ });
disposeHost = dispose;
if (didReportClose) {
await disposeHost().catch(() => undefined);
@@ -1822,6 +1836,7 @@ export const mcp = async (
...host,
toolNameFormat: options.toolNameFormat,
getErrorCode: getStableErrorCode,
+ onToolFailure: recordToolFailure,
reportLog: (_level, message) => {
reportLog(message);
},
diff --git a/packages/cli/src/error-codes.test.ts b/packages/cli/src/error-codes.test.ts
index 52d242a899..a3e65958a9 100644
--- a/packages/cli/src/error-codes.test.ts
+++ b/packages/cli/src/error-codes.test.ts
@@ -20,6 +20,12 @@ describe("getStableErrorCode", () => {
)
).toBe("NOT_FOUND");
});
+
+ test("rejects dynamic values as stable error codes", () => {
+ expect(getStableErrorCode({ code: "customer-specific-code" })).toBe(
+ undefined
+ );
+ });
});
describe("getCliErrorMessage", () => {
diff --git a/packages/cli/src/error-codes.ts b/packages/cli/src/error-codes.ts
index 85720668b4..2f57785ad7 100644
--- a/packages/cli/src/error-codes.ts
+++ b/packages/cli/src/error-codes.ts
@@ -9,6 +9,7 @@ import {
const missingProjectOwnerForTokenPattern =
/^Project owner can't be found for token\b/;
+const stableErrorCodePattern = /^[A-Z][A-Z0-9_]{0,159}$/;
const getErrorMessage = (error: unknown) =>
typeof error === "object" &&
@@ -21,16 +22,14 @@ const getErrorMessage = (error: unknown) =>
: String(error);
export const getStableErrorCode = (error: unknown) => {
- const apiErrorCode = getApiErrorCode(error);
- if (apiErrorCode !== undefined) {
- return apiErrorCode;
- }
- if (typeof error === "object" && error !== null && "code" in error) {
- const code = (error as { code?: unknown }).code;
- if (typeof code === "string") {
- return code;
- }
- }
+ const directErrorCode =
+ typeof error === "object" && error !== null && "code" in error
+ ? (error as { code?: unknown }).code
+ : undefined;
+ const code = getApiErrorCode(error) ?? directErrorCode;
+ return typeof code === "string" && stableErrorCodePattern.test(code)
+ ? code
+ : undefined;
};
export const isMissingApiAccessError = (error: unknown) => {
diff --git a/packages/cli/src/prebuild.test.ts b/packages/cli/src/prebuild.test.ts
index 82dfa5cbb6..fcc4a962b0 100644
--- a/packages/cli/src/prebuild.test.ts
+++ b/packages/cli/src/prebuild.test.ts
@@ -3000,4 +3000,28 @@ sitemap.map((page) => page.path);`
"Project bundle is invalid, please make sure the project is synced. Invalid fields: page: Required"
);
});
+
+ test("exposes anonymous structured diagnostics for invalid asset fields", async () => {
+ const data = structuredClone(createSiteData()) as unknown as {
+ assets: Array<Record<string, unknown>>;
+ };
+ data.assets[0] = { ...data.assets[0], type: "future-video" };
+ await writeFile(".webstudio/data.json", JSON.stringify(data));
+
+ try {
+ await prebuild({ assets: false, template: ["defaults"] });
+ throw new Error("Expected invalid bundle to fail.");
+ } catch (error) {
+ expect(error).toMatchObject({
+ code: "PROJECT_BUNDLE_INVALID",
+ bundleVersion,
+ issues: expect.arrayContaining([
+ expect.objectContaining({
+ path: ["assets", "0", "type"],
+ code: "invalid_value",
+ }),
+ ]),
+ });
+ }
+ });
});
diff --git a/packages/cli/src/prebuild.ts b/packages/cli/src/prebuild.ts
index 2d480ffb2d..d9a16988b3 100644
--- a/packages/cli/src/prebuild.ts
+++ b/packages/cli/src/prebuild.ts
@@ -57,7 +57,10 @@ import {
type ComponentBuildContribution,
} from "@webstudio-is/sdk";
import { migratePages } from "@webstudio-is/project-migrations/pages";
-import { collectFontFamiliesFromStyleDecls } from "@webstudio-is/project-build/runtime";
+import {
+ collectFontFamiliesFromStyleDecls,
+ getZodValidationIssues,
+} from "@webstudio-is/project-build/runtime";
import {
assetQueryFilter,
type AssetRuntimeData,
@@ -83,6 +86,7 @@ import {
getQueryConditions,
} from "@webstudio-is/query-builder/runtime";
import {
+ bundleVersion,
publishedProjectBundle,
type PublishedProjectBundle,
} from "@webstudio-is/protocol";
@@ -911,11 +915,18 @@ export const prebuild = async (options: {
}
const parsedSiteData = publishedProjectBundle.safeParse(loadedSiteData);
if (parsedSiteData.success === false) {
- throw new Error(
- `Project bundle is invalid, please make sure the project is synced. Invalid fields: ${formatZodIssues(
- parsedSiteData.error.issues,
- loadedSiteData
- )}`
+ throw Object.assign(
+ new Error(
+ `Project bundle is invalid, please make sure the project is synced. Invalid fields: ${formatZodIssues(
+ parsedSiteData.error.issues,
+ loadedSiteData
+ )}`
+ ),
+ {
+ code: "PROJECT_BUNDLE_INVALID",
+ bundleVersion,
+ issues: getZodValidationIssues(parsedSiteData.error),
+ }
);
}
const siteData = parsedSiteData.data;
diff --git a/packages/cli/src/project-session.test.ts b/packages/cli/src/project-session.test.ts
index fbfc8df306..b1730a49e6 100644
--- a/packages/cli/src/project-session.test.ts
+++ b/packages/cli/src/project-session.test.ts
@@ -11,6 +11,7 @@ import {
createCliProjectRestorePointStorage,
createCliProjectSessionStorage,
createCliProjectSessionTransport,
+ createIssueReportFailure,
addIssueReportRuntime,
getCliServerApiContract,
getCliProjectSessionFile,
@@ -30,6 +31,18 @@ test("adds anonymous local runtime metadata only to issue reports", () => {
architecture: "arm64",
executionMode: "mcp" as const,
apiContractVersion: "public-api:client",
+ bundleVersion: "bundle:client",
+ recentFailure: {
+ tool: "preview.start",
+ code: "PROJECT_BUNDLE_INVALID",
+ issues: [
+ {
+ path: ["assets", "0", "type"],
+ code: "invalid_value",
+ constraint: "one of supported asset types",
+ },
+ ],
+ },
};
expect(addIssueReportRuntime("report-issue", report, runtime)).toEqual({
@@ -39,6 +52,43 @@ test("adds anonymous local runtime metadata only to issue reports", () => {
expect(addIssueReportRuntime("audit", report, runtime)).toBe(report);
});
+test("keeps only anonymous structured fields from the latest tool failure", () => {
+ const error = Object.assign(new Error("Asset customer-logo.png is invalid"), {
+ code: "PROJECT_BUNDLE_INVALID",
+ issues: [
+ {
+ path: ["assets", "0", "type"],
+ code: "invalid_value",
+ message: "Customer-specific value is unsupported",
+ constraint: "one of supported asset types",
+ detail: "Asset customer-logo.png belongs to project-123",
+ },
+ ],
+ });
+
+ expect(createIssueReportFailure("preview.start", error)).toEqual({
+ tool: "preview.start",
+ code: "PROJECT_BUNDLE_INVALID",
+ issues: [
+ {
+ path: ["assets", "0", "type"],
+ code: "invalid_value",
+ constraint: "one of supported asset types",
+ },
+ ],
+ });
+
+ expect(
+ createIssueReportFailure("unknown", {
+ code: "dynamic-code",
+ issues: error.issues,
+ })
+ ).toEqual({
+ tool: "unknown",
+ code: "MCP_TOOL_FAILED",
+ });
+});
+
test("scopes project session files for explicitly selected projects", () => {
expect(getCliProjectSessionFile("/workspace", "project/a")).toBe(
"/workspace/.webstudio/projects/project%2Fa/project-session.json"
@@ -949,6 +999,7 @@ describe("cli project session transport", () => {
architecture: process.arch,
executionMode: "mcp",
apiContractVersion: expect.any(String),
+ bundleVersion: expect.any(String),
});
});
});
diff --git a/packages/cli/src/project-session.ts b/packages/cli/src/project-session.ts
index f83f791e9e..f41e61bd69 100644
--- a/packages/cli/src/project-session.ts
+++ b/packages/cli/src/project-session.ts
@@ -17,6 +17,7 @@ import {
publicApiOperationRequiresServerSupport,
publicApiOperations,
type IssueReportRuntime,
+ type IssueReportRecentFailure,
type PublicApiCommand,
type PublishedProjectBundle,
} from "@webstudio-is/protocol";
@@ -53,6 +54,7 @@ import {
type SerializedBuilderStateSnapshot,
} from "@webstudio-is/project-build/state";
import { removeLegacyProjectSettingsFromPages } from "@webstudio-is/project-build";
+import { getValidationIssues } from "@webstudio-is/project-build/runtime";
import type { BuilderStateFreshness } from "@webstudio-is/project-build/state";
import { getLocalProjectStateDirectory, LOCAL_DATA_FILE } from "./config";
import type { ApiConnection } from "./api-connection";
@@ -234,7 +236,9 @@ const publicOperationById = new Map(
publicApiOperations.map((operation) => [operation.id, operation])
);
-const getIssueReportRuntime = (): IssueReportRuntime => ({
+export const createIssueReportRuntime = (
+ recentFailure?: IssueReportRecentFailure
+): IssueReportRuntime => ({
cliVersion: packageJson.version,
nodeVersion: process.versions.node,
os: process.platform,
@@ -242,12 +246,36 @@ const getIssueReportRuntime = (): IssueReportRuntime => ({
architecture: process.arch,
executionMode: "mcp",
apiContractVersion: publicApiContractVersion,
+ bundleVersion,
+ recentFailure,
});
+export const createIssueReportFailure = (
+ canonicalTool: string,
+ error: unknown
+): IssueReportRecentFailure => {
+ const errorCode = getStableErrorCode(error);
+ const issues =
+ errorCode === "PROJECT_BUNDLE_INVALID"
+ ? getValidationIssues(error)
+ ?.slice(0, 30)
+ .map((issue) => ({
+ path: issue.path,
+ code: issue.code,
+ constraint: issue.constraint,
+ }))
+ : undefined;
+ return {
+ tool: canonicalTool,
+ code: errorCode ?? "MCP_TOOL_FAILED",
+ ...(issues === undefined || issues.length === 0 ? {} : { issues }),
+ };
+};
+
export const addIssueReportRuntime = (
command: PublicApiCommand,
input: unknown,
- runtime: IssueReportRuntime = getIssueReportRuntime()
+ runtime: IssueReportRuntime = createIssueReportRuntime()
) => {
if (command !== "report-issue" || isPlainRecord(input) === false) {
return input;
@@ -259,10 +287,12 @@ const executePublicServerOperation = async ({
connection,
operationId,
input,
+ issueReportRuntime,
}: {
connection: ApiConnection;
operationId: string;
input: unknown;
+ issueReportRuntime?: () => IssueReportRuntime;
}) => {
const operation = publicOperationById.get(operationId);
if (operation === undefined) {
@@ -278,10 +308,11 @@ const executePublicServerOperation = async ({
}
return await client({
...connection,
- ...(addIssueReportRuntime(operation.command, input) as Record<
- string,
- unknown
- >),
+ ...(addIssueReportRuntime(
+ operation.command,
+ input,
+ issueReportRuntime?.() ?? createIssueReportRuntime()
+ ) as Record<string, unknown>),
projectId: connection.projectId,
});
};
@@ -438,11 +469,13 @@ export const createCliProjectSessionTransport = ({
executeServerOperation,
getBuildSnapshot = httpClient.getBuildSnapshot,
getPermissions,
+ issueReportRuntime,
}: {
connection: ApiConnection;
executeServerOperation?: ProjectSessionTransport["executeServerOperation"];
getBuildSnapshot?: typeof httpClient.getBuildSnapshot;
getPermissions?: ProjectSessionTransport["getPermissions"];
+ issueReportRuntime?: () => IssueReportRuntime;
}): ProjectSessionTransport => ({
async getCompatibility() {
return createCliProjectSessionCompatibility(connection);
@@ -515,7 +548,12 @@ export const createCliProjectSessionTransport = ({
input: unknown;
}) =>
(await withMappedRemoteError(() =>
- executePublicServerOperation({ connection, operationId, input })
+ executePublicServerOperation({
+ connection,
+ operationId,
+ input,
+ issueReportRuntime,
+ })
)) as Result),
});
@@ -526,6 +564,7 @@ export const createCliProjectSession = ({
sessionProjectId,
executeServerOperation,
getPermissions,
+ issueReportRuntime,
}: {
connection: ApiConnection;
storage?: ProjectSessionStorage;
@@ -533,6 +572,7 @@ export const createCliProjectSession = ({
sessionProjectId?: string;
executeServerOperation?: ProjectSessionTransport["executeServerOperation"];
getPermissions?: ProjectSessionTransport["getPermissions"];
+ issueReportRuntime?: () => IssueReportRuntime;
}) =>
createProjectSession({
projectId: connection.projectId,
@@ -540,6 +580,7 @@ export const createCliProjectSession = ({
connection,
executeServerOperation,
getPermissions,
+ issueReportRuntime,
}),
storage:
storage ??
diff --git a/packages/project-build/src/mcp.test.ts b/packages/project-build/src/mcp.test.ts
index bb379fbf76..657ee05309 100644
--- a/packages/project-build/src/mcp.test.ts
+++ b/packages/project-build/src/mcp.test.ts
@@ -1197,6 +1197,29 @@ describe("project session mcp adapter", () => {
);
});
+ test("omits CLI-owned issue runtime from the MCP input schema", () => {
+ const [tool] = listProjectSessionMcpTools([
+ publicOperation({
+ command: "report-issue",
+ id: "reports.issue",
+ description: "Report an issue",
+ localCapable: false,
+ serverOnly: true,
+ inputSchema: getTestInputSchema(
+ z.object({
+ title: z.string(),
+ runtime: z
+ .object({ recentFailure: z.unknown().optional() })
+ .optional(),
+ })
+ ),
+ }),
+ ]);
+
+ expect(tool?.inputSchema.properties).toHaveProperty("title");
+ expect(tool?.inputSchema.properties).not.toHaveProperty("runtime");
+ });
+
test("documents the queried Assets result shape in focused tools", () => {
const contracts = runtimeOperationContracts.filter(({ id }) =>
["assetsResources.create", "assetsResources.update"].includes(id)
@@ -8622,6 +8645,7 @@ describe("project session mcp adapter", () => {
"Project session snapshot changed on disk."
) as Error & { code: string };
error.code = "PROJECT_SESSION_BUSY";
+ const onToolFailure = vi.fn();
const server = await createProjectSessionMcpServer({
operations: publicMcpOperations,
createProjectSession: createSessionFactory(),
@@ -8632,6 +8656,7 @@ describe("project session mcp adapter", () => {
typeof error === "object" && error !== null && "code" in error
? (error as { code?: string }).code
: undefined,
+ onToolFailure,
});
const { client, close } = await createConnectedClient(server);
@@ -8654,6 +8679,13 @@ describe("project session mcp adapter", () => {
},
})
);
+ expect(onToolFailure).toHaveBeenCalledWith("list-pages", error);
+
+ await client.callTool({
+ name: "customer/project",
+ arguments: {},
+ });
+ expect(onToolFailure.mock.calls.at(-1)?.[0]).toBe("unknown");
} finally {
await close();
}
diff --git a/packages/project-build/src/mcp.ts b/packages/project-build/src/mcp.ts
index d84dc9ce55..55794974c5 100644
--- a/packages/project-build/src/mcp.ts
+++ b/packages/project-build/src/mcp.ts
@@ -1400,6 +1400,14 @@ const getMcpOperationInputSchema = (
let schema = constrainUnconstrainedInputSchemas(
options.schema ?? getOperationInputSchema(operation)
);
+ if (operation.command === "report-issue") {
+ const { runtime: _runtime, ...properties } = schema.properties ?? {};
+ schema = {
+ ...schema,
+ properties,
+ required: schema.required?.filter((field) => field !== "runtime"),
+ };
+ }
const properties = getInputJsonSchemaProperties(schema);
if (
schema.additionalProperties === true &&
@@ -8405,12 +8413,14 @@ export const createProjectSessionMcpServer = async <
onInitialized,
toolNameFormat = "canonical",
toolHeartbeatIntervalMs = 10_000,
+ onToolFailure,
}: Omit<ProjectSessionMcpCoreOptions<Command>, "reportToolProgress"> & {
getErrorCode?: McpErrorCodeResolver;
reportLog?: (level: McpLogLevel, message: string) => void;
onInitialized?: (clientName: string | undefined) => void;
toolNameFormat?: "canonical" | "underscores";
toolHeartbeatIntervalMs?: number;
+ onToolFailure?: (canonicalTool: string, error: unknown) => void;
}) => {
const server = new Server(
{ name: "webstudio", version: "0.0.0" },
@@ -8526,6 +8536,7 @@ export const createProjectSessionMcpServer = async <
server.setRequestHandler(CallToolRequestSchema, async (request, extra) => {
const params = getRequestParams(request);
const exposedName = typeof params.name === "string" ? params.name : "";
+ const canonicalName = toolNameIndex.get(exposedName)?.name;
const name = toolNameIndex.resolve(exposedName);
const { input, dryRun } = getToolCallInput(params.arguments ?? {});
const startedAt = Date.now();
@@ -8549,6 +8560,7 @@ export const createProjectSessionMcpServer = async <
sendLog("info", `tool ${name} succeeded in ${Date.now() - startedAt}ms`);
return result;
} catch (error) {
+ onToolFailure?.(canonicalName ?? "unknown", error);
sendLog(
"error",
`tool ${name} failed in ${Date.now() - startedAt}ms: ${
diff --git a/packages/protocol/src/builder-api/__generated__/server-only-router-operation-metadata.ts b/packages/protocol/src/builder-api/__generated__/server-only-router-operation-metadata.ts
index da34565097..02232e8b52 100644
--- a/packages/protocol/src/builder-api/__generated__/server-only-router-operation-metadata.ts
+++ b/packages/protocol/src/builder-api/__generated__/server-only-router-operation-metadata.ts
@@ -188,6 +188,57 @@ export const serverOnlyRouterOperationMetadata = {
minLength: 1,
maxLength: 100,
},
+ bundleVersion: {
+ type: "string",
+ minLength: 1,
+ maxLength: 100,
+ },
+ recentFailure: {
+ type: "object",
+ properties: {
+ tool: {
+ type: "string",
+ minLength: 1,
+ maxLength: 160,
+ },
+ code: {
+ type: "string",
+ minLength: 1,
+ maxLength: 160,
+ },
+ issues: {
+ maxItems: 30,
+ type: "array",
+ items: {
+ type: "object",
+ properties: {
+ path: {
+ maxItems: 30,
+ type: "array",
+ items: {
+ type: "string",
+ maxLength: 200,
+ },
+ },
+ code: {
+ type: "string",
+ minLength: 1,
+ maxLength: 100,
+ },
+ constraint: {
+ type: "string",
+ minLength: 1,
+ maxLength: 500,
+ },
+ },
+ required: ["path", "code", "constraint"],
+ additionalProperties: false,
+ },
+ },
+ },
+ required: ["tool", "code"],
+ additionalProperties: false,
+ },
},
required: [
"cliVersion",
diff --git a/packages/protocol/src/issue-report.test.ts b/packages/protocol/src/issue-report.test.ts
index 669b3bc724..a23021193f 100644
--- a/packages/protocol/src/issue-report.test.ts
+++ b/packages/protocol/src/issue-report.test.ts
@@ -20,6 +20,18 @@ const report = {
architecture: "arm64",
executionMode: "mcp",
apiContractVersion: "public-api:client",
+ bundleVersion: "bundle:client",
+ recentFailure: {
+ tool: "preview.start",
+ code: "PROJECT_BUNDLE_INVALID",
+ issues: [
+ {
+ path: ["assets", "0", "type"],
+ code: "invalid_value",
+ constraint: 'one of "font"|"image"|"video"|"file"',
+ },
+ ],
+ },
},
report: {
userStory:
diff --git a/packages/protocol/src/issue-report.ts b/packages/protocol/src/issue-report.ts
index de724a001e..305e0c5a60 100644
--- a/packages/protocol/src/issue-report.ts
+++ b/packages/protocol/src/issue-report.ts
@@ -38,6 +38,22 @@ const issueReportAgent = z
})
.strict();
+const issueReportFailureIssue = z
+ .object({
+ path: z.array(z.string().max(200)).max(30),
+ code: z.string().trim().min(1).max(100),
+ constraint: z.string().trim().min(1).max(500),
+ })
+ .strict();
+
+const issueReportRecentFailure = z
+ .object({
+ tool: z.string().trim().min(1).max(160),
+ code: z.string().trim().min(1).max(160),
+ issues: z.array(issueReportFailureIssue).max(30).optional(),
+ })
+ .strict();
+
const issueReportRuntime = z
.object({
cliVersion: z.string().trim().min(1).max(100),
@@ -47,6 +63,8 @@ const issueReportRuntime = z
architecture: z.string().trim().min(1).max(100),
executionMode: z.enum(["mcp"]),
apiContractVersion: z.string().trim().min(1).max(100),
+ bundleVersion: z.string().trim().min(1).max(100).optional(),
+ recentFailure: issueReportRecentFailure.optional(),
})
.strict()
.describe(
@@ -101,3 +119,4 @@ export const issueReportResult = z
export type IssueReportInput = z.infer<typeof issueReportInput>;
export type IssueReportResult = z.infer<typeof issueReportResult>;
export type IssueReportRuntime = z.infer<typeof issueReportRuntime>;
+export type IssueReportRecentFailure = z.infer<typeof issueReportRecentFailure>;