/url-instax

Primary LanguagePythonBSD 3-Clause "New" or "Revised" LicenseBSD-3-Clause

url-instax

Release Build status codecov Commit activity License

Screenshot for web page.

Quickstart

uvx url-instax http

or use docker image

docker run -p 8890:8890 ghcr.io/wh1isper/url-instax:latest

Access http://localhost:8890/docs for openapi docs.

Usage

Open https://url-instax.wh1isper.top:8890/api/v1/screenshot?url=https://example.com in your browser, and you will see a screenshot of the page.

I created a demo server, check https://url-instax.wh1isper.top:8890/docs for GET/POST API specification. This is only for testing and you should not use it for production.

MCP Server

This package includes a simple MCP server for LLM to view web page via screenshot. You can use this config to set up the server:

{
  "mcpServers": {
    "yourware-mcp": {
      "command": "uvx",
      "args": ["url-instax@latest", "mcp"],
      "env": {
        "API_BASE_URL": "http://localhost:8890"
      }
    }
  }
}

if API_BASE_URL is not provided, it will directly use playwright to take screenshot, which you need to install Playwright first via playwright install or uv tool run playwright install.

You can use https://url-instax.wh1isper.top:8890 as the API_BASE_URL for testing.