Skip to content

Playwright is a framework for Web Testing and Automation. It allows testing Chromium, Firefox and WebKit with a single API.

feat(mcp): allow passing cdp headers (#37309)

Pavel Feldman3e4efe9d7a30
diff --git a/packages/playwright/src/mcp/browser/browserContextFactory.ts b/packages/playwright/src/mcp/browser/browserContextFactory.ts
index 6021896cbb..e4320b3a1a 100644
--- a/packages/playwright/src/mcp/browser/browserContextFactory.ts
+++ b/packages/playwright/src/mcp/browser/browserContextFactory.ts
@@ -126,7 +126,7 @@ class CdpContextFactory extends BaseContextFactory {
}
protected override async _doObtainBrowser(): Promise<playwright.Browser> {
- return playwright.chromium.connectOverCDP(this.config.browser.cdpEndpoint!);
+ return playwright.chromium.connectOverCDP(this.config.browser.cdpEndpoint!, { headers: this.config.browser.cdpHeaders });
}
protected override async _doCreateContext(browser: playwright.Browser): Promise<playwright.BrowserContext> {
diff --git a/packages/playwright/src/mcp/browser/config.ts b/packages/playwright/src/mcp/browser/config.ts
index e931fef11a..e06543f5ff 100644
--- a/packages/playwright/src/mcp/browser/config.ts
+++ b/packages/playwright/src/mcp/browser/config.ts
@@ -30,6 +30,7 @@ export type CLIOptions = {
browser?: string;
caps?: string[];
cdpEndpoint?: string;
+ cdpHeader?: Record<string, string>;
config?: string;
device?: string;
executablePath?: string;
@@ -179,6 +180,7 @@ export function configFromCLIOptions(cliOptions: CLIOptions): Config {
launchOptions,
contextOptions,
cdpEndpoint: cliOptions.cdpEndpoint,
+ cdpHeaders: cliOptions.cdpHeader,
},
server: {
port: cliOptions.port,
@@ -207,6 +209,7 @@ function configFromEnv(): Config {
options.browser = envToString(process.env.PLAYWRIGHT_MCP_BROWSER);
options.caps = commaSeparatedList(process.env.PLAYWRIGHT_MCP_CAPS);
options.cdpEndpoint = envToString(process.env.PLAYWRIGHT_MCP_CDP_ENDPOINT);
+ options.cdpHeader = headerParser(process.env.PLAYWRIGHT_MCP_CDP_HEADERS, {});
options.config = envToString(process.env.PLAYWRIGHT_MCP_CONFIG);
options.device = envToString(process.env.PLAYWRIGHT_MCP_DEVICE);
options.executablePath = envToString(process.env.PLAYWRIGHT_MCP_EXECUTABLE_PATH);
@@ -310,6 +313,15 @@ export function dotenvFileLoader(value: string | undefined): Record<string, stri
return dotenv.parse(fs.readFileSync(value, 'utf8'));
}
+export function headerParser(arg: string | undefined, previous?: Record<string, string>): Record<string, string> {
+ if (!arg)
+ return previous || {};
+ const result: Record<string, string> = previous || {};
+ const [name, value] = arg.split(':').map(v => v.trim());
+ result[name] = value;
+ return result;
+}
+
function envToNumber(value: string | undefined): number | undefined {
if (!value)
return undefined;
diff --git a/packages/playwright/src/mcp/config.d.ts b/packages/playwright/src/mcp/config.d.ts
index 815329f0ab..49fe40226e 100644
--- a/packages/playwright/src/mcp/config.d.ts
+++ b/packages/playwright/src/mcp/config.d.ts
@@ -59,6 +59,11 @@ export type Config = {
*/
cdpEndpoint?: string;
+ /**
+ * CDP headers to send with the connect request.
+ */
+ cdpHeaders?: Record<string, string>;
+
/**
* Remote endpoint to connect to an existing Playwright server.
*/
diff --git a/packages/playwright/src/mcp/program.ts b/packages/playwright/src/mcp/program.ts
index 6e046453a9..bc01c31806 100644
--- a/packages/playwright/src/mcp/program.ts
+++ b/packages/playwright/src/mcp/program.ts
@@ -16,7 +16,7 @@
import { program, ProgramOption } from 'playwright-core/lib/utilsBundle';
import * as mcpServer from './sdk/server';
-import { commaSeparatedList, dotenvFileLoader, resolveCLIConfig, semicolonSeparatedList } from './browser/config';
+import { commaSeparatedList, dotenvFileLoader, headerParser, resolveCLIConfig, semicolonSeparatedList } from './browser/config';
import { Context } from './browser/context';
import { contextFactory } from './browser/browserContextFactory';
import { ProxyBackend } from './sdk/proxyBackend';
@@ -36,6 +36,7 @@ program
.option('--browser <browser>', 'browser or chrome channel to use, possible values: chrome, firefox, webkit, msedge.')
.option('--caps <caps>', 'comma-separated list of additional capabilities to enable, possible values: vision, pdf.', commaSeparatedList)
.option('--cdp-endpoint <endpoint>', 'CDP endpoint to connect to.')
+ .option('--cdp-header <headers...>', 'CDP headers to send with the connect request, multiple can be specified.', headerParser)
.option('--config <path>', 'path to the configuration file.')
.option('--device <device>', 'device to emulate, for example: "iPhone 15"')
.option('--executable-path <path>', 'path to the browser executable.')
diff --git a/tests/mcp/cdp.spec.ts b/tests/mcp/cdp.spec.ts
index 90ae1620bd..5ff0930bba 100644
--- a/tests/mcp/cdp.spec.ts
+++ b/tests/mcp/cdp.spec.ts
@@ -90,3 +90,20 @@ test('does not support --device', async () => {
expect(result.status).toBe(1);
expect(result.stderr.toString()).toContain('Device emulation is not supported with cdpEndpoint.');
});
+
+test('cdp server with headers', async ({ startClient, server }) => {
+ let authHeader = '';
+ server.setRoute('/json/version/', (req, res) => {
+ authHeader = req.headers['authorization'];
+ res.end();
+ });
+
+ const { client } = await startClient({ args: [`--cdp-endpoint=${server.PREFIX}`, '--cdp-header', 'Authorization: Bearer 1234567890'] });
+ expect(await client.callTool({
+ name: 'browser_navigate',
+ arguments: { url: server.HELLO_WORLD },
+ })).toHaveResponse({
+ isError: true,
+ });
+ expect(authHeader).toBe('Bearer 1234567890');
+});