Playwright is a framework for Web Testing and Automation. It allows testing Chromium, Firefox and WebKit with a single API.
TypeScript automationchromechromiume2e-testingelectronend-to-end-testingfirefoxjavascriptplaywrighttesttest-automationtestingtesting-toolswebwebkit
feat(mcp): add snapshot.boxes config to include bounding boxes in snapshots (#42102)
Pavel Feldmanf8b14a311edb
diff --git a/packages/playwright-core/src/tools/backend/context.ts b/packages/playwright-core/src/tools/backend/context.tsindex 71598b3c1d..aa8545962e 100644--- a/packages/playwright-core/src/tools/backend/context.ts+++ b/packages/playwright-core/src/tools/backend/context.ts@@ -50,6 +50,7 @@ export type ContextConfig = {secrets?: Record<string, string>;snapshot?: {mode?: 'full' | 'none';+ boxes?: boolean;};testIdAttribute?: string;timeouts?: {diff --git a/packages/playwright-core/src/tools/backend/response.ts b/packages/playwright-core/src/tools/backend/response.tsindex 725edcdaaf..c29732af5b 100644--- a/packages/playwright-core/src/tools/backend/response.ts+++ b/packages/playwright-core/src/tools/backend/response.ts@@ -145,13 +145,14 @@ export class Response {setIncludeSnapshot() {this._includeSnapshot = this._context.config.snapshot?.mode ?? 'full';+ this._includeSnapshotBoxes = this._context.config.snapshot?.boxes;}setIncludeFullSnapshot(includeSnapshotFileName?: string, root?: playwright.Locator, depth?: number, boxes?: boolean) {this._includeSnapshot = 'explicit';this._includeSnapshotFileName = includeSnapshotFileName;this._includeSnapshotDepth = depth;- this._includeSnapshotBoxes = boxes;+ this._includeSnapshotBoxes = boxes ?? this._context.config.snapshot?.boxes;this._includeSnapshotRoot = root;}diff --git a/packages/playwright-core/src/tools/mcp/config.d.ts b/packages/playwright-core/src/tools/mcp/config.d.tsindex 487f7fac05..9dbda16a1f 100644--- a/packages/playwright-core/src/tools/mcp/config.d.ts+++ b/packages/playwright-core/src/tools/mcp/config.d.ts@@ -227,6 +227,12 @@ export type Config = {* When taking snapshots for responses, specifies the mode to use.*/mode?: 'full' | 'none';++ /**+ * Whether to include each element's bounding box as [box=x,y,width,height] in snapshots.+ * Coordinates are viewport-relative, in CSS pixels (Element.getBoundingClientRect).+ */+ boxes?: boolean;};/**diff --git a/packages/playwright-core/src/tools/mcp/config.ts b/packages/playwright-core/src/tools/mcp/config.tsindex fd858938cb..85f634a850 100644--- a/packages/playwright-core/src/tools/mcp/config.ts+++ b/packages/playwright-core/src/tools/mcp/config.ts@@ -69,6 +69,7 @@ export type CLIOptions = {saveSession?: boolean;secrets?: Record<string, string>;sharedBrowserContext?: boolean;+ snapshotBoxes?: boolean;snapshotMode?: 'full' | 'none';storageState?: string;testIdAttribute?: string;@@ -372,7 +373,7 @@ function configFromCLIOptions(cliOptions: CLIOptions): Config & { configFile?: ssaveSession: cliOptions.saveSession,secrets: cliOptions.secrets,sharedBrowserContext: cliOptions.sharedBrowserContext,- snapshot: cliOptions.snapshotMode ? { mode: cliOptions.snapshotMode } : undefined,+ snapshot: cliOptions.snapshotMode || cliOptions.snapshotBoxes !== undefined ? { mode: cliOptions.snapshotMode, boxes: cliOptions.snapshotBoxes } : undefined,outputDir: cliOptions.outputDir,outputMaxSize: cliOptions.outputMaxSize,imageResponses: cliOptions.imageResponses,diff --git a/packages/playwright-core/src/tools/mcp/configIni.ts b/packages/playwright-core/src/tools/mcp/configIni.tsindex c8dc90ed58..7d71b7d8f2 100644--- a/packages/playwright-core/src/tools/mcp/configIni.ts+++ b/packages/playwright-core/src/tools/mcp/configIni.ts@@ -185,4 +185,5 @@ const longhandTypes: Record<string, LonghandType> = {// snapshot'snapshot.mode': 'string',+ 'snapshot.boxes': 'boolean',};diff --git a/packages/playwright-core/src/tools/mcp/program.ts b/packages/playwright-core/src/tools/mcp/program.tsindex 9db1980820..29b2e6ba33 100644--- a/packages/playwright-core/src/tools/mcp/program.ts+++ b/packages/playwright-core/src/tools/mcp/program.ts@@ -69,6 +69,7 @@ export function decorateMCPCommand(command: Command) {.option('--save-session', 'Whether to save the Playwright MCP session into the output directory.').option('--secrets <path>', 'path to a file containing secrets in the dotenv format', dotenvFileLoader).option('--shared-browser-context', 'reuse the same browser context between all connected HTTP clients.')+ .option('--snapshot-boxes', 'include each element\'s bounding box as [box=x,y,width,height] in snapshots. Coordinates are viewport-relative, in CSS pixels.').option('--snapshot-mode <mode>', 'when taking snapshots for responses, specifies the mode to use. Can be "full" or "none". Default is "full".').option('--storage-state <path>', 'path to the storage state file for isolated sessions.').option('--test-id-attribute <attribute>', 'specify the attribute to use for test ids, defaults to "data-testid"')diff --git a/tests/mcp/snapshot-mode.spec.ts b/tests/mcp/snapshot-mode.spec.tsindex e96689ddc5..2b6bafa1e5 100644--- a/tests/mcp/snapshot-mode.spec.ts+++ b/tests/mcp/snapshot-mode.spec.ts@@ -96,6 +96,32 @@ test('should not inline console messages with --snapshot-mode=none', async ({ st});});+test('should respect --snapshot-boxes', async ({ startClient, server }) => {+ server.setContent('/', `+ <style>body { margin: 0; }</style>+ <button style="position:absolute;left:100px;top:50px;width:80px;height:40px;margin:0;padding:0;border:0;">click</button>+ `, 'text/html');++ const { client } = await startClient({+ args: ['--snapshot-boxes'],+ });++ expect(await client.callTool({+ name: 'browser_navigate',+ arguments: {+ url: server.PREFIX,+ },+ })).toHaveResponse({+ snapshot: expect.stringContaining(`- button "click" [ref=e1] [box=100,50,80,40]`),+ });++ expect(await client.callTool({+ name: 'browser_snapshot',+ })).toHaveResponse({+ inlineSnapshot: expect.stringContaining(`- button "click" [ref=e1] [box=100,50,80,40]`),+ });+});+test('should respect snapshot[filename]', async ({ client, server }, testInfo) => {server.setContent('/', `<button>Button 1</button>`, 'text/html');