browser_take_screenshot
Capture screenshots of web pages or specific elements using Playwright on Cloudflare MCP. Supports PNG or JPEG formats, viewport or full-page capture, and targeted element screenshots for precise web testing.
Instructions
Take a screenshot of the current page. You can't perform actions based on the screenshot, use browser_snapshot for actions.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| element | No | Human-readable element description used to obtain permission to screenshot the element. If not provided, the screenshot will be taken of viewport. If element is provided, ref must be provided too. | |
| filename | No | File name to save the screenshot to. Defaults to `page-{timestamp}.{png|jpeg}` if not specified. | |
| fullPage | No | When true, takes a screenshot of the full scrollable page, instead of the currently visible viewport. Cannot be used with element screenshots. | |
| ref | No | Exact target element reference from the page snapshot. If not provided, the screenshot will be taken of viewport. If ref is provided, element must be provided too. | |
| type | No | Image format for the screenshot. Default is png. | png |
Implementation Reference
- src/tools/screenshot.ts:48-85 (handler)Handler function implementing the logic for browser_take_screenshot tool. Captures screenshot of viewport or specific element using Playwright, supports PNG/JPEG, base64 output, and generates execution code.handle: async (context, params) => { const tab = context.currentTabOrDie(); const snapshot = tab.snapshotOrDie(); const fileType = params.raw ? 'png' : 'jpeg'; const fileName = await outputFile(context.config, params.filename ?? `page-${new Date().toISOString()}.${fileType}`); const options: playwright.PageScreenshotOptions = { type: fileType, quality: fileType === 'png' ? undefined : 50, scale: 'css', path: fileName }; const isElementScreenshot = params.element && params.ref; const code = [ `// Screenshot ${isElementScreenshot ? params.element : 'viewport'} and save it as ${fileName}`, ]; const locator = params.ref ? snapshot.refLocator({ element: params.element || '', ref: params.ref }) : null; if (locator) code.push(`await page.${await generateLocator(locator)}.screenshot(${javascript.formatObject(options)});`); else code.push(`await page.screenshot(${javascript.formatObject(options)});`); const includeBase64 = context.clientSupportsImages(); const action = async () => { const screenshot = locator ? await locator.screenshot(options) : await tab.page.screenshot(options); return { content: includeBase64 ? [{ type: 'image' as 'image', data: screenshot.toString('base64'), mimeType: fileType === 'png' ? 'image/png' : 'image/jpeg', }] : [] }; }; return { code, action, captureSnapshot: true, waitForNetwork: false, }; }
- src/tools/screenshot.ts:26-36 (schema)Input schema (Zod) for browser_take_screenshot tool parameters: raw, filename, element, ref with validation that element and ref are both provided or neither.const screenshotSchema = z.object({ raw: z.coerce.boolean().optional().describe('Whether to return without compression (in PNG format). Default is false, which returns a JPEG image.'), filename: z.string().optional().describe('File name to save the screenshot to. Defaults to `page-{timestamp}.{png|jpeg}` if not specified.'), element: z.string().optional().describe('Human-readable element description used to obtain permission to screenshot the element. If not provided, the screenshot will be taken of viewport. If element is provided, ref must be provided too.'), ref: z.string().optional().describe('Exact target element reference from the page snapshot. If not provided, the screenshot will be taken of viewport. If ref is provided, element must be provided too.'), }).refine(data => { return !!data.element === !!data.ref; }, { message: 'Both element and ref must be provided or neither.', path: ['ref', 'element'] });
- src/tools/screenshot.ts:38-46 (registration)Definition and initial registration of the browser_take_screenshot tool using defineTool, including metadata like name, title, description, and reference to input schema.const screenshot = defineTool({ capability: 'core', schema: { name: 'browser_take_screenshot', title: 'Take a screenshot', description: `Take a screenshot of the current page. You can't perform actions based on the screenshot, use browser_snapshot for actions.`, inputSchema: screenshotSchema, type: 'readOnly', },
- src/tools/screenshot.ts:88-90 (registration)Export of the defined screenshot tool for use in higher-level tool collections.export default [ screenshot, ];
- src/tools.ts:45-45 (registration)Inclusion of the screenshot tool in the snapshotTools array, aggregating tools for registration....screenshot,