WebsiteScreenshot.online MCP Server
OfficialClick on "Deploy Server".
Wait a few minutes for the server to deploy. Once ready, it will show a "Started" state.
In the chat, type
@followed by the MCP server name and your instructions, e.g., "@WebsiteScreenshot.online MCP ServerTake a screenshot of https://example.com"
That's it! The server will respond to your query, and you can continue using it as needed.
Here is a step-by-step guide with screenshots.
WebsiteScreenshot.online MCP Server
A Model Context Protocol server that wraps the WebsiteScreenshot.online REST API and exposes it as three MCP tools any MCP-compatible host (Claude Desktop, Claude Code, Cursor, Cline, Continue, Zed, Raycast, โฆ) can call directly.
โก Most users don't need this package
If you just want your AI assistant to take screenshots and record videos, use the hosted endpoint instead โ zero install, one line of JSON:
See the per-host configuration snippets for Claude Code, Claude Desktop, Cursor, Cline, Codex CLI, Gemini CLI, Continue, Windsurf, and Zed.
You only need this npm package if one of the following applies:
๐ฐ๏ธ Air-gapped or restricted network โ your AI host cannot reach
websitescreenshot.onlinedirectly.๐ Self-hosted WebsiteScreenshot โ you run your own instance and need
SCREENSHOT_API_BASEpointing at it.๐ง You want to audit / modify the server โ this is the same code the hosted endpoint runs, just without the Next.js wrapper.
In every other case, the hosted endpoint is strictly better (no Node dependency, automatic updates, no maintenance burden).
Related MCP server: MCP Browser Screenshot Server
1. Prerequisites
Node.js โฅ 18.18 (LTS recommended)
A free or paid WebsiteScreenshot.online account
A WebsiteScreenshot.online API key (see ยง 2)
2. Get an API key
Sign up at https://websitescreenshot.online (GitHub OAuth or email).
Switch to your locale if needed (e.g.
/en/dashboard/api-keys,/zh-CN/dashboard/api-keys).Open Dashboard โ API Keys โ Create new key.
Copy the key. It starts with
ws_followed by 64 hex chars (e.g.ws_<your-key-here>) and is shown once โ store it somewhere safe.
The MCP server only ever reads the key from the environment. It is never logged, never sent to the model, and never written to disk by this package.
3. Install & build
git clone https://github.com/Website-Screenshot-Online/websitescreenshot-mcp.git
cd websitescreenshot-mcp
npm install
npm run buildThat's it โ build/index.js is a self-contained executable you can wire into
any MCP host.
4. Configure your MCP host
Claude Desktop โ claude_desktop_config.json
~/Library/Application Support/Claude/claude_desktop_config.json (macOS) or
%APPDATA%/Claude/claude_desktop_config.json (Windows):
{
"mcpServers": {
"websitescreenshot": {
"command": "node",
"args": ["/absolute/path/to/websitescreenshot-mcp/build/index.js"],
"env": {
"SCREENSHOT_API_KEY": "ws_replace_with_your_real_api_key",
"SCREENSHOT_REQUEST_TIMEOUT_MS": "60000"
}
}
}
}Claude Code โ ~/.claude.json
{
"mcpServers": {
"websitescreenshot": {
"type": "stdio",
"command": "node",
"args": ["/absolute/path/to/websitescreenshot-mcp/build/index.js"],
"env": {
"SCREENSHOT_API_KEY": "ws_replace_with_your_real_api_key"
}
}
}
}Cursor / VS Code (.cursor/mcp.json)
{
"mcpServers": {
"websitescreenshot": {
"command": "node",
"args": ["/absolute/path/to/websitescreenshot-mcp/build/index.js"],
"env": { "SCREENSHOT_API_KEY": "ws_replace_with_your_real_api_key" }
}
}
}Cline / Continue / Zed / Raycast
All accept the same command + args + env shape โ just point them at
build/index.js and pass SCREENSHOT_API_KEY through env.
Restart the host after editing its config and the three tools will show up in its tool palette.
5. Self-hosted WebsiteScreenshot
If you run your own WebsiteScreenshot instance, point the server at it:
"env": {
"SCREENSHOT_API_KEY": "ws_replace_with_your_real_api_key",
"SCREENSHOT_API_BASE": "https://your-self-hosted.example.com"
}6. Usage examples
You don't write JSON manually โ the model does. These are the payloads the model will actually send.
Screenshot โ viewport of a landing page
take_screenshot({
url: "https://example.com",
resolution: { width: 1440, height: 900 },
format: "png",
fullSize: false,
blockAds: true,
blockCookiesGdpr: true,
delay: 1
})Screenshot โ full-page PDF for archival
take_screenshot({
url: "https://news.ycombinator.com",
fullSize: true,
format: "pdf"
})Synchronous video (โค 6 min)
record_website_video({
url: "https://stripe.com",
format: "mp4",
scrollMode: "smooth",
smoothScrollSpeed: "normal",
resolution: { width: 1280, height: 720 }
})Async video + status polling
record_website_video({ url: "https://stripe.com", async: true })
// โ { "success": true, "requestId": "f7c1..." }
check_video_status({ requestId: "f7c1..." })
// โ { "status": "pending", ... } // poll again
// โ { "status": "completed", "videoUrl": "https://...", ... }7. Tool reference
take_screenshot
Field | Type | Default | Notes |
| string (URL) | โ | required |
|
| 1920ร1080 | Any preset or custom size |
| bool |
| Capture entire scrollable page |
|
|
| |
| bool |
| Dismiss cookie banners first |
| bool |
| Block ad networks |
| int (0โ10 seconds) |
| Wait before capturing |
Response shape:
{
"success": true,
"imageUrl": "https://websitescreenshot.online/screenshots/abc.png",
"filename": "abc.png"
}record_website_video
Same fields as above plus:
Field | Type | Default |
|
|
|
|
|
|
|
|
|
| int 100โ1000 (px) |
|
| int 200โ5000 (ms) |
|
| bool |
|
Sync response:
{ "success": true, "videoUrl": "https://โฆ/abc.webm", "filename": "abc.webm" }Async response:
{ "success": true, "requestId": "f7c1โฆ" }check_video_status
Field | Type |
| string |
Response:
{
"status": "completed",
"siteUrl": "https://โฆ",
"result": { "success": true, "videoUrl": "https://โฆ", "filename": "abc.webm" },
"updatedAt": 1730000000000
}status is one of pending | completed | error. Results are kept
for 24 hours then deleted.
8. Error handling
Every API error is mapped to an MCP isError: true result containing
code, status, and error fields. Common codes:
Code | Meaning |
| Missing / revoked key |
| Per-key or per-IP limit hit; retry later |
| Plan quota exhausted |
| Input failed Zod validation |
| Server-side bug; retry with backoff |
| Request took longer than |
|
|
Rate limits: 10 screenshots / min and 5 videos / min per API key.
9. Environment variables
Variable | Required | Default | Purpose |
| yes | โ | The Bearer token sent to the API |
| no |
| Override for self-hosted / staging |
| no |
| Per-request abort timeout (ms) |
10. Development
npm run dev # tsx, hot reload stdio
npm run lint # type-check only
npm run build # emit build/index.jsTo point the dev server at a self-hosted API:
SCREENSHOT_API_BASE=http://localhost:3000 \
SCREENSHOT_API_KEY=ws_dev_replace_me \
npm run dev11. License
MIT ยฉ Crownbyte LTD โ see LICENSE.
Website: https://websitescreenshot.online Hosted MCP: https://websitescreenshot.online/api/mcp Docs: https://websitescreenshot.online/en/docs/mcp Support: support@websitescreenshot.online
Available Tools
3 toolscheck_video_statusA
Poll the status of an async video job created by record_website_video(async=true).
| Name | Required | Description | Default |
|---|---|---|---|
| requestId | Yes | The requestId returned from record_website_video with async=true. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With no annotations provided, the description carries the full burden. It discloses that this is a polling operation on status, implying a non-destructive read. But it does not describe what the response looks like (e.g., possible statuses like pending/completed/failed), nor does it mention any polling cadence or eventual termination. The description is safe but minimal, lacking deeper behavioral context like potential errors or rate limits.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
A single, focused sentence that front-loads the action and the source of the input. There is no extraneous wording; every part earns its place, making it easy to scan and understand.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a simple polling tool with one well-documented parameter and no output schema, the description adequately covers what the tool does and where the requestId originates. It could mention that polling is repeated until a terminal status is reached, but this is a minor gap given the minimal complexity.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
The schema provides full coverage (100%) and the requestId parameter has an explicit description stating it comes from record_website_video with async=true. The tool description adds no additional meaning beyond that, so baseline 3 applies. The schema already handles parameter semantics effectively.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states a specific verb ('poll'), the target resource ('status of an async video job'), and ties it explicitly to the creating tool, record_website_video with async=true. It distinguishes itself from siblings by stating its specific role in the async workflow, so an agent can easily identify its purpose.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description implies when to use it: after calling record_website_video with async=true and receiving a requestId. It gives context on where the requestId comes from. However, it does not explicitly state when not to use it (e.g., for sync jobs) or mention alternatives. Still, the context is clear enough for basic usage.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
record_website_videoA
Record a scrolling webm/mp4/gif capture of any public URL. Returns the public video URL (24h TTL). Pass async=true to receive a requestId; poll check_video_status until status=completed or status=error.
| Name | Required | Description | Default |
|---|---|---|---|
| url | Yes | Fully-qualified URL of the page to record. | |
| async | No | If true, return a requestId immediately and check status with check_video_status. | |
| delay | No | ||
| format | No | Output video container. | webm |
| blockAds | No | ||
| resolution | No | Optional {width,height}. Leave undefined to use the API default (1920x1080). Common presets: 1280x720 (HD 16:9), 1280x800 (16:10), 1280x1024 (5:4), 1366x768 (16:9), 1600x900 (HD+), 1920x1080 (Full HD), 1080x1080 (Square), 360x640 (Galaxy S10), 375x667 (iPhone 6/7/8), 375x812 (iPhone X), 414x736 (iPhone 6+/7+/8+), 414x896 (iPhone XR). | |
| scrollMode | No | step = pause-and-snap scrolling, smooth = continuous scroll. | step |
| scrollDelay | No | Milliseconds between scroll steps. | |
| scrollDistance | No | Pixels to move per scroll step. | |
| blockCookiesGdpr | No | ||
| smoothScrollSpeed | No | How fast the smooth scroll travels (only used when scrollMode=smooth). | normal |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With no annotations, the description carries the full burden. It discloses key behaviors: returns a public video URL with 24h TTL and supports async polling. It implicitly indicates that sync mode returns the video URL directly, implying it waits for completion. It does not mention failure modes or rate limits, but it covers essential outcome and async flow.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Two sentences with no fluff. The first states purpose and output; the second explains async usage. It is front-loaded and efficient.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
While the tool has many parameters, the schema covers their specifics. The description mentions the async workflow and TTL, and references check_video_status. It does not mention limitations like recording duration or errors, nor guidance on when to use this vs take_screenshot, but the essential usage is covered with the schema.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema coverage is 73%, so the schema already documents most parameters. The description adds meaningful guidance for the async parameter: 'Pass async=true to receive a requestId; poll check_video_status until status=completed or status=error,' which explains the workflow and connection to the polling tool. It also clarifies that the URL must be public, aiding interpretation of the url parameter.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states the action: 'Record a scrolling webm/mp4/gif capture of any public URL.' It distinguishes from the sibling take_screenshot by emphasizing 'scrolling' and 'video capture' with format options. It also mentions the output URL with TTL, providing a specific verb+resource.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description gives explicit guidance for async mode: 'Pass async=true to receive a requestId; poll check_video_status until status=completed or status=error.' It references the sibling check_video_status and explains the workflow. However, it does not explicitly contrast with take_screenshot or state when to prefer this tool over a screenshot, so it lacks a full when/when-not directive.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
take_screenshotA
Capture a PNG/JPEG/PDF screenshot of any public URL via WebsiteScreenshot.online. Returns the public image URL (24h TTL) and metadata. Use fullSize=true for full-page captures.
| Name | Required | Description | Default |
|---|---|---|---|
| url | Yes | Fully-qualified URL of the page to capture. | |
| delay | No | Seconds to wait after navigation before taking the shot. | |
| format | No | Output image format. | png |
| blockAds | No | Block ad networks before capturing. | |
| fullSize | No | Capture the full scrollable page instead of the viewport. | |
| resolution | No | Optional {width,height}. Leave undefined to use the API default (1920x1080). Common presets: 1280x720 (HD 16:9), 1280x800 (16:10), 1280x1024 (5:4), 1366x768 (16:9), 1600x900 (HD+), 1920x1080 (Full HD), 1080x1080 (Square), 360x640 (Galaxy S10), 375x667 (iPhone 6/7/8), 375x812 (iPhone X), 414x736 (iPhone 6+/7+/8+), 414x896 (iPhone XR). | |
| blockCookiesGdpr | No | Block GDPR/cookie banners before capturing. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With no annotations provided, the description carries the burden of behavioral disclosure. It adds useful details like 'Returns the public image URL (24h TTL) and metadata', but it does not explain what happens on failure, rate limits, authentication requirements, or how rendering works. This is partial transparency, not comprehensive.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is two compact sentences with no filler. The core action and deliverable are front-loaded, followed by a useful usage tip. Every clause earns its place.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
The description gives essential output context (public URL, 24h TTL, metadata) and the schema fully documents parameters. It is not a 5 because there is no output schema and the description does not cover error cases or operational constraints like network reachability or rendering behavior.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
The input schema has 100% description coverage for all parameters, so the schema already explains url, delay, format, blockAds, fullSize, resolution, and blockCookiesGdpr. The description only reinforces fullSize and the format list, adding no new parameter-level meaning beyond the schema. Baseline 3 is appropriate.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description uses a specific verb ('Capture'), names the resource ('a PNG/JPEG/PDF screenshot of any public URL'), and mentions the service ('WebsiteScreenshot.online'). This clearly differentiates it from sibling tools like record_website_video and check_video_status, which are about video capture/status rather than static screenshots.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description provides a usage hint ('Use fullSize=true for full-page captures') and constrains to public URLs, but it does not explicitly state when to choose this tool over record_website_video or check_video_status, nor does it mention exclusions. Usage is implied rather than directly compared with alternatives.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
Tool Schema Changelog
Recent tool additions, removals, and schema changes observed during successful MCP inspections.
3 tool updates
v1.0.0- First observed
check_video_status - First observed
record_website_video - First observed
take_screenshot
TDQS
Scored across 3 tools
Each tool has a clearly distinct role: take_screenshot captures an image, record_website_video captures a video, and check_video_status polls an async video job. There is no ambiguity about which tool to select for a given task.
All tool names follow a consistent snake_case verb_noun pattern: take_screenshot, record_website_video, check_video_status. The pattern is predictable and clearly indicates the action being performed.
Three tools is well-scoped for a screenshot/video capture server: one for screenshots, one for video, and one for async status polling. Each tool earns its place without unnecessary redundancy.
The core capture lifecycle is covered: synchronous screenshot capture, synchronous or asynchronous video capture, and async job polling. Minor gaps exist such as listing or canceling active video jobs, but the main workflows are fully usable.
Maintenance
Related MCP Connectors
Generate images, GIFs, and PDFs from HTML, URLs, or templates โ from your AI agent.
Screenshot any URL/HTML as PNG/JPEG/WebP, or read it as clean Markdown/text for LLMs.
Desktop and mobile website screenshots plus page context for AI agents and automation workflows.
- mcpOAuthcom.screenshotink
Screenshot, diff, audit and sitemap-capture any web page โ 5 MCP tools for AI agents.
Related MCP Servers
- AlicenseAqualityDmaintenanceCaptures screenshots of web pages using Puppeteer, allowing AI agents to visually verify web applications and see their progress when generating web apps.558MIT
- AlicenseAqualityDmaintenanceEnables AI assistants to capture screenshots of web pages using automated browser sessions. Supports full-page and element-specific screenshots, device simulation, and JavaScript execution for comprehensive web testing and monitoring.68MIT
- AlicenseNot gradedqualityDmaintenanceEnables AI assistants to capture website screenshots, automate browser interactions, and manage recurring screenshot configurations across 150+ global locations. It also supports AI-powered domain research and visual change monitoring for any web page.17MIT
- AlicenseAqualityDmaintenanceEnables AI assistants to capture screenshots of any public URL, returning images inline with page metadata. Supports full-page captures, custom wait times, and timeouts.119MIT