Skip to main content
Glama

browser_set_viewport

Adjust the browser's viewport dimensions and scaling factor to simulate different screen sizes and resolutions for responsive design testing or accurate web content rendering.

Instructions

Change the browser's viewport size and scale factor

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
deviceScaleFactorNoDevice scale factor (affects how content is scaled)
heightNoViewport height in pixels
widthNoViewport width in pixels

Implementation Reference

  • The main handler function for browser_set_viewport tool. It sets the viewport size on the Playwright page, optionally updates device scale factor, persists changes to config file and environment variables, and returns a success message.
    async function handleBrowserSetViewport(page: Page, args: any): Promise<{ toolResult: CallToolResult }> {
      try {
        const config = getConfig();
        
        // Get current values or use defaults from config
        const width = args.width || config.viewportWidth;
        const height = args.height || config.viewportHeight;
        const deviceScaleFactor = args.deviceScaleFactor || config.deviceScaleFactor;
        
        // Set the new viewport size
        await page.setViewportSize({ width, height });
        
        // Save the configuration for future sessions
        try {
          const configPath = path.join(os.homedir(), '.mcp_browser_agent_config.json');
          const config = fs.existsSync(configPath) 
            ? JSON.parse(fs.readFileSync(configPath, 'utf8')) 
            : {};
          
          if (args.width) {
            config.viewportWidth = width;
            process.env.MCP_VIEWPORT_WIDTH = width.toString();
          }
          
          if (args.height) {
            config.viewportHeight = height;
            process.env.MCP_VIEWPORT_HEIGHT = height.toString();
          }
          
          if (args.deviceScaleFactor) {
            config.deviceScaleFactor = deviceScaleFactor;
            process.env.MCP_DEVICE_SCALE_FACTOR = deviceScaleFactor.toString();
          }
          
          fs.writeFileSync(configPath, JSON.stringify(config, null, 2));
        } catch (error) {
          console.error('Error saving viewport config:', error);
        }
        
        return {
          toolResult: {
            content: [{
              type: "text",
              text: `Set viewport to width: ${width}, height: ${height}, scale factor: ${deviceScaleFactor}`,
            }],
            isError: false,
          },
        };
      } catch (error) {
        return {
          toolResult: {
            content: [{
              type: "text",
              text: `Failed to set viewport: ${(error as Error).message}`,
            }],
            isError: true,
          },
        };
      }
    }
  • src/tools.ts:24-36 (registration)
    Tool registration object defining the name, description, and input schema for browser_set_viewport. Part of the registerTools() function that returns the list of available tools.
    {
      name: "browser_set_viewport",
      description: "Change the browser's viewport size and scale factor",
      inputSchema: {
        type: "object",
        properties: {
          width: { type: "number", description: "Viewport width in pixels" },
          height: { type: "number", description: "Viewport height in pixels" },
          deviceScaleFactor: { type: "number", description: "Device scale factor (affects how content is scaled)" }
        },
        required: []
      }
    },
  • Input schema defining the parameters for the browser_set_viewport tool: width, height, and optional deviceScaleFactor.
    inputSchema: {
      type: "object",
      properties: {
        width: { type: "number", description: "Viewport width in pixels" },
        height: { type: "number", description: "Viewport height in pixels" },
        deviceScaleFactor: { type: "number", description: "Device scale factor (affects how content is scaled)" }
      },
      required: []
    }
  • Switch case in executeToolCall that registers and dispatches the browser_set_viewport tool call to its handler function.
    case "browser_set_viewport":
      return await handleBrowserSetViewport(activePage!, args);
  • src/tools.ts:11-11 (registration)
    The tool name listed in the BROWSER_TOOLS constant array, used to identify browser-related tools.
    "browser_set_viewport"
Behavior2/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

With no annotations provided, the description carries the full burden of behavioral disclosure. It states the action ('Change') but doesn't explain what happens after the change (e.g., does it affect subsequent interactions, is it persistent, are there side effects like page reloads). For a mutation tool with zero annotation coverage, this is a significant gap in transparency.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is a single, efficient sentence that directly states the tool's purpose without any wasted words. It's appropriately sized and front-loaded, making it easy to understand at a glance.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness2/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given the tool's complexity (a mutation operation affecting browser state) and the lack of annotations and output schema, the description is insufficient. It doesn't cover behavioral aspects like effects on page rendering, error conditions, or return values, leaving critical gaps for an AI agent to use it correctly.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

The schema description coverage is 100%, with clear descriptions for all three parameters (width, height, deviceScaleFactor). The description adds no additional meaning beyond what the schema provides, such as typical values or interactions between parameters, so it meets the baseline of 3.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states the action ('Change') and resource ('browser's viewport size and scale factor'), making the purpose immediately understandable. However, it doesn't explicitly differentiate this tool from its siblings (like browser_screenshot or browser_navigate), which would require a 5.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines2/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description provides no guidance on when to use this tool versus alternatives, such as browser_screenshot (which might capture the viewport) or browser_navigate (which might affect viewport indirectly). There's no mention of prerequisites, typical use cases, or exclusions.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Install Server

Other Tools

Related Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/imprvhub/mcp-browser-agent'

If you have feedback or need assistance with the MCP directory API, please join our Discord server