BrowserSkill/crates/bsk-protocol/schema/tool_emulate_params.json

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "EmulateParams",
  "type": "object",
  "required": [
    "session_id"
  ],
  "properties": {
    "off": {
      "description": "Clear every emulation override on the tab and restore its real environment. Mutually exclusive with `overrides`.",
      "type": [
        "boolean",
        "null"
      ]
    },
    "overrides": {
      "description": "Overrides to apply. Required unless `off` is set.",
      "anyOf": [
        {
          "$ref": "#/definitions/EmulateOverrides"
        },
        {
          "type": "null"
        }
      ]
    },
    "session_id": {
      "type": "string"
    },
    "tab_id": {
      "description": "Target tab. Defaults to the Agent Window's active tab.",
      "type": [
        "integer",
        "null"
      ],
      "format": "int64"
    }
  },
  "definitions": {
    "EmulateOverrides": {
      "description": "Concrete emulation overrides for one tab. Field presence drives the extension: only the overrides whose fields are set are touched, so a call may change just the UA, just the viewport, or any combination.",
      "type": "object",
      "properties": {
        "accept_language": {
          "description": "`Accept-Language` header override. Requires `user_agent`.",
          "type": [
            "string",
            "null"
          ]
        },
        "device_scale_factor": {
          "description": "Device scale factor (device pixel ratio). Only meaningful with `width`/`height`; the extension maps `None` to CDP's `0` (\"use the display's native factor\").",
          "type": [
            "number",
            "null"
          ],
          "format": "double"
        },
        "height": {
          "description": "Viewport height in CSS pixels. Requires `width`.",
          "type": [
            "integer",
            "null"
          ],
          "format": "uint32",
          "minimum": 0.0
        },
        "max_touch_points": {
          "description": "Touch points reported while touch emulation is on (CDP defaults to 1 when omitted).",
          "type": [
            "integer",
            "null"
          ],
          "format": "uint32",
          "minimum": 0.0
        },
        "mobile": {
          "description": "Emulate a mobile viewport (meta-viewport handling, overlay scrollbars). Only meaningful with `width`/`height`.",
          "type": [
            "boolean",
            "null"
          ]
        },
        "touch": {
          "description": "Enable/disable touch emulation (`Emulation.setTouchEmulationEnabled`). When omitted while `max_touch_points` is set, touch is enabled.",
          "type": [
            "boolean",
            "null"
          ]
        },
        "user_agent": {
          "description": "UA string for `Emulation.setUserAgentOverride`.",
          "type": [
            "string",
            "null"
          ]
        },
        "user_agent_metadata": {
          "description": "UA client-hints metadata. Requires `user_agent`.",
          "anyOf": [
            {
              "$ref": "#/definitions/UserAgentMetadata"
            },
            {
              "type": "null"
            }
          ]
        },
        "width": {
          "description": "Viewport width in CSS pixels. Requires `height`.",
          "type": [
            "integer",
            "null"
          ],
          "format": "uint32",
          "minimum": 0.0
        }
      }
    },
    "UserAgentBrandVersion": {
      "description": "One entry of CDP `Emulation.UserAgentBrandVersion` (UA client hints).",
      "type": "object",
      "required": [
        "brand",
        "version"
      ],
      "properties": {
        "brand": {
          "type": "string"
        },
        "version": {
          "type": "string"
        }
      }
    },
    "UserAgentMetadata": {
      "description": "Mirror of CDP `Emulation.UserAgentMetadata`; every field is optional and only sent when present.",
      "type": "object",
      "properties": {
        "architecture": {
          "type": [
            "string",
            "null"
          ]
        },
        "brands": {
          "type": [
            "array",
            "null"
          ],
          "items": {
            "$ref": "#/definitions/UserAgentBrandVersion"
          }
        },
        "full_version": {
          "type": [
            "string",
            "null"
          ]
        },
        "mobile": {
          "type": [
            "boolean",
            "null"
          ]
        },
        "model": {
          "type": [
            "string",
            "null"
          ]
        },
        "platform": {
          "type": [
            "string",
            "null"
          ]
        },
        "platform_version": {
          "type": [
            "string",
            "null"
          ]
        }
      }
    }
  }
}