Setup guide

Use GetScreenshot in Codex

Add the GetScreenshot MCP server with codex mcp add or a few lines in config.toml. Codex can then capture any public page, render HTML it just wrote, and compare before and after.

Works with any GetScreenshot API key on any plan, from $5/month.

What you get

Five tools that let the agent look at web pages

Look at any public page

The agent passes a URL to capture_screenshot. A hosted browser renders the page and the tool returns images sized for vision models, plus a link to the full-resolution file.

Render HTML it just wrote

render_html takes an HTML string and returns a screenshot of it. The agent can check a component or email template without a local browser.

Compare before and after

compare_screenshots diffs two pages or two earlier captures and reports the share of changed pixels, where the change is, and a diff image.

Limits worth knowing: captures run on our servers, so they cannot reach localhost or private networks. Each call is a single capture, not a logged-in browsing session. For multi-step browser automation see GetScreenshot vs Playwright MCP. Screenshot links are public URLs that stay available for 30 days.

Before You Start

Three things to have ready

A GetScreenshot API key

Any plan works. Plans start at $5/month for 2,500 screenshots. Get a key.

Codex

The Codex CLI installed and signed in.

Node.js 20.9 or newer

Only for the local option, which runs npx -y getscreenshot-mcp on your machine. The hosted option needs nothing installed.

How to Set Up

Hosted server at https://mcp.getscreenshotapi.com/mcp, or a local server started with npx

Codex supports both connection styles. Use one of them, not both. Codex keeps MCP servers in ~/.codex/config.toml, and OpenAI's documentation says the Codex CLI, the IDE extension and the ChatGPT desktop app share that configuration. Both give the agent the same five tools and use the same API key and quota.

1

Get your API key

Pick a plan on the pricing page. The key arrives by email after checkout. The MCP server works with any API key on any plan, including Lincoln at $5/month for 2,500 screenshots. Code FREE5 makes the first month of the $5 plan free. If you lose the key, recover it from your account page.

View pricing plans
2

Put the key in an environment variable

Set GETSCREENSHOT_API_KEY once, so the config below can reference the key instead of containing it. On macOS and Linux, add this line to your shell profile (~/.zshrc or ~/.bashrc). On Windows, add it as a user environment variable.

export GETSCREENSHOT_API_KEY=YOUR_API_KEY

The hosted setup and the config.toml form of the local setup read the key from this variable, so the key does not have to be written into a file. Open a new terminal after editing your profile.

3

Option A: connect to the hosted server

Nothing to install. --bearer-token-env-var names the environment variable whose value Codex sends as a bearer token in the Authorization header.

codex mcp add getscreenshot --url https://mcp.getscreenshotapi.com/mcp \
  --bearer-token-env-var GETSCREENSHOT_API_KEY

Or write the entry yourself in ~/.codex/config.toml:

~/.codex/config.toml

[mcp_servers.getscreenshot]
url = "https://mcp.getscreenshotapi.com/mcp"
bearer_token_env_var = "GETSCREENSHOT_API_KEY"
4

Option B: run the server locally

Codex starts the server on your machine with npx. Needs Node.js 20.9 or newer. env_vars lists environment variables that Codex forwards to the server, so the key stays out of the file.

~/.codex/config.toml

[mcp_servers.getscreenshot]
command = "npx"
args = ["-y", "getscreenshot-mcp"]
env_vars = ["GETSCREENSHOT_API_KEY"]

The CLI can add a local server too. This form stores the key itself in ~/.codex/config.toml, which sits in your home directory:

codex mcp add getscreenshot --env GETSCREENSHOT_API_KEY=YOUR_API_KEY -- npx -y getscreenshot-mcp

Codex also reads a project-scoped .codex/config.toml in trusted projects. If you put the server there, use the environment variable forms above and never a literal key, because that file is likely to be committed.

5

Raise the tool timeout

Codex stops an MCP tool call after 60 seconds by default and gives a server 10 seconds to start. A capture usually takes around 9 seconds, but a slow page can run up to the API's 90 second limit, and the first npx run has to download the package. Add these two lines to the same table:

~/.codex/config.toml

[mcp_servers.getscreenshot]
# ...url or command lines from above...
tool_timeout_sec = 120
startup_timeout_sec = 30
6

Confirm it is connected

List the configured servers from a terminal:

codex mcp list

In the codex terminal UI, type /mcp to see the active servers. getscreenshot should be there.

7

Try a prompt

Ask for a screenshot of a public page.

Take a screenshot of https://example.com and describe what is above the fold.

Prompts to Try

Replace the example URLs and file names with your own

Check a deployed change

Take a full-page screenshot of https://example.com/pricing and list anything that looks broken or misaligned.

Check HTML you just wrote

Render the HTML in public/index.html with render_html and tell me whether the hero section looks right.

Compare staging and production

Compare https://staging.example.com with https://www.example.com and describe what changed.

Check a mobile layout

Capture https://example.com with the iphone12 device and tell me if the navigation fits on screen.

Each page captured uses one screenshot from your monthly quota. A comparison uses one per page it has to capture.

Tools the Server Adds

All five are read-only. Full inputs and outputs are in the MCP server reference

Tool What it does
capture_screenshot Capture a public web page as images the model can see. Options cover full-page capture, a single element by CSS selector, device presets and wait conditions.
render_html Render an HTML string (up to 2 MB) and screenshot it. Useful for a component or page the agent just wrote.
compare_screenshots Visual diff of two pages or two earlier screenshots. Returns the changed-pixel percentage, the bounding box of the change and a diff image.
capture_pdf Save a page as an A4 PDF and return a link that works for 30 days.
get_usage Screenshots used, monthly limit and reset date for your key. Costs 1 quota unit.

Troubleshooting

Common issues and how to resolve them

Tools say no API key is configured, or the hosted server rejects the request

  • • Run echo $GETSCREENSHOT_API_KEY in the terminal you start Codex from. If it prints nothing, the variable is not set in that shell.
  • • The variable has to exist in the environment Codex itself runs in. An app started from the desktop may not see variables that are only set in a shell profile.
  • • Hosted setup: bearer_token_env_var takes the name of the variable, not the key.

The server does not start

  • • Local setup: run node --version. It should print v20.9 or newer.
  • • Raise startup_timeout_sec. The default is 10 seconds.

A tool call times out on a slow page

  • • Ask the agent to retry with wait_until: "domcontentloaded". It is the fastest setting and the most reliable on heavy sites.
  • • A capture usually takes around 9 seconds. The API gives up after 90 seconds.
  • • Failed captures still count against your monthly quota, so change the settings before retrying more than once.
  • • Codex's default tool_timeout_sec is 60 seconds. Set it to 120 for this server, as in the setup steps.

The agent cannot capture localhost or an internal site

  • • The capture runs on our servers, which cannot reach localhost or private networks.
  • • For markup the agent just wrote, use render_html with the HTML itself. Inline the CSS and images or set <base href>, because relative asset URLs will not resolve.
  • • For a running app, give the agent a public preview URL or a tunnel address.

The image is too large for the conversation

  • • Ask for return: "url_only" to get the screenshot_url without inline images.
  • • Capture one part of the page with element and a CSS selector instead of the full page.
  • • Lower max_slices (default 4) to limit how many images a full-page capture returns.

Still stuck? Email support@rasterwise.com.

Other AI Clients

The same server works in other MCP clients. See all options on the AI Agents page

Prefer instructions the agent loads on demand? See the GetScreenshot agent skill.

GetScreenshot is an independent product. It is not affiliated with or endorsed by the makers of Codex. Product names belong to their owners.

Get an API Key and Connect Codex

Plans start at $5/month for 2,500 screenshots. The MCP server works with any API key on any plan.