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 browser_show_tracing tool to open trace viewer (#39415)
Yury Semikhatsky8d4588c85ce3
diff --git a/packages/playwright-core/src/cli/program.ts b/packages/playwright-core/src/cli/program.tsindex d5db7531b0..25e56ca446 100644--- a/packages/playwright-core/src/cli/program.ts+++ b/packages/playwright-core/src/cli/program.ts@@ -344,7 +344,7 @@ programif (options.port !== undefined || options.host !== undefined)runTraceInBrowser(trace, openOptions).catch(logErrorAndExit);else- runTraceViewerApp(trace, options.browser, openOptions, true).catch(logErrorAndExit);+ runTraceViewerApp(trace, options.browser, openOptions).catch(logErrorAndExit);}).addHelpText('afterAll', `Examples:diff --git a/packages/playwright-core/src/server/index.ts b/packages/playwright-core/src/server/index.tsindex 3f127cb915..8232c8c0ea 100644--- a/packages/playwright-core/src/server/index.ts+++ b/packages/playwright-core/src/server/index.ts@@ -28,4 +28,4 @@ export { createPlaywright } from './playwright';export type { DispatcherScope } from './dispatchers/dispatcher';export type { Playwright } from './playwright';-export { installRootRedirect, openTraceInBrowser, openTraceViewerApp, startTraceViewerServer } from './trace/viewer/traceViewer';+export { installRootRedirect, openTraceInBrowser, openTraceViewerApp, startTraceViewerServer, runTraceViewerApp } from './trace/viewer/traceViewer';diff --git a/packages/playwright-core/src/server/trace/viewer/traceViewer.ts b/packages/playwright-core/src/server/trace/viewer/traceViewer.tsindex 392fe08eeb..f158aec5f2 100644--- a/packages/playwright-core/src/server/trace/viewer/traceViewer.ts+++ b/packages/playwright-core/src/server/trace/viewer/traceViewer.ts@@ -151,13 +151,12 @@ export async function installRootRedirect(server: HttpServer, traceUrl: string |});}-export async function runTraceViewerApp(traceUrl: string | undefined, browserName: string, options: TraceViewerServerOptions & { headless?: boolean }, exitOnClose?: boolean) {+export async function runTraceViewerApp(traceUrl: string | undefined, browserName: string, options: TraceViewerServerOptions & { headless?: boolean }) {traceUrl = validateTraceUrlOrPath(traceUrl);const server = await startTraceViewerServer(options);await installRootRedirect(server, traceUrl, options);const page = await openTraceViewerApp(server.urlPrefix('precise'), browserName, options);- if (exitOnClose)- page.on('close', () => gracefullyProcessExitDoNotHang(0));+ page.on('close', () => gracefullyProcessExitDoNotHang(0));return page;}diff --git a/packages/playwright/src/cli/daemon/commands.ts b/packages/playwright/src/cli/daemon/commands.tsindex 6fc435c7b1..ca55f44b8b 100644--- a/packages/playwright/src/cli/daemon/commands.ts+++ b/packages/playwright/src/cli/daemon/commands.ts@@ -743,6 +743,15 @@ const tracingStop = declareCommand({toolParams: () => ({}),});+const tracingShow = declareCommand({+ name: 'tracing-show',+ description: 'Open trace viewer for the recorded trace',+ category: 'devtools',+ args: z.object({}),+ toolName: 'browser_show_tracing',+ toolParams: () => ({}),+});+const videoStart = declareCommand({name: 'video-start',description: 'Start video recording',@@ -953,6 +962,7 @@ const commandsArray: AnyCommandSchema[] = [networkRequests,tracingStart,tracingStop,+ tracingShow,videoStart,videoStop,devtoolsShow,diff --git a/packages/playwright/src/mcp/browser/tools/tracing.ts b/packages/playwright/src/mcp/browser/tools/tracing.tsindex 6a164ab330..02f9f56419 100644--- a/packages/playwright/src/mcp/browser/tools/tracing.ts+++ b/packages/playwright/src/mcp/browser/tools/tracing.ts@@ -15,6 +15,8 @@*/import { z } from 'playwright-core/lib/mcpBundle';+import { runTraceViewerApp } from 'playwright-core/lib/server';+import { isUnderTest } from 'playwright-core/lib/utils';import { defineTool } from './tool';import type { Tracing } from '../../../../../playwright-core/src/client/tracing';@@ -70,9 +72,33 @@ const tracingStop = defineTool({},});+const tracingShow = defineTool({+ capability: 'devtools',++ schema: {+ name: 'browser_show_tracing',+ title: 'Show tracing',+ description: 'Open trace viewer for the recorded trace',+ inputSchema: z.object({}),+ type: 'readOnly',+ },++ handle: async (context, params, response) => {+ const browserContext = await context.ensureBrowserContext();+ const traceLegend = (browserContext.tracing as any)[traceLegendSymbol];+ if (!traceLegend) {+ response.addError('No trace recording found. Start tracing first with browser_start_tracing.');+ return;+ }+ await runTraceViewerApp(`${traceLegend.tracesDir}/${traceLegend.name}.json`, 'chromium', { headless: isUnderTest() ? true : undefined });+ response.addTextResult('Trace viewer opened.');+ },+});+export default [tracingStart,tracingStop,+ tracingShow,];const traceLegendSymbol = Symbol('tracesDir');diff --git a/tests/mcp/cli-devtools.spec.ts b/tests/mcp/cli-devtools.spec.tsindex 8bdd8e3397..dd546c378d 100644--- a/tests/mcp/cli-devtools.spec.ts+++ b/tests/mcp/cli-devtools.spec.ts@@ -91,6 +91,16 @@ test('tracing-start-stop', async ({ cli, server }, testInfo) => {expect(fs.existsSync(testInfo.outputPath('.playwright-cli', 'traces', `trace-${timestamp}.network`))).toBeTruthy();});+test('tracing-show', async ({ cli, server }) => {+ await cli('open', server.HELLO_WORLD, { env: { PWTEST_UNDER_TEST: '1' } });+ const { output } = await cli('tracing-start');+ expect(output).toContain('Trace recording started');+ await cli('eval', '() => fetch("/hello-world")');++ const { output: tracingShowOutput } = await cli('tracing-show');+ expect(tracingShowOutput).toContain('Trace viewer opened.');+});+test('video-start-stop', async ({ cli, server }) => {await cli('open', server.HELLO_WORLD);const { output: videoStartOutput } = await cli('video-start');diff --git a/tests/mcp/tracing.spec.ts b/tests/mcp/tracing.spec.tsindex 0d1862d0be..20e7e5e03e 100644--- a/tests/mcp/tracing.spec.ts+++ b/tests/mcp/tracing.spec.ts@@ -69,6 +69,40 @@ test('check that trace is saved with browser_start_tracing', async ({ startClien]);});+test('check that browser_show_tracing returns error without tracing', async ({ startClient }) => {+ const { client } = await startClient({ args: ['--caps=tracing'] });++ expect(await client.callTool({+ name: 'browser_show_tracing',+ })).toHaveResponse({+ error: expect.stringContaining('No trace recording found'),+ isError: true,+ });+});++test('check that browser_show_tracing opens trace viewer', async ({ startClient, server }) => {+ const { client } = await startClient({ args: ['--caps=tracing'], env: { PWTEST_UNDER_TEST: '1' } });++ expect(await client.callTool({+ name: 'browser_start_tracing',+ })).toHaveResponse({+ result: expect.stringContaining('Trace recording started'),+ });++ expect(await client.callTool({+ name: 'browser_navigate',+ arguments: { url: server.HELLO_WORLD },+ })).toHaveResponse({+ code: expect.stringContaining(`page.goto('http://localhost`),+ });++ expect(await client.callTool({+ name: 'browser_show_tracing',+ })).toHaveResponse({+ result: 'Trace viewer opened.',+ });+});+test('check that trace is saved with browser_start_tracing (no output dir)', async ({ startClient, server }, testInfo) => {const { client } = await startClient({args: ['--caps=tracing'],