feat: add set_extra_http_headers tool for Network.setExtraHTTPHeaders#1176
feat: add set_extra_http_headers tool for Network.setExtraHTTPHeaders#1176pedrodurek wants to merge 5 commits into
Conversation
|
Thanks for your pull request! It looks like this may be your first contribution to a Google open source project. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA). View this failed invocation of the CLA check for more information. For the most up to date status, view the checks section at the bottom of the pull request. |
There was a problem hiding this comment.
Thanks for the PR! I think we should align with the suggestion in this comment #1175 (comment) and add this to the emulation tool.
Address review feedback to extend the existing emulate tool instead of adding a standalone set_extra_http_headers tool. - Add extraHTTPHeaders param to emulate tool schema - Add handler logic in McpContext.emulate() - Preserve existing headers when param is omitted - Move tests from network.test.ts to emulation.test.ts - Revert network.ts and network.test.ts to main
|
@OrKoN I moved the functionality to the emulation tool. Let me know if further adjustments are needed. |
OrKoN
left a comment
There was a problem hiding this comment.
Thanks! mostly looks good, one remaining comment about the format of the field.
Changes per reviewer feedback for CLI compatibility:
- Change extraHTTPHeaders from Record<string, string> to string parameter
- String should contain serialized JSON object (e.g. {"X-Custom": "value"})
- Empty string clears all headers
- Add headerStringTransform() to parse JSON and validate
- Update McpContext.ts to handle parsed headers (null for empty/clear)
- Store headers in emulationSettings as JSON string
- Update all tests to use JSON string format
- Remove pnpm-lock.yaml
- Update headerStringTransform to handle undefined (not provided) separately - Return undefined when field not provided (don't overwrite existing settings) - Return null when empty string provided (clear headers) - Update McpContext.emulate() function signature to accept Record<string, string> | null | undefined - Add explicit check for null vs undefined to properly handle both cases
OrKoN
left a comment
There was a problem hiding this comment.
Thanks it looks good, but it appears some compilation and test issues have to be addressed.
- Make headerStringTransform private (was breaking Object.values(emulationTools)) - Store extraHTTPHeaders in EmulationSettings as Record<string, string> (parsed object) so restoreEmulation() type-checks against emulate() - McpContext.emulate() now stores parsed object directly instead of re-stringifying (cleaner round-trip with restoreEmulation) - Update tests to pass plain objects (tests bypass Zod transform) - Reject JSON arrays explicitly in headerStringTransform
Summary
Extend the existing
emulatetool with anextraHTTPHeadersparameter that calls Puppeteer'spage.setExtraHTTPHeaders()(which uses CDPNetwork.setExtraHTTPHeadersunder the hood).Closes #1175
Approach
Per feedback from @natorion, this integrates into the existing
emulatetool rather than adding a standalone tool. Theemulatetool is already the central hub for page-level state modifications (userAgent, viewport, networkConditions, geolocation, colorScheme), and custom HTTP headers fit naturally alongside them. This also avoids increasing the MCP tool count and LLM token overhead.Changes
src/types.ts— AddedextraHTTPHeaders?: Record<string, string>toEmulationSettingssrc/tools/emulation.ts— AddedextraHTTPHeadersas an optional zod parameter on theemulatetoolsrc/McpContext.ts— Added handler logic in theemulate()method:page.setExtraHTTPHeaders()whenextraHTTPHeadersis provided{}is passedemulate({colorScheme: "dark"})from accidentally clearing previously-set headerstests/tools/emulation.test.ts— Added 5 test cases:{}Use Case
This enables setting custom HTTP headers on all requests — including the initial document navigation and
<script>tag loads — whichinitScriptcannot do since it runs after the document is already fetched.Usage