feat: Add CDP headers support for authenticated connections #858
+64
−2
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
@microsoft-github-policy-service agree |
README.md
Outdated
| @@ -231,6 +233,20 @@ state [here](https://playwright.dev/docs/auth). | |||
| } | |||
| ``` | |||
|
|
|||
| #### CDP Headers | |||
There was a problem hiding this comment.
Let's remove this from the readme, it is very niche and is already mentioned above.
src/program.ts
Outdated
| @@ -67,6 +68,18 @@ program | |||
| console.error('The --vision option is deprecated, use --caps=vision instead'); | |||
| options.caps = 'vision'; | |||
| } | |||
|
|
|||
There was a problem hiding this comment.
You have two different parse methods, do it like commaSeparatedList instead.
|
@pavelfeldman
|
|
Sorry it seems like this requires a rebase now. |
- Add cdpHeaders option to browser configuration - Support --cdp-headers CLI option for JSON header specification - Add PLAYWRIGHT_MCP_CDP_HEADERS environment variable support - Update CdpContextFactory to pass headers to connectOverCDP - Add JSON parsing with error handling for CLI headers - Add tests for headers functionality and invalid JSON handling - Update documentation with usage examples This enables connecting to CDP endpoints that require authentication, such as AWS Bedrock AgentCore Browser instances. Unify CDP headers parsing and improve error messages - Remove duplicate CDP headers documentation from README - Replace manual JSON parsing with parseJsonObject function - Use InvalidArgumentError for user-friendly error messages - Maintain consistency with other option parsers like commaSeparatedList Addresses review feedback on standardizing parse methods. fix: resolve ESLint violations
moritalous
force-pushed
the
feature/cdp-headers-support
branch
from
e88876a to
ea8b6da
Compare
|
@pavelfeldman |
src/browserContextFactory.ts
Outdated
| @@ -128,7 +128,11 @@ class CdpContextFactory extends BaseContextFactory { | |||
| } | |||
|
|
|||
| protected override async _doObtainBrowser(): Promise<playwright.Browser> { | |||
| return playwright.chromium.connectOverCDP(this.config.browser.cdpEndpoint!); | |||
| const options: any = {}; | |||
There was a problem hiding this comment.
Please make sure types are in order here.
src/config.ts
Outdated
| export function parseJsonObject(value: string | undefined): Record<string, string> | undefined { | ||
| if (!value) | ||
| return undefined; | ||
| try { |
There was a problem hiding this comment.
I think this code could be simplified a lot, did you mean to parse JSON first and then assert the type of the parsed value?
|
@pavelfeldman |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
Adds support for passing authentication headers when connecting to CDP endpoints, enabling connections to authenticated browser instances like AWS Bedrock AgentCore Browser.
Background
Modern AI agent platforms like AWS Bedrock AgentCore provide managed browser instances that require authenticated CDP connections. Currently, playwright-mcp cannot pass authentication headers when connecting to CDP endpoints, preventing integration with these enterprise-grade services.
Amazon Bedrock AgentCore Browser service provides managed, secure, cloud-based browser instances that enable AI agents to interact with websites at scale for tasks like form completion and web navigation. These browser instances require authenticated CDP connections with proper headers for security and access control.
Changes
cdpHeadersoption to browser configuration type definitions--cdp-headersoption with JSON parsing and validationPLAYWRIGHT_MCP_CDP_HEADERSfor configurationCdpContextFactoryto pass headers to Playwright'sconnectOverCDPUsage Examples
CLI Usage
bash
Environment Variable
bash
Configuration File
json
{ "browser": { "cdpEndpoint": "ws://localhost:9222", "cdpHeaders": { "Authorization": "Bearer token", "X-Custom-Header": "value" } } }Compatibility
Use Cases
This feature enables integration with:
References