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
fix(mcp): keep remoteHeaders working for remote browser endpoint (#41156)
Simon Knottc8fc23bb1254
diff --git a/packages/playwright-core/src/tools/mcp/browserFactory.ts b/packages/playwright-core/src/tools/mcp/browserFactory.tsindex 4ea7e58372..e6b808459c 100644--- a/packages/playwright-core/src/tools/mcp/browserFactory.ts+++ b/packages/playwright-core/src/tools/mcp/browserFactory.ts@@ -120,9 +120,12 @@ async function createRemoteBrowser(config: FullConfig): Promise<BrowserWithInfo>// `timeout`. Normalize once so the rest of the function deals with a single// shape.const remote = config.browser.remoteEndpoint!;+ // `remoteHeaders` is for back-compat, `remoteEndpoint.headers` takes precedence.+ // eslint-disable-next-line no-restricted-syntax+ const remoteHeaders = (config.browser as any).remoteHeaders as Record<string, string> | undefined;const remoteOptions = typeof remote === 'string'- ? { endpoint: remote }- : remote;+ ? { endpoint: remote, headers: remoteHeaders }+ : { ...remote, headers: { ...remoteHeaders, ...remote.headers } };const descriptor = await serverRegistry.find(remoteOptions.endpoint);if (descriptor) {diff --git a/packages/playwright-core/src/tools/mcp/config.ts b/packages/playwright-core/src/tools/mcp/config.tsindex 2583e2684d..c90c1cf36c 100644--- a/packages/playwright-core/src/tools/mcp/config.ts+++ b/packages/playwright-core/src/tools/mcp/config.ts@@ -64,6 +64,7 @@ export type CLIOptions = {port?: number;proxyBypass?: string;proxyServer?: string;+ remoteHeader?: Record<string, string>;saveSession?: boolean;secrets?: Record<string, string>;sharedBrowserContext?: boolean;@@ -364,6 +365,11 @@ function configFromCLIOptions(cliOptions: CLIOptions): Config & { configFile?: s},};+ // `remoteHeaders` is for back-compat, assign it here so it survives config merging.+ if (cliOptions.remoteHeader)+ // eslint-disable-next-line no-restricted-syntax+ (config.browser as any).remoteHeaders = cliOptions.remoteHeader;+return { ...config, configFile: cliOptions.config };}@@ -405,6 +411,7 @@ export function configFromEnv(env?: NodeJS.ProcessEnv): Config & { configFile?:options.port = numberParser(e.PLAYWRIGHT_MCP_PORT);options.proxyBypass = envToString(e.PLAYWRIGHT_MCP_PROXY_BYPASS);options.proxyServer = envToString(e.PLAYWRIGHT_MCP_PROXY_SERVER);+ options.remoteHeader = headerParser(envToString(e.PLAYWRIGHT_MCP_REMOTE_HEADERS));options.secrets = dotenvFileLoader(e.PLAYWRIGHT_MCP_SECRETS_FILE);options.storageState = envToString(e.PLAYWRIGHT_MCP_STORAGE_STATE);options.testIdAttribute = envToString(e.PLAYWRIGHT_MCP_TEST_ID_ATTRIBUTE);diff --git a/packages/playwright-core/src/tools/mcp/program.ts b/packages/playwright-core/src/tools/mcp/program.tsindex f42c1b0dcc..06de1755de 100644--- a/packages/playwright-core/src/tools/mcp/program.ts+++ b/packages/playwright-core/src/tools/mcp/program.ts@@ -64,6 +64,7 @@ export function decorateMCPCommand(command: Command) {.option('--port <port>', 'port to listen on for SSE transport.').option('--proxy-bypass <bypass>', 'comma-separated domains to bypass proxy, for example ".com,chromium.org,.domain.com"').option('--proxy-server <proxy>', 'specify proxy server, for example "http://myproxy:3128" or "socks5://myproxy:8080"')+ .addOption(new ProgramOption('--remote-header <headers...>', 'headers to send with the remote endpoint connect request, multiple can be specified.').argParser(headerParser).hideHelp()).option('--sandbox', 'enable the sandbox for all process types that are normally not sandboxed.').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)diff --git a/tests/mcp/remote-endpoint.spec.ts b/tests/mcp/remote-endpoint.spec.tsindex 2a19e73754..42521074bb 100644--- a/tests/mcp/remote-endpoint.spec.ts+++ b/tests/mcp/remote-endpoint.spec.ts@@ -59,3 +59,23 @@ test('remoteEndpoint accepts ConnectOptions object with headers', async ({ startpage: expect.stringContaining('Page Title: Title'),});});++test('back-compat: remoteHeaders config still selects the browser on run-server endpoint', async ({ startClient, server, runServerEndpoint }) => {+ const { client } = await startClient({+ config: {+ browser: {+ remoteEndpoint: runServerEndpoint,+ remoteHeaders: { 'x-playwright-browser': 'chromium' },+ isolated: true,+ },+ } as any,+ });++ const response = await client.callTool({+ name: 'browser_navigate',+ arguments: { url: server.HELLO_WORLD },+ });+ expect(response).toHaveResponse({+ page: expect.stringContaining('Page Title: Title'),+ });+});