capture_screenshot
Capture full-page website screenshots with device presets, viewport customization, and wait conditions for reliable webpage documentation.
Instructions
Capture a full-page screenshot of a webpage with advanced options
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| url | Yes | The URL of the webpage to screenshot | |
| viewport | No | Viewport configuration | |
| waitFor | No | Wait condition before taking screenshot | |
| standardDelay | No | Whether to apply standard 2.5s delay after networkidle2 for better stability | |
| delay | No | Additional delay in milliseconds before taking screenshot | |
| waitUntil | No | When to consider navigation complete | networkidle2 |
Implementation Reference
- src/screenshot.js:43-152 (handler)Core handler function that executes the screenshot capture using Puppeteer for browser automation, Sharp for image processing and resizing if necessary, handles viewport emulation, various wait conditions, and returns base64 PNG data with metadata.
async captureScreenshot(url, options = {}) { if (this.activeScreenshots >= this.options.maxConcurrent) { throw createError('Too many concurrent screenshot requests', 'RATE_LIMIT_EXCEEDED'); } this.activeScreenshots++; try { const validatedUrl = validateUrl(url); await this.initialize(); const page = await this.browser.newPage(); try { // Configure viewport await this.configureViewport(page, options.viewport); // Set timeouts page.setDefaultTimeout(this.options.timeout); page.setDefaultNavigationTimeout(this.options.timeout); // Navigate to URL await page.goto(validatedUrl, { waitUntil: options.waitUntil || 'networkidle2', timeout: this.options.timeout }); // Wait for specific conditions if provided if (options.waitFor) { await this.waitForCondition(page, options.waitFor); } // Standard delay after networkidle2 for better stability const standardDelay = options.standardDelay !== false ? 2500 : 0; if (standardDelay > 0) { await new Promise(resolve => setTimeout(resolve, standardDelay)); } // Additional delay if specified if (options.delay) { await new Promise(resolve => setTimeout(resolve, options.delay)); } // Capture screenshot with dimension validation const screenshotOptions = { type: 'png', fullPage: true, encoding: 'base64', ...options.screenshotOptions }; // * Take the screenshot const screenshotBase64 = await page.screenshot(screenshotOptions); // * Decode base64 to buffer for sharp processing let screenshotBuffer = Buffer.from(screenshotBase64, 'base64'); let metadata; try { metadata = await sharp(screenshotBuffer).metadata(); } catch (err) { throw createError('Failed to read screenshot metadata', 'IMAGE_METADATA_ERROR', { originalError: err.message }); } // * Check if resizing is needed const maxDimension = 8000; if (metadata.width > maxDimension || metadata.height > maxDimension) { // * Calculate scale factor to fit within 8000x8000 const scale = Math.min(maxDimension / metadata.width, maxDimension / metadata.height); const newWidth = Math.floor(metadata.width * scale); const newHeight = Math.floor(metadata.height * scale); try { screenshotBuffer = await sharp(screenshotBuffer) .resize({ width: newWidth, height: newHeight }) .png() .toBuffer(); } catch (err) { throw createError('Failed to resize screenshot image', 'IMAGE_RESIZE_ERROR', { originalError: err.message }); } } // * Encode back to base64 const finalBase64 = screenshotBuffer.toString('base64'); return { success: true, data: finalBase64, metadata: { url: validatedUrl, timestamp: new Date().toISOString(), viewport: await page.viewport(), title: await page.title(), imageWidth: metadata.width, imageHeight: metadata.height } }; } finally { await page.close(); } } catch (error) { throw createError( `Screenshot capture failed: ${error.message}`, 'CAPTURE_FAILED', { url, originalError: error.message } ); } finally { this.activeScreenshots--; } } - index.js:33-118 (schema)Input schema for the capture_screenshot tool, defining parameters like url (required), viewport options with device presets, wait conditions, delays, and validation rules.
inputSchema: { type: 'object', properties: { url: { type: 'string', description: 'The URL of the webpage to screenshot' }, viewport: { type: 'object', properties: { preset: { type: 'string', enum: Object.keys(DEVICE_PRESETS), description: 'Device preset (mobile, tablet, desktop)' }, width: { type: 'number', minimum: 100, maximum: 5000, description: 'Viewport width in pixels' }, height: { type: 'number', minimum: 100, maximum: 5000, description: 'Viewport height in pixels' }, deviceScaleFactor: { type: 'number', minimum: 0.1, maximum: 3, description: 'Device scale factor' }, isMobile: { type: 'boolean', description: 'Whether to emulate mobile device' }, hasTouch: { type: 'boolean', description: 'Whether device has touch support' } }, description: 'Viewport configuration' }, waitFor: { type: 'object', properties: { type: { type: 'string', enum: ['selector', 'function', 'timeout', 'networkidle'], description: 'Type of wait condition' }, value: { type: 'string', description: 'Value for wait condition (selector, function, timeout in ms, or idle time for networkidle)' }, timeout: { type: 'number', default: 10000, description: 'Timeout for wait condition in milliseconds' }, idleTime: { type: 'number', default: 2000, description: 'Network idle time in milliseconds (for networkidle type)' } }, description: 'Wait condition before taking screenshot' }, standardDelay: { type: 'boolean', default: true, description: 'Whether to apply standard 2.5s delay after networkidle2 for better stability' }, delay: { type: 'number', description: 'Additional delay in milliseconds before taking screenshot' }, waitUntil: { type: 'string', enum: ['load', 'domcontentloaded', 'networkidle0', 'networkidle2'], default: 'networkidle2', description: 'When to consider navigation complete' } }, required: ['url'] - index.js:30-120 (registration)Tool registration in the MCP tools list, defining name, description, and references the input schema. Used by the server's listTools request handler.
{ name: 'capture_screenshot', description: 'Capture a full-page screenshot of a webpage with advanced options', inputSchema: { type: 'object', properties: { url: { type: 'string', description: 'The URL of the webpage to screenshot' }, viewport: { type: 'object', properties: { preset: { type: 'string', enum: Object.keys(DEVICE_PRESETS), description: 'Device preset (mobile, tablet, desktop)' }, width: { type: 'number', minimum: 100, maximum: 5000, description: 'Viewport width in pixels' }, height: { type: 'number', minimum: 100, maximum: 5000, description: 'Viewport height in pixels' }, deviceScaleFactor: { type: 'number', minimum: 0.1, maximum: 3, description: 'Device scale factor' }, isMobile: { type: 'boolean', description: 'Whether to emulate mobile device' }, hasTouch: { type: 'boolean', description: 'Whether device has touch support' } }, description: 'Viewport configuration' }, waitFor: { type: 'object', properties: { type: { type: 'string', enum: ['selector', 'function', 'timeout', 'networkidle'], description: 'Type of wait condition' }, value: { type: 'string', description: 'Value for wait condition (selector, function, timeout in ms, or idle time for networkidle)' }, timeout: { type: 'number', default: 10000, description: 'Timeout for wait condition in milliseconds' }, idleTime: { type: 'number', default: 2000, description: 'Network idle time in milliseconds (for networkidle type)' } }, description: 'Wait condition before taking screenshot' }, standardDelay: { type: 'boolean', default: true, description: 'Whether to apply standard 2.5s delay after networkidle2 for better stability' }, delay: { type: 'number', description: 'Additional delay in milliseconds before taking screenshot' }, waitUntil: { type: 'string', enum: ['load', 'domcontentloaded', 'networkidle0', 'networkidle2'], default: 'networkidle2', description: 'When to consider navigation complete' } }, required: ['url'] } }, - index.js:191-216 (handler)Dispatch handler in MCP callTool request handler that invokes the captureScreenshot method with parsed arguments and formats the MCP response with text, image, and metadata content blocks.
case 'capture_screenshot': const result = await screenshotCapture.captureScreenshot(args.url, { viewport: args.viewport, waitFor: args.waitFor, delay: args.delay, waitUntil: args.waitUntil, standardDelay: args.standardDelay }); return { content: [ { type: 'text', text: `Screenshot captured successfully from ${args.url}` }, { type: 'image', data: result.data, mimeType: 'image/png' }, { type: 'text', text: `Metadata: ${JSON.stringify(result.metadata, null, 2)}` } ] }; - index.js:22-26 (helper)Initializes the ScreenshotCapture instance used by the capture_screenshot tool handler, configured via environment variables for headless mode, timeouts, and concurrency limits.
const screenshotCapture = new ScreenshotCapture({ headless: process.env.BROWSER_HEADLESS !== 'false', timeout: parseInt(process.env.BROWSER_TIMEOUT) || 30000, maxConcurrent: parseInt(process.env.MAX_CONCURRENT_SCREENSHOTS) || 5 });