Skip to content

allscreenshots/allscreenshots-plugin

Repository files navigation

Allscreenshots Plugin

Take website screenshots from Claude Code, OpenAI Codex, and any MCP-compatible client via the Allscreenshots API.

Supported Platforms

  • Claude Code
  • OpenAI Codex
  • MCP-compatible clients such as Cursor, VS Code Copilot, Gemini CLI, and Windsurf

Quick Install

Claude Code

Add the Allscreenshots marketplace, then install the plugin:

/plugin marketplace add allscreenshots/allscreenshots-plugin
/plugin install allscreenshots@allscreenshots

Restart Claude Code after installation. The Claude Code marketplace installs a small plugin package from claude-code-plugin/.

If you already installed an older version and Claude Code still reports a plugin cache error, refresh the marketplace and update the plugin:

/plugin marketplace update allscreenshots
/plugin update allscreenshots@allscreenshots

OpenAI Codex

Add the Allscreenshots marketplace, then install the plugin from Codex's plugin directory:

codex plugin marketplace add allscreenshots/allscreenshots-plugin
codex
/plugins

Choose the Allscreenshots marketplace, open the Allscreenshots plugin, and install it. The plugin bundles the MCP server configuration, so you do not need to paste a long codex mcp add command.

If you already installed an older version, refresh the marketplace first:

codex plugin marketplace upgrade allscreenshots

Generic MCP Client

Configure your MCP client to run:

python3 /path/to/allscreenshots-plugin/mcp_server/server.py

Set an API key in the MCP server environment or pass it through the api_key tool parameter.

Configuration

Get an API key from:

https://allscreenshots.com/dashboard

Then set it as an environment variable:

export ALLSCREENSHOTS_API_KEY=your-key-here

You can also pass an API key directly through the api_key parameter when calling take_screenshot.

The MCP server reads ALLSCREENSHOTS_API_KEY when that variable is visible to the MCP subprocess. You can also pass an API key directly through the api_key parameter when calling take_screenshot.

If the MCP tool is unavailable, the Allscreenshots REST API can be called directly with curl; no Allscreenshots CLI is required.

Available Tools

Tool Description Parameters
take_screenshot Captures a website screenshot and returns the saved local file path. url, api_key, width, height, format, full_page, delay, dark_mode, block_ads
get_api_info Returns setup links, supported formats, rate limit notes, and API key guidance. None

Examples

  • "Take a screenshot of https://example.com"
  • "Capture a full-page screenshot of our landing page"
  • "Screenshot this page in dark mode"
  • "Take a mobile screenshot of https://example.com"
  • "Grab a screenshot without ads or cookie banners"
  • "How do I get an Allscreenshots API key?"

Development

Run the MCP server locally:

cd mcp_server
export ALLSCREENSHOTS_API_KEY=test-key
python3 server.py

Run tests:

uv run --with "fastmcp>=2.0" --with "httpx>=0.27" --with "pytest>=8" pytest

Package the Claude Code and Codex plugin distributions:

python3 scripts/package_plugins.py

Archives are written to dist/.

Inspect the Codex marketplace metadata:

codex plugin marketplace add ./path/to/allscreenshots-plugin
codex
/plugins

License

MIT

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages