Rendex: Rendering API for Images, PDFs & Content Extraction

Official13 toolsLive

by copperline-labs · TypeScript

Render HTML, Markdown, or URLs to images, PDF, or branded artifacts; extract and watch pages.

@copperline/rendex-mcp (MCP Server) — Render-to-Image/PDF Web Capture

io.github.copperline-labs/rendex-mcp is an MCP server for Rendex. It renders raw HTML, Markdown, or URLs into images, PDF, or branded artifacts, and it can extract and watch pages. The project is distributed as @copperline/rendex-mcp and includes MIT licensing.

🛠️ Key Features

Render raw HTML to images, PDF, or branded artifacts
Render Markdown to images, PDF, or branded artifacts
Render any URL to images, PDF, or branded artifacts
Extract and watch pages
Tool set size: 13 tools

🚀 Use Cases

Web capture and screenshot-style workflows (screenshot, screenshot-api)
Converting web content (HTML/Markdown/URLs) into artifacts for downstream processing
Monitoring page changes (“watch pages”)

⚡ Developer Benefits

Built for Model Context Protocol (mcp, model-context-protocol, mcp-server)
Integrates with AI-agent environments (ai-agent, api, claude)
Topics indicate support for web capture and branded output (web-capture, rendex)

⚠️ Limitations

Source material provides tool count (13) and high-level capabilities, but not specific render formats, parameters, or page-watch scope.

Topics

ai-agentapiclaudemcpmodel-context-protocolscreenshotcloudflare-workersmcp-serverweb-capturescreenshot-apirendex

Captured live from the server via tools/list.

rendex_screenshot

Use this when the user asks to screenshot, capture, or take a picture of a webpage/URL, or to render raw HTML or Markdown to an image or PDF. Do NOT use to get a reusable hosted image URL (use rendex_render_link) or to make a branded multi-format document (use render_artifact). Captures a screenshot or PDF of any webpage, raw HTML, or Markdown. Supports full-page capture, dark mode, ad blocking, custom viewports, CSS/JS injection, cookie/header injection, PDF output, HTML and Markdown rendering, and progressive fallback for heavy sites. Returns partial renders on timeout by default (bestAttempt mode). Costs 1 render credit per call. Cookie/header injection requires Starter+; geo-targeting requires Pro+.

Parameters37

url	string	optional	The webpage URL to capture (a schemeless host like 'example.com' is accepted). Mutually exclusive with 'html' and 'markdown'.
html	string	optional	Raw HTML to render and capture. Mutually exclusive with 'url' and 'markdown'. Great for invoices, social cards, email templates, OG images.
markdown	string	optional	Markdown to render to an image or PDF. Mutually exclusive with 'url' and 'html'. The server converts it to HTML before rendering. Great for reports, release notes, README snapshots, documentation cards.
format	string	optional	Output format — png (lossless), jpeg (smaller), webp (smallest), or pdf (document). Use pdf for invoices, reports, archival.
fullPage	boolean	optional	Capture the full scrollable page instead of just the viewport
darkMode	boolean	optional	Emulate dark color scheme (prefers-color-scheme: dark)
width	integer	optional	Viewport width in pixels (320-3840)
height	integer	optional	Viewport height in pixels (240-2160)
quality	integer	optional	Image quality 1-100 (JPEG/WebP only, ignored for PNG/PDF)
delay	integer	optional	Milliseconds to wait after page load before capture (useful for JS-rendered content)
blockAds	boolean	optional	Block ads and trackers before capture
blockResourceTypes	array	optional	Block specific resource types to speed up capture. E.g. ['font', 'image'] for text-only screenshots.
deviceScaleFactor	number	optional	Device pixel ratio (1 = standard, 2 = retina). Defaults to 2× Retina.
device	string	optional	Device preset that sets viewport, scale factor, and user agent in one shot. E.g. 'iphone_15' for a mobile screenshot. Overrides width/height/deviceScaleFactor/userAgent.
timeout	integer	optional	Maximum seconds to wait for page load (5-60). Cloudflare has a 60s hard cap.
waitUntil	string	optional	Page readiness event. networkidle2 (default) is best for most sites. Use domcontentloaded for speed, networkidle0 for completeness.
waitForSelector	string	optional	CSS selector to wait for before capture. Essential for SPAs (e.g. '.main-content', '#app-loaded')
bestAttempt	boolean	optional	If true (default), capture whatever is rendered on timeout instead of failing. Set to false to get a hard error on timeout.
selector	string	optional	CSS selector of a specific element to capture instead of the full page. Useful for OG images, component extraction (e.g. '#hero', '.pricing-card')
hideSelectors	array	optional	CSS selectors to hide (display:none) before capture. E.g. ['.modal', '#newsletter-popup'] to remove overlays. Max 50 selectors.
blockCookieBanners	boolean	optional	Hide common cookie/consent walls (GDPR/CCPA banners) before capture. A curated selector list, lighter than custom hideSelectors.
resizeWidth	integer	optional	Downscale the captured image to this width in pixels (16-3840). Aspect ratio is preserved if resizeHeight is omitted. Ignored for PDF.
resizeHeight	integer	optional	Downscale the captured image to this height in pixels (16-2160). Aspect ratio is preserved if resizeWidth is omitted. Ignored for PDF.
css	string	optional	Custom CSS to inject into the page before capture. Hide cookie banners, add watermarks, override styles. Max 50KB.
js	string	optional	Custom JavaScript to execute in the page before capture. Runs in the browser sandbox. Max 50KB.
cookies	array	optional	Cookies to set before capture. Useful for authenticated pages. Max 50 cookies.
headers	object	optional	Custom HTTP headers to send with the page request. Cannot override Host, Connection, Content-Length, or Transfer-Encoding.
userAgent	string	optional	Override the browser user agent string.
pdfFormat	string	optional	PDF page size. Only used when format='pdf'. Default: A4
pdfLandscape	boolean	optional	PDF landscape orientation. Only used when format='pdf'.
pdfPrintBackground	boolean	optional	Print background colors/images in PDF. Default: true
pdfScale	number	optional	PDF scale factor (0.1-2). Default: 1
pdfMargin	object	optional	PDF page margins. Only used when format='pdf'. Accepts CSS values.
data	object	optional	Key-value data object for Mustache templating. When provided, the 'html' or 'markdown' string is rendered as a logic-less Mustache template before capture — {{var}} inserts HTML-escaped, {{{var}}} inserts raw, {{#items}}...{{/items}} iterates arrays, {{a.b}} accesses nested fields. Not valid with 'url'. Max 256KB serialized.
geo	string	optional	ISO 3166-1 alpha-2 country code for geo-targeted capture (e.g., 'US', 'DE', 'JP'). Renders the page as seen from that country. Pro/Enterprise only. Note: CSS/JS injection, cookies, element capture, dark mode, and some other features are not available with geo-targeting.
geoCity	string	optional	City for more precise geo-targeting (e.g., 'Berlin', 'New York'). Requires 'geo'.
geoState	string	optional	State or region for more precise geo-targeting (e.g., 'California'). Requires 'geo'.

Raw schema

{
  "type": "object",
  "properties": {
    "url": {
      "type": "string",
      "format": "uri",
      "description": "The webpage URL to capture (a schemeless host like 'example.com' is accepted). Mutually exclusive with 'html' and 'markdown'."
    },
    "html": {
      "type": "string",
      "maxLength": 5242880,
      "description": "Raw HTML to render and capture. Mutually exclusive with 'url' and 'markdown'. Great for invoices, social cards, email templates, OG images."
    },
    "markdown": {
      "type": "string",
      "maxLength": 5242880,
      "description": "Markdown to render to an image or PDF. Mutually exclusive with 'url' and 'html'. The server converts it to HTML before rendering. Great for reports, release notes, README snapshots, documentation cards."
    },
    "format": {
      "type": "string",
      "enum": [
        "png",
        "jpeg",
        "webp",
        "pdf"
      ],
      "default": "png",
      "description": "Output format — png (lossless), jpeg (smaller), webp (smallest), or pdf (document). Use pdf for invoices, reports, archival."
    },
    "fullPage": {
      "type": "boolean",
      "default": false,
      "description": "Capture the full scrollable page instead of just the viewport"
    },
    "darkMode": {
      "type": "boolean",
      "default": false,
      "description": "Emulate dark color scheme (prefers-color-scheme: dark)"
    },
    "width": {
      "type": "integer",
      "minimum": 320,
      "maximum": 3840,
      "default": 1280,
      "description": "Viewport width in pixels (320-3840)"
    },
    "height": {
      "type": "integer",
      "minimum": 240,
      "maximum": 2160,
      "default": 800,
      "description": "Viewport height in pixels (240-2160)"
    },
    "quality": {
      "type": "integer",
      "minimum": 1,
      "maximum": 100,
      "description": "Image quality 1-100 (JPEG/WebP only, ignored for PNG/PDF)"
    },
    "delay": {
      "type": "integer",
      "minimum": 0,
      "maximum": 10000,
      "default": 0,
      "description": "Milliseconds to wait after page load before capture (useful for JS-rendered content)"
    },
    "blockAds": {
      "type": "boolean",
      "default": true,
      "description": "Block ads and trackers before capture"
    },
    "blockResourceTypes": {
      "type": "array",
      "items": {
        "type": "string",
        "enum": [
          "font",
          "image",
          "media",
          "stylesheet",
          "other"
        ]
      },
      "description": "Block specific resource types to speed up capture. E.g. ['font', 'image'] for text-only screenshots."
    },
    "deviceScaleFactor": {
      "type": "number",
      "minimum": 1,
      "maximum": 3,
      "default": 2,
      "description": "Device pixel ratio (1 = standard, 2 = retina). Defaults to 2× Retina."
    },
    "device": {
      "type": "string",
      "enum": [
        "desktop",
        "iphone_15",
        "iphone_se",
        "pixel_8",
        "ipad",
        "ipad_pro"
      ],
      "description": "Device preset that sets viewport, scale factor, and user agent in one shot. E.g. 'iphone_15' for a mobile screenshot. Overrides width/height/deviceScaleFactor/userAgent."
    },
    "timeout": {
      "type": "integer",
      "minimum": 5,
      "maximum": 60,
      "default": 30,
      "description": "Maximum seconds to wait for page load (5-60). Cloudflare has a 60s hard cap."
    },
    "waitUntil": {
      "type": "string",
      "enum": [
        "load",
        "domcontentloaded",
        "networkidle0",
        "networkidle2"
      ],
      "default": "networkidle2",
      "description": "Page readiness event. networkidle2 (default) is best for most sites. Use domcontentloaded for speed, networkidle0 for completeness."
    },
    "waitForSelector": {
      "type": "string",
      "maxLength": 500,
      "description": "CSS selector to wait for before capture. Essential for SPAs (e.g. '.main-content', '#app-loaded')"
    },
    "bestAttempt": {
      "type": "boolean",
      "default": true,
      "description": "If true (default), capture whatever is rendered on timeout instead of failing. Set to false to get a hard error on timeout."
    },
    "selector": {
      "type": "string",
      "maxLength": 500,
      "description": "CSS selector of a specific element to capture instead of the full page. Useful for OG images, component extraction (e.g. '#hero', '.pricing-card')"
    },
    "hideSelectors": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "maxItems": 50,
      "description": "CSS selectors to hide (display:none) before capture. E.g. ['.modal', '#newsletter-popup'] to remove overlays. Max 50 selectors."
    },
    "blockCookieBanners": {
      "type": "boolean",
      "description": "Hide common cookie/consent walls (GDPR/CCPA banners) before capture. A curated selector list, lighter than custom hideSelectors."
    },
    "resizeWidth": {
      "type": "integer",
      "minimum": 16,
      "maximum": 3840,
      "description": "Downscale the captured image to this width in pixels (16-3840). Aspect ratio is preserved if resizeHeight is omitted. Ignored for PDF."
    },
    "resizeHeight": {
      "type": "integer",
      "minimum": 16,
      "maximum": 2160,
      "description": "Downscale the captured image to this height in pixels (16-2160). Aspect ratio is preserved if resizeWidth is omitted. Ignored for PDF."
    },
    "css": {
      "type": "string",
      "maxLength": 51200,
      "description": "Custom CSS to inject into the page before capture. Hide cookie banners, add watermarks, override styles. Max 50KB."
    },
    "js": {
      "type": "string",
      "maxLength": 51200,
      "description": "Custom JavaScript to execute in the page before capture. Runs in the browser sandbox. Max 50KB."
    },
    "cookies": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "description": "Cookie name"
          },
          "value": {
            "type": "string",
            "description": "Cookie value"
          },
          "domain": {
            "type": "string",
            "description": "Cookie domain (must match target URL domain)"
          },
          "path": {
            "type": "string",
            "description": "Cookie path"
          },
          "httpOnly": {
            "type": "boolean",
            "description": "HTTP-only flag"
          },
          "secure": {
            "type": "boolean",
            "description": "Secure flag"
          },
          "sameSite": {
            "type": "string",
            "enum": [
              "Strict",
              "Lax",
              "None"
            ],
            "description": "SameSite attribute"
          },
          "expires": {
            "type": "number",
            "description": "Expiry as Unix timestamp"
          }
        },
        "required": [
          "name",
          "value"
        ],
        "additionalProperties": false
      },
      "maxItems": 50,
      "description": "Cookies to set before capture. Useful for authenticated pages. Max 50 cookies."
    },
    "headers": {
      "type": "object",
      "additionalProperties": {
        "type": "string"
      },
      "description": "Custom HTTP headers to send with the page request. Cannot override Host, Connection, Content-Length, or Transfer-Encoding."
    },
    "userAgent": {
      "type": "string",
      "maxLength": 512,
      "description": "Override the browser user agent string."
    },
    "pdfFormat": {
      "type": "string",
      "enum": [
        "A4",
        "Letter",
        "Legal",
        "Tabloid",
        "A3"
      ],
      "description": "PDF page size. Only used when format='pdf'. Default: A4"
    },
    "pdfLandscape": {
      "type": "boolean",
      "description": "PDF landscape orientation. Only used when format='pdf'."
    },
    "pdfPrintBackground": {
      "type": "boolean",
      "description": "Print background colors/images in PDF. Default: true"
    },
    "pdfScale": {
      "type": "number",
      "minimum": 0.1,
      "maximum": 2,
      "description": "PDF scale factor (0.1-2). Default: 1"
    },
    "pdfMargin": {
      "type": "object",
      "properties": {
        "top": {
          "type": "string",
          "description": "Top margin (CSS value, e.g. '1cm', '20px')"
        },
        "right": {
          "type": "string",
          "description": "Right margin"
        },
        "bottom": {
          "type": "string",
          "description": "Bottom margin"
        },
        "left": {
          "type": "string",
          "description": "Left margin"
        }
      },
      "additionalProperties": false,
      "description": "PDF page margins. Only used when format='pdf'. Accepts CSS values."
    },
    "data": {
      "type": "object",
      "additionalProperties": {},
      "description": "Key-value data object for Mustache templating. When provided, the 'html' or 'markdown' string is rendered as a logic-less Mustache template before capture — {{var}} inserts HTML-escaped, {{{var}}} inserts raw, {{#items}}...{{/items}} iterates arrays, {{a.b}} accesses nested fields. Not valid with 'url'. Max 256KB serialized."
    },
    "geo": {
      "type": "string",
      "minLength": 2,
      "maxLength": 2,
      "description": "ISO 3166-1 alpha-2 country code for geo-targeted capture (e.g., 'US', 'DE', 'JP'). Renders the page as seen from that country. Pro/Enterprise only. Note: CSS/JS injection, cookies, element capture, dark mode, and some other features are not available with geo-targeting."
    },
    "geoCity": {
      "type": "string",
      "maxLength": 100,
      "description": "City for more precise geo-targeting (e.g., 'Berlin', 'New York'). Requires 'geo'."
    },
    "geoState": {
      "type": "string",
      "maxLength": 100,
      "description": "State or region for more precise geo-targeting (e.g., 'California'). Requires 'geo'."
    }
  },
  "additionalProperties": false,
  "$schema": "http://json-schema.org/draft-07/schema#"
}

rendex_extract

Use this when the user asks to read, extract, get the text/content/article of, or summarize a webpage/URL. Do NOT use for a visual screenshot (use rendex_screenshot). Extracts clean reader-mode content from any webpage as Markdown, JSON, or HTML. Runs the same Chromium render pass as a screenshot, so it captures content after JavaScript runs — handles SPAs that fetch-only readers miss. Strips nav, ads, and boilerplate, returning the article body plus title, byline, and excerpt. Great for feeding page content to an LLM, summarization, or RAG ingestion. Costs 1 render credit per call.

Parameters8

url	string	required	The webpage URL to extract readable content from (a schemeless host like 'example.com' is accepted).
extractFormat	string	optional	Output shape — markdown (default, LLM-friendly prose), json (structured fields: title/byline/excerpt/siteName/length), or html (cleaned reader-mode HTML).
waitUntil	string	optional	Page readiness event. networkidle2 (default) is best for most sites. Use domcontentloaded for speed, networkidle0 for completeness.
timeout	integer	optional	Maximum seconds to wait for page load (5-60). Cloudflare has a 60s hard cap.
device	string	optional	Device preset that sets viewport, scale factor, and user agent in one shot. E.g. 'iphone_15' to extract the mobile version of a page.
blockAds	boolean	optional	Block ads and trackers before extraction
blockCookieBanners	boolean	optional	Hide common cookie/consent walls (GDPR/CCPA banners) before extraction. A curated selector list, lighter than custom hideSelectors.
hideSelectors	array	optional	CSS selectors to hide (display:none) before extraction. E.g. ['.modal', '#newsletter-popup'] to remove overlays. Max 50 selectors.

Raw schema

{
  "type": "object",
  "properties": {
    "url": {
      "type": "string",
      "format": "uri",
      "description": "The webpage URL to extract readable content from (a schemeless host like 'example.com' is accepted)."
    },
    "extractFormat": {
      "type": "string",
      "enum": [
        "markdown",
        "json",
        "html"
      ],
      "default": "markdown",
      "description": "Output shape — markdown (default, LLM-friendly prose), json (structured fields: title/byline/excerpt/siteName/length), or html (cleaned reader-mode HTML)."
    },
    "waitUntil": {
      "type": "string",
      "enum": [
        "load",
        "domcontentloaded",
        "networkidle0",
        "networkidle2"
      ],
      "default": "networkidle2",
      "description": "Page readiness event. networkidle2 (default) is best for most sites. Use domcontentloaded for speed, networkidle0 for completeness."
    },
    "timeout": {
      "type": "integer",
      "minimum": 5,
      "maximum": 60,
      "default": 30,
      "description": "Maximum seconds to wait for page load (5-60). Cloudflare has a 60s hard cap."
    },
    "device": {
      "type": "string",
      "enum": [
        "desktop",
        "iphone_15",
        "iphone_se",
        "pixel_8",
        "ipad",
        "ipad_pro"
      ],
      "description": "Device preset that sets viewport, scale factor, and user agent in one shot. E.g. 'iphone_15' to extract the mobile version of a page."
    },
    "blockAds": {
      "type": "boolean",
      "default": true,
      "description": "Block ads and trackers before extraction"
    },
    "blockCookieBanners": {
      "type": "boolean",
      "description": "Hide common cookie/consent walls (GDPR/CCPA banners) before extraction. A curated selector list, lighter than custom hideSelectors."
    },
    "hideSelectors": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "maxItems": 50,
      "description": "CSS selectors to hide (display:none) before extraction. E.g. ['.modal', '#newsletter-popup'] to remove overlays. Max 50 selectors."
    }
  },
  "required": [
    "url"
  ],
  "additionalProperties": false,
  "$schema": "http://json-schema.org/draft-07/schema#"
}

rendex_render_link

Use this when the user wants a reusable, HOSTED image URL — an og:image or a link to embed in an <img> tag — rather than the image bytes. Do NOT use for a one-off inline screenshot (use rendex_screenshot). Renders a URL, raw HTML, or Markdown and gives back a signed, hosted, edge-cached image URL instead of the bytes — ideal for dynamic OG images: drop the URL into <meta property="og:image"> or an <img> tag and Rendex serves a cached copy on every share. Takes the same options as rendex_screenshot, plus an optional expiresIn. Returns { url, expiresAt, format, cacheTtl } as JSON. Costs 1 render credit per fresh render; cached repeat hits don't re-charge.

Parameters38

url	string	optional	The webpage URL to capture (a schemeless host like 'example.com' is accepted). Mutually exclusive with 'html' and 'markdown'.
html	string	optional	Raw HTML to render and capture. Mutually exclusive with 'url' and 'markdown'. Great for invoices, social cards, email templates, OG images.
markdown	string	optional	Markdown to render to an image or PDF. Mutually exclusive with 'url' and 'html'. The server converts it to HTML before rendering. Great for reports, release notes, README snapshots, documentation cards.
format	string	optional	Output format — png (lossless), jpeg (smaller), webp (smallest), or pdf (document). Use pdf for invoices, reports, archival.
fullPage	boolean	optional	Capture the full scrollable page instead of just the viewport
darkMode	boolean	optional	Emulate dark color scheme (prefers-color-scheme: dark)
width	integer	optional	Viewport width in pixels (320-3840)
height	integer	optional	Viewport height in pixels (240-2160)
quality	integer	optional	Image quality 1-100 (JPEG/WebP only, ignored for PNG/PDF)
delay	integer	optional	Milliseconds to wait after page load before capture (useful for JS-rendered content)
blockAds	boolean	optional	Block ads and trackers before capture
blockResourceTypes	array	optional	Block specific resource types to speed up capture. E.g. ['font', 'image'] for text-only screenshots.
deviceScaleFactor	number	optional	Device pixel ratio (1 = standard, 2 = retina). Defaults to 2× Retina.
device	string	optional	Device preset that sets viewport, scale factor, and user agent in one shot. E.g. 'iphone_15' for a mobile screenshot. Overrides width/height/deviceScaleFactor/userAgent.
timeout	integer	optional	Maximum seconds to wait for page load (5-60). Cloudflare has a 60s hard cap.
waitUntil	string	optional	Page readiness event. networkidle2 (default) is best for most sites. Use domcontentloaded for speed, networkidle0 for completeness.
waitForSelector	string	optional	CSS selector to wait for before capture. Essential for SPAs (e.g. '.main-content', '#app-loaded')
bestAttempt	boolean	optional	If true (default), capture whatever is rendered on timeout instead of failing. Set to false to get a hard error on timeout.
selector	string	optional	CSS selector of a specific element to capture instead of the full page. Useful for OG images, component extraction (e.g. '#hero', '.pricing-card')
hideSelectors	array	optional	CSS selectors to hide (display:none) before capture. E.g. ['.modal', '#newsletter-popup'] to remove overlays. Max 50 selectors.
blockCookieBanners	boolean	optional	Hide common cookie/consent walls (GDPR/CCPA banners) before capture. A curated selector list, lighter than custom hideSelectors.
resizeWidth	integer	optional	Downscale the captured image to this width in pixels (16-3840). Aspect ratio is preserved if resizeHeight is omitted. Ignored for PDF.
resizeHeight	integer	optional	Downscale the captured image to this height in pixels (16-2160). Aspect ratio is preserved if resizeWidth is omitted. Ignored for PDF.
css	string	optional	Custom CSS to inject into the page before capture. Hide cookie banners, add watermarks, override styles. Max 50KB.
js	string	optional	Custom JavaScript to execute in the page before capture. Runs in the browser sandbox. Max 50KB.
cookies	array	optional	Cookies to set before capture. Useful for authenticated pages. Max 50 cookies.
headers	object	optional	Custom HTTP headers to send with the page request. Cannot override Host, Connection, Content-Length, or Transfer-Encoding.
userAgent	string	optional	Override the browser user agent string.
pdfFormat	string	optional	PDF page size. Only used when format='pdf'. Default: A4
pdfLandscape	boolean	optional	PDF landscape orientation. Only used when format='pdf'.
pdfPrintBackground	boolean	optional	Print background colors/images in PDF. Default: true
pdfScale	number	optional	PDF scale factor (0.1-2). Default: 1
pdfMargin	object	optional	PDF page margins. Only used when format='pdf'. Accepts CSS values.
data	object	optional	Key-value data object for Mustache templating. When provided, the 'html' or 'markdown' string is rendered as a logic-less Mustache template before capture — {{var}} inserts HTML-escaped, {{{var}}} inserts raw, {{#items}}...{{/items}} iterates arrays, {{a.b}} accesses nested fields. Not valid with 'url'. Max 256KB serialized.
geo	string	optional	ISO 3166-1 alpha-2 country code for geo-targeted capture (e.g., 'US', 'DE', 'JP'). Renders the page as seen from that country. Pro/Enterprise only. Note: CSS/JS injection, cookies, element capture, dark mode, and some other features are not available with geo-targeting.
geoCity	string	optional	City for more precise geo-targeting (e.g., 'Berlin', 'New York'). Requires 'geo'.
geoState	string	optional	State or region for more precise geo-targeting (e.g., 'California'). Requires 'geo'.
expiresIn	integer	optional	Seconds until the signed URL expires (60–2592000). Defaults to the server's TTL.

Raw schema

{
  "type": "object",
  "properties": {
    "url": {
      "type": "string",
      "format": "uri",
      "description": "The webpage URL to capture (a schemeless host like 'example.com' is accepted). Mutually exclusive with 'html' and 'markdown'."
    },
    "html": {
      "type": "string",
      "maxLength": 5242880,
      "description": "Raw HTML to render and capture. Mutually exclusive with 'url' and 'markdown'. Great for invoices, social cards, email templates, OG images."
    },
    "markdown": {
      "type": "string",
      "maxLength": 5242880,
      "description": "Markdown to render to an image or PDF. Mutually exclusive with 'url' and 'html'. The server converts it to HTML before rendering. Great for reports, release notes, README snapshots, documentation cards."
    },
    "format": {
      "type": "string",
      "enum": [
        "png",
        "jpeg",
        "webp",
        "pdf"
      ],
      "default": "png",
      "description": "Output format — png (lossless), jpeg (smaller), webp (smallest), or pdf (document). Use pdf for invoices, reports, archival."
    },
    "fullPage": {
      "type": "boolean",
      "default": false,
      "description": "Capture the full scrollable page instead of just the viewport"
    },
    "darkMode": {
      "type": "boolean",
      "default": false,
      "description": "Emulate dark color scheme (prefers-color-scheme: dark)"
    },
    "width": {
      "type": "integer",
      "minimum": 320,
      "maximum": 3840,
      "default": 1280,
      "description": "Viewport width in pixels (320-3840)"
    },
    "height": {
      "type": "integer",
      "minimum": 240,
      "maximum": 2160,
      "default": 800,
      "description": "Viewport height in pixels (240-2160)"
    },
    "quality": {
      "type": "integer",
      "minimum": 1,
      "maximum": 100,
      "description": "Image quality 1-100 (JPEG/WebP only, ignored for PNG/PDF)"
    },
    "delay": {
      "type": "integer",
      "minimum": 0,
      "maximum": 10000,
      "default": 0,
      "description": "Milliseconds to wait after page load before capture (useful for JS-rendered content)"
    },
    "blockAds": {
      "type": "boolean",
      "default": true,
      "description": "Block ads and trackers before capture"
    },
    "blockResourceTypes": {
      "type": "array",
      "items": {
        "type": "string",
        "enum": [
          "font",
          "image",
          "media",
          "stylesheet",
          "other"
        ]
      },
      "description": "Block specific resource types to speed up capture. E.g. ['font', 'image'] for text-only screenshots."
    },
    "deviceScaleFactor": {
      "type": "number",
      "minimum": 1,
      "maximum": 3,
      "default": 2,
      "description": "Device pixel ratio (1 = standard, 2 = retina). Defaults to 2× Retina."
    },
    "device": {
      "type": "string",
      "enum": [
        "desktop",
        "iphone_15",
        "iphone_se",
        "pixel_8",
        "ipad",
        "ipad_pro"
      ],
      "description": "Device preset that sets viewport, scale factor, and user agent in one shot. E.g. 'iphone_15' for a mobile screenshot. Overrides width/height/deviceScaleFactor/userAgent."
    },
    "timeout": {
      "type": "integer",
      "minimum": 5,
      "maximum": 60,
      "default": 30,
      "description": "Maximum seconds to wait for page load (5-60). Cloudflare has a 60s hard cap."
    },
    "waitUntil": {
      "type": "string",
      "enum": [
        "load",
        "domcontentloaded",
        "networkidle0",
        "networkidle2"
      ],
      "default": "networkidle2",
      "description": "Page readiness event. networkidle2 (default) is best for most sites. Use domcontentloaded for speed, networkidle0 for completeness."
    },
    "waitForSelector": {
      "type": "string",
      "maxLength": 500,
      "description": "CSS selector to wait for before capture. Essential for SPAs (e.g. '.main-content', '#app-loaded')"
    },
    "bestAttempt": {
      "type": "boolean",
      "default": true,
      "description": "If true (default), capture whatever is rendered on timeout instead of failing. Set to false to get a hard error on timeout."
    },
    "selector": {
      "type": "string",
      "maxLength": 500,
      "description": "CSS selector of a specific element to capture instead of the full page. Useful for OG images, component extraction (e.g. '#hero', '.pricing-card')"
    },
    "hideSelectors": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "maxItems": 50,
      "description": "CSS selectors to hide (display:none) before capture. E.g. ['.modal', '#newsletter-popup'] to remove overlays. Max 50 selectors."
    },
    "blockCookieBanners": {
      "type": "boolean",
      "description": "Hide common cookie/consent walls (GDPR/CCPA banners) before capture. A curated selector list, lighter than custom hideSelectors."
    },
    "resizeWidth": {
      "type": "integer",
      "minimum": 16,
      "maximum": 3840,
      "description": "Downscale the captured image to this width in pixels (16-3840). Aspect ratio is preserved if resizeHeight is omitted. Ignored for PDF."
    },
    "resizeHeight": {
      "type": "integer",
      "minimum": 16,
      "maximum": 2160,
      "description": "Downscale the captured image to this height in pixels (16-2160). Aspect ratio is preserved if resizeWidth is omitted. Ignored for PDF."
    },
    "css": {
      "type": "string",
      "maxLength": 51200,
      "description": "Custom CSS to inject into the page before capture. Hide cookie banners, add watermarks, override styles. Max 50KB."
    },
    "js": {
      "type": "string",
      "maxLength": 51200,
      "description": "Custom JavaScript to execute in the page before capture. Runs in the browser sandbox. Max 50KB."
    },
    "cookies": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "description": "Cookie name"
          },
          "value": {
            "type": "string",
            "description": "Cookie value"
          },
          "domain": {
            "type": "string",
            "description": "Cookie domain (must match target URL domain)"
          },
          "path": {
            "type": "string",
            "description": "Cookie path"
          },
          "httpOnly": {
            "type": "boolean",
            "description": "HTTP-only flag"
          },
          "secure": {
            "type": "boolean",
            "description": "Secure flag"
          },
          "sameSite": {
            "type": "string",
            "enum": [
              "Strict",
              "Lax",
              "None"
            ],
            "description": "SameSite attribute"
          },
          "expires": {
            "type": "number",
            "description": "Expiry as Unix timestamp"
          }
        },
        "required": [
          "name",
          "value"
        ],
        "additionalProperties": false
      },
      "maxItems": 50,
      "description": "Cookies to set before capture. Useful for authenticated pages. Max 50 cookies."
    },
    "headers": {
      "type": "object",
      "additionalProperties": {
        "type": "string"
      },
      "description": "Custom HTTP headers to send with the page request. Cannot override Host, Connection, Content-Length, or Transfer-Encoding."
    },
    "userAgent": {
      "type": "string",
      "maxLength": 512,
      "description": "Override the browser user agent string."
    },
    "pdfFormat": {
      "type": "string",
      "enum": [
        "A4",
        "Letter",
        "Legal",
        "Tabloid",
        "A3"
      ],
      "description": "PDF page size. Only used when format='pdf'. Default: A4"
    },
    "pdfLandscape": {
      "type": "boolean",
      "description": "PDF landscape orientation. Only used when format='pdf'."
    },
    "pdfPrintBackground": {
      "type": "boolean",
      "description": "Print background colors/images in PDF. Default: true"
    },
    "pdfScale": {
      "type": "number",
      "minimum": 0.1,
      "maximum": 2,
      "description": "PDF scale factor (0.1-2). Default: 1"
    },
    "pdfMargin": {
      "type": "object",
      "properties": {
        "top": {
          "type": "string",
          "description": "Top margin (CSS value, e.g. '1cm', '20px')"
        },
        "right": {
          "type": "string",
          "description": "Right margin"
        },
        "bottom": {
          "type": "string",
          "description": "Bottom margin"
        },
        "left": {
          "type": "string",
          "description": "Left margin"
        }
      },
      "additionalProperties": false,
      "description": "PDF page margins. Only used when format='pdf'. Accepts CSS values."
    },
    "data": {
      "type": "object",
      "additionalProperties": {},
      "description": "Key-value data object for Mustache templating. When provided, the 'html' or 'markdown' string is rendered as a logic-less Mustache template before capture — {{var}} inserts HTML-escaped, {{{var}}} inserts raw, {{#items}}...{{/items}} iterates arrays, {{a.b}} accesses nested fields. Not valid with 'url'. Max 256KB serialized."
    },
    "geo": {
      "type": "string",
      "minLength": 2,
      "maxLength": 2,
      "description": "ISO 3166-1 alpha-2 country code for geo-targeted capture (e.g., 'US', 'DE', 'JP'). Renders the page as seen from that country. Pro/Enterprise only. Note: CSS/JS injection, cookies, element capture, dark mode, and some other features are not available with geo-targeting."
    },
    "geoCity": {
      "type": "string",
      "maxLength": 100,
      "description": "City for more precise geo-targeting (e.g., 'Berlin', 'New York'). Requires 'geo'."
    },
    "geoState": {
      "type": "string",
      "maxLength": 100,
      "description": "State or region for more precise geo-targeting (e.g., 'California'). Requires 'geo'."
    },
    "expiresIn": {
      "type": "integer",
      "minimum": 60,
      "maximum": 2592000,
      "description": "Seconds until the signed URL expires (60–2592000). Defaults to the server's TTL."
    }
  },
  "additionalProperties": false,
  "$schema": "http://json-schema.org/draft-07/schema#"
}

render_artifact

Use this when the user asks to make or create a branded report, invoice, summary, release notes, or document — or to 'turn this Markdown/HTML into a PDF and PNG' (optionally with a logo or accent color). Do NOT use to screenshot an existing URL (use rendex_screenshot). Turns Markdown or HTML into a branded, downloadable artifact — a PDF, a PNG, and a hosted share page — in one call. Apply a logo, accentColor, font, header, and footer. Returns hosted URLs { pdfUrl, pngUrl, shareUrl, expiresAt }. Each requested format costs 1 render credit.

Parameters11

content	string	required	The Markdown or HTML body to render (up to ~4MB).
inputFormat	string	optional	How to interpret content. 'markdown' is converted to styled HTML; 'html' is used as a body fragment.
formats	array	optional	Which formats to produce. Each costs 1 credit. Default both.
accentColor	string	optional	CSS accent color for the bar, links, and headings (e.g. '#EA580C').
logo	string	optional	Absolute http(s) URL of a logo image shown in the header.
header	string	optional	Plain-text header line shown beside the logo.
footer	string	optional	Plain-text footer line shown at the bottom.
font	string	optional	CSS font-family stack for the body (e.g. 'Georgia, serif').
pageSetup	object	optional	Optional paper/viewport setup.
data	object	optional	Optional Mustache data. When present, content is rendered as a logic-less Mustache template (plus the branding fields as {{logo}}/{{header}}/...) before conversion.
expiresIn	integer	optional	Seconds until the hosted URLs expire (3600-2592000). Default 86400 (24h).

Raw schema

{
  "type": "object",
  "properties": {
    "content": {
      "type": "string",
      "minLength": 1,
      "maxLength": 4000000,
      "description": "The Markdown or HTML body to render (up to ~4MB)."
    },
    "inputFormat": {
      "type": "string",
      "enum": [
        "markdown",
        "html"
      ],
      "default": "markdown",
      "description": "How to interpret content. 'markdown' is converted to styled HTML; 'html' is used as a body fragment."
    },
    "formats": {
      "type": "array",
      "items": {
        "type": "string",
        "enum": [
          "pdf",
          "png"
        ]
      },
      "minItems": 1,
      "maxItems": 2,
      "default": [
        "pdf",
        "png"
      ],
      "description": "Which formats to produce. Each costs 1 credit. Default both."
    },
    "accentColor": {
      "type": "string",
      "maxLength": 64,
      "description": "CSS accent color for the bar, links, and headings (e.g. '#EA580C')."
    },
    "logo": {
      "type": "string",
      "format": "uri",
      "maxLength": 2048,
      "description": "Absolute http(s) URL of a logo image shown in the header."
    },
    "header": {
      "type": "string",
      "maxLength": 2000,
      "description": "Plain-text header line shown beside the logo."
    },
    "footer": {
      "type": "string",
      "maxLength": 2000,
      "description": "Plain-text footer line shown at the bottom."
    },
    "font": {
      "type": "string",
      "maxLength": 120,
      "description": "CSS font-family stack for the body (e.g. 'Georgia, serif')."
    },
    "pageSetup": {
      "type": "object",
      "properties": {
        "size": {
          "type": "string",
          "enum": [
            "A4",
            "Letter",
            "Legal",
            "Tabloid",
            "A3"
          ],
          "description": "PDF paper size. Default A4."
        },
        "orientation": {
          "type": "string",
          "enum": [
            "portrait",
            "landscape"
          ],
          "description": "PDF orientation. Default portrait."
        },
        "margin": {
          "type": "object",
          "properties": {
            "top": {
              "type": "string",
              "maxLength": 16
            },
            "right": {
              "type": "string",
              "maxLength": 16
            },
            "bottom": {
              "type": "string",
              "maxLength": 16
            },
            "left": {
              "type": "string",
              "maxLength": 16
            }
          },
          "additionalProperties": false,
          "description": "PDF margins as CSS values (e.g. '1cm')."
        },
        "scale": {
          "type": "number",
          "minimum": 0.1,
          "maximum": 2,
          "description": "PDF render scale (0.1-2). Default 1."
        },
        "width": {
          "type": "integer",
          "minimum": 320,
          "maximum": 3840,
          "description": "PNG viewport width in px. Default 1280."
        },
        "height": {
          "type": "integer",
          "minimum": 240,
          "maximum": 2160,
          "description": "PNG viewport height in px. Default 800."
        },
        "fullPage": {
          "type": "boolean",
          "description": "Capture the full scrollable page for the PNG. Default true."
        }
      },
      "additionalProperties": false,
      "description": "Optional paper/viewport setup."
    },
    "data": {
      "type": "object",
      "additionalProperties": {},
      "description": "Optional Mustache data. When present, content is rendered as a logic-less Mustache template (plus the branding fields as {{logo}}/{{header}}/...) before conversion."
    },
    "expiresIn": {
      "type": "integer",
      "minimum": 3600,
      "maximum": 2592000,
      "description": "Seconds until the hosted URLs expire (3600-2592000). Default 86400 (24h)."
    }
  },
  "required": [
    "content"
  ],
  "additionalProperties": false,
  "$schema": "http://json-schema.org/draft-07/schema#"
}

rendex_account

Check the Rendex account: which plan it's on, how many render credits have been used vs. the monthly limit (and when it resets), the per-minute rate limit, and a one-tap link to upgrade to a higher tier. Use this whenever the user asks about their usage, remaining quota, current plan, or how to get more renders / stop hitting limits. Read-only — costs no credits.

Parameters

No parameters.

Raw schema

{
  "type": "object",
  "properties": {},
  "$schema": "http://json-schema.org/draft-07/schema#"
}

watch_create

Use this when the user asks to monitor, watch, or track a webpage for changes, or to be alerted/notified when a page changes. Do NOT use for a one-time capture (use rendex_screenshot). Creates a Rendex Watch — monitors a URL on a schedule and notifies when it changes (real-Chrome visual diff with a highlighted overlay, an extracted-text diff, or both). An active watch captures its baseline immediately. Returns the created watch as JSON.

Parameters10

url	string	required	The page to monitor (a schemeless host like 'rendex.dev/pricing' is upgraded to https).
name	string	optional	Optional label for the watch.
intervalMinutes	integer	optional	Check frequency in minutes. Minimum is your plan's floor — Free 1440 (daily), Basic 180, Starter 180, Pro 30, Enterprise 5.
diffMode	string	optional	How changes are detected. Default 'both' = a pixel diff (with a highlighted overlay) AND a FULL-PAGE text diff, alerting on either — catches any change, visual or text. 'visual' or 'text' narrow to one signal only.
threshold	number	optional	Visual sensitivity (0..1). Low (default 0.01) alerts on ANY change, including a small one on a long page (a changed-region test, not a whole-page pixel ratio). 0.06+ = only MAJOR visual changes (whole-page ratio). Text detection is unaffected.
renderParams	object	optional	Render knobs applied on every check (a subset of the screenshot capture params).
aiSummary	boolean	optional	Pro+ — attach a one-sentence AI 'what changed' summary to each detected change.
webhookUrl	string	optional	Starter+ — HMAC-signed change-webhook target.
notifyEmail	string	optional	Any plan — send change alerts here. Must be your OWN account email (others are rejected). Defaults to it if omitted.
paused	boolean	optional	Create the watch paused (no baseline capture or charge until resumed).

Raw schema

{
  "type": "object",
  "properties": {
    "url": {
      "type": "string",
      "format": "uri",
      "description": "The page to monitor (a schemeless host like 'rendex.dev/pricing' is upgraded to https)."
    },
    "name": {
      "type": "string",
      "maxLength": 120,
      "description": "Optional label for the watch."
    },
    "intervalMinutes": {
      "type": "integer",
      "minimum": 5,
      "maximum": 43200,
      "default": 1440,
      "description": "Check frequency in minutes. Minimum is your plan's floor — Free 1440 (daily), Basic 180, Starter 180, Pro 30, Enterprise 5."
    },
    "diffMode": {
      "type": "string",
      "enum": [
        "visual",
        "text",
        "both"
      ],
      "default": "both",
      "description": "How changes are detected. Default 'both' = a pixel diff (with a highlighted overlay) AND a FULL-PAGE text diff, alerting on either — catches any change, visual or text. 'visual' or 'text' narrow to one signal only."
    },
    "threshold": {
      "type": "number",
      "minimum": 0,
      "maximum": 1,
      "default": 0.01,
      "description": "Visual sensitivity (0..1). Low (default 0.01) alerts on ANY change, including a small one on a long page (a changed-region test, not a whole-page pixel ratio). 0.06+ = only MAJOR visual changes (whole-page ratio). Text detection is unaffected."
    },
    "renderParams": {
      "type": "object",
      "properties": {
        "format": {
          "type": "string",
          "enum": [
            "png",
            "jpeg",
            "webp",
            "pdf"
          ],
          "description": "Capture format. A pdf cannot be visually diffed — pair it with diffMode 'text'. Default png."
        },
        "width": {
          "type": "integer",
          "minimum": 320,
          "maximum": 3840,
          "description": "Viewport width in px (320–3840)."
        },
        "height": {
          "type": "integer",
          "minimum": 240,
          "maximum": 2160,
          "description": "Viewport height in px (240–2160)."
        },
        "fullPage": {
          "type": "boolean",
          "default": true,
          "description": "Monitor the whole scrollable page (default true for watches). Set false to watch only the viewport."
        },
        "device": {
          "type": "string",
          "enum": [
            "desktop",
            "iphone_15",
            "iphone_se",
            "pixel_8",
            "ipad",
            "ipad_pro"
          ],
          "description": "Device preset (viewport + scale + UA). E.g. 'iphone_15' to monitor the mobile layout."
        },
        "deviceScaleFactor": {
          "type": "number",
          "minimum": 1,
          "maximum": 3,
          "description": "Device pixel ratio (1–3)."
        },
        "darkMode": {
          "type": "boolean",
          "description": "Emulate prefers-color-scheme: dark."
        },
        "blockAds": {
          "type": "boolean",
          "description": "Block ads/trackers before capture (default true)."
        },
        "blockCookieBanners": {
          "type": "boolean",
          "description": "Hide common cookie/consent banners before capture."
        },
        "hideSelectors": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "maxItems": 50,
          "description": "CSS selectors to hide before capture (max 50)."
        },
        "waitUntil": {
          "type": "string",
          "enum": [
            "load",
            "domcontentloaded",
            "networkidle0",
            "networkidle2"
          ],
          "description": "Navigation readiness event."
        },
        "delay": {
          "type": "integer",
          "minimum": 0,
          "maximum": 10000,
          "description": "Delay in ms before capture (0–10000)."
        },
        "timeout": {
          "type": "integer",
          "minimum": 5,
          "maximum": 60,
          "description": "Page-load timeout in seconds (5–60)."
        },
        "geo": {
          "type": "string",
          "description": "Pro+ — ISO country code to render from. VISUAL-ONLY: cannot combine with a 'text' OR 'both' diffMode (a geo render returns no extracted text)."
        },
        "geoCity": {
          "type": "string",
          "description": "City for more precise geo-targeting (requires geo)."
        },
        "geoState": {
          "type": "string",
          "description": "State/region for geo-targeting (requires geo)."
        },
        "selector": {
          "type": "string",
          "maxLength": 500,
          "description": "Capture and diff ONLY this CSS element — watch one price/banner/section instead of the whole page."
        },
        "ignoreRegions": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "x": {
                "type": "number",
                "minimum": 0
              },
              "y": {
                "type": "number",
                "minimum": 0
              },
              "width": {
                "type": "number",
                "exclusiveMinimum": 0
              },
              "height": {
                "type": "number",
                "exclusiveMinimum": 0
              }
            },
            "required": [
              "x",
              "y",
              "width",
              "height"
            ],
            "additionalProperties": false
          },
          "maxItems": 20,
          "description": "Pixel rectangles masked in both captures before the visual diff — silence dynamic zones (ad slot, clock). Visual mode only."
        },
        "ignoreText": {
          "type": "array",
          "items": {
            "type": "string",
            "maxLength": 500
          },
          "maxItems": 50,
          "description": "Substrings or /regex/flags stripped from both texts before the text diff — silence timestamps, counters, tokens."
        },
        "minTextChars": {
          "type": "integer",
          "minimum": 0,
          "maximum": 100000,
          "description": "Minimum added + removed characters for a text change to count (ignore tiny edits)."
        },
        "suppressWhilePresent": {
          "type": "array",
          "items": {
            "type": "string",
            "maxLength": 500
          },
          "maxItems": 20,
          "description": "While the page text contains any of these markers (e.g. 'Out of stock'), treat the run as unchanged."
        },
        "uaMode": {
          "type": "string",
          "enum": [
            "auto",
            "identify",
            "stealth"
          ],
          "description": "User-Agent identity: auto (identify then fall back), identify (always RendexWatch), stealth (always a standard browser). See https://rendex.dev/bot"
        }
      },
      "additionalProperties": false,
      "description": "Render knobs applied on every check (a subset of the screenshot capture params)."
    },
    "aiSummary": {
      "type": "boolean",
      "default": false,
      "description": "Pro+ — attach a one-sentence AI 'what changed' summary to each detected change."
    },
    "webhookUrl": {
      "type": "string",
      "format": "uri",
      "description": "Starter+ — HMAC-signed change-webhook target."
    },
    "notifyEmail": {
      "type": "string",
      "format": "email",
      "description": "Any plan — send change alerts here. Must be your OWN account email (others are rejected). Defaults to it if omitted."
    },
    "paused": {
      "type": "boolean",
      "default": false,
      "description": "Create the watch paused (no baseline capture or charge until resumed)."
    }
  },
  "required": [
    "url"
  ],
  "additionalProperties": false,
  "$schema": "http://json-schema.org/draft-07/schema#"
}

watch_test

Dry-run a watch config BEFORE creating it — render the proposed config once and report what was captured + whether the page is reachable (and the text a text-watch would compare). Creates no watch, no baseline, no diff. Use this to validate a selector/scope/identity first. Returns JSON.

Parameters10

url	string	required	The page to monitor (a schemeless host like 'rendex.dev/pricing' is upgraded to https).
name	string	optional	Optional label for the watch.
intervalMinutes	integer	optional	Check frequency in minutes. Minimum is your plan's floor — Free 1440 (daily), Basic 180, Starter 180, Pro 30, Enterprise 5.
diffMode	string	optional	How changes are detected. Default 'both' = a pixel diff (with a highlighted overlay) AND a FULL-PAGE text diff, alerting on either — catches any change, visual or text. 'visual' or 'text' narrow to one signal only.
threshold	number	optional	Visual sensitivity (0..1). Low (default 0.01) alerts on ANY change, including a small one on a long page (a changed-region test, not a whole-page pixel ratio). 0.06+ = only MAJOR visual changes (whole-page ratio). Text detection is unaffected.
renderParams	object	optional	Render knobs applied on every check (a subset of the screenshot capture params).
aiSummary	boolean	optional	Pro+ — attach a one-sentence AI 'what changed' summary to each detected change.
webhookUrl	string	optional	Starter+ — HMAC-signed change-webhook target.
notifyEmail	string	optional	Any plan — send change alerts here. Must be your OWN account email (others are rejected). Defaults to it if omitted.
paused	boolean	optional	Create the watch paused (no baseline capture or charge until resumed).

Raw schema

{
  "type": "object",
  "properties": {
    "url": {
      "type": "string",
      "format": "uri",
      "description": "The page to monitor (a schemeless host like 'rendex.dev/pricing' is upgraded to https)."
    },
    "name": {
      "type": "string",
      "maxLength": 120,
      "description": "Optional label for the watch."
    },
    "intervalMinutes": {
      "type": "integer",
      "minimum": 5,
      "maximum": 43200,
      "default": 1440,
      "description": "Check frequency in minutes. Minimum is your plan's floor — Free 1440 (daily), Basic 180, Starter 180, Pro 30, Enterprise 5."
    },
    "diffMode": {
      "type": "string",
      "enum": [
        "visual",
        "text",
        "both"
      ],
      "default": "both",
      "description": "How changes are detected. Default 'both' = a pixel diff (with a highlighted overlay) AND a FULL-PAGE text diff, alerting on either — catches any change, visual or text. 'visual' or 'text' narrow to one signal only."
    },
    "threshold": {
      "type": "number",
      "minimum": 0,
      "maximum": 1,
      "default": 0.01,
      "description": "Visual sensitivity (0..1). Low (default 0.01) alerts on ANY change, including a small one on a long page (a changed-region test, not a whole-page pixel ratio). 0.06+ = only MAJOR visual changes (whole-page ratio). Text detection is unaffected."
    },
    "renderParams": {
      "type": "object",
      "properties": {
        "format": {
          "type": "string",
          "enum": [
            "png",
            "jpeg",
            "webp",
            "pdf"
          ],
          "description": "Capture format. A pdf cannot be visually diffed — pair it with diffMode 'text'. Default png."
        },
        "width": {
          "type": "integer",
          "minimum": 320,
          "maximum": 3840,
          "description": "Viewport width in px (320–3840)."
        },
        "height": {
          "type": "integer",
          "minimum": 240,
          "maximum": 2160,
          "description": "Viewport height in px (240–2160)."
        },
        "fullPage": {
          "type": "boolean",
          "default": true,
          "description": "Monitor the whole scrollable page (default true for watches). Set false to watch only the viewport."
        },
        "device": {
          "type": "string",
          "enum": [
            "desktop",
            "iphone_15",
            "iphone_se",
            "pixel_8",
            "ipad",
            "ipad_pro"
          ],
          "description": "Device preset (viewport + scale + UA). E.g. 'iphone_15' to monitor the mobile layout."
        },
        "deviceScaleFactor": {
          "type": "number",
          "minimum": 1,
          "maximum": 3,
          "description": "Device pixel ratio (1–3)."
        },
        "darkMode": {
          "type": "boolean",
          "description": "Emulate prefers-color-scheme: dark."
        },
        "blockAds": {
          "type": "boolean",
          "description": "Block ads/trackers before capture (default true)."
        },
        "blockCookieBanners": {
          "type": "boolean",
          "description": "Hide common cookie/consent banners before capture."
        },
        "hideSelectors": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "maxItems": 50,
          "description": "CSS selectors to hide before capture (max 50)."
        },
        "waitUntil": {
          "type": "string",
          "enum": [
            "load",
            "domcontentloaded",
            "networkidle0",
            "networkidle2"
          ],
          "description": "Navigation readiness event."
        },
        "delay": {
          "type": "integer",
          "minimum": 0,
          "maximum": 10000,
          "description": "Delay in ms before capture (0–10000)."
        },
        "timeout": {
          "type": "integer",
          "minimum": 5,
          "maximum": 60,
          "description": "Page-load timeout in seconds (5–60)."
        },
        "geo": {
          "type": "string",
          "description": "Pro+ — ISO country code to render from. VISUAL-ONLY: cannot combine with a 'text' OR 'both' diffMode (a geo render returns no extracted text)."
        },
        "geoCity": {
          "type": "string",
          "description": "City for more precise geo-targeting (requires geo)."
        },
        "geoState": {
          "type": "string",
          "description": "State/region for geo-targeting (requires geo)."
        },
        "selector": {
          "type": "string",
          "maxLength": 500,
          "description": "Capture and diff ONLY this CSS element — watch one price/banner/section instead of the whole page."
        },
        "ignoreRegions": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "x": {
                "type": "number",
                "minimum": 0
              },
              "y": {
                "type": "number",
                "minimum": 0
              },
              "width": {
                "type": "number",
                "exclusiveMinimum": 0
              },
              "height": {
                "type": "number",
                "exclusiveMinimum": 0
              }
            },
            "required": [
              "x",
              "y",
              "width",
              "height"
            ],
            "additionalProperties": false
          },
          "maxItems": 20,
          "description": "Pixel rectangles masked in both captures before the visual diff — silence dynamic zones (ad slot, clock). Visual mode only."
        },
        "ignoreText": {
          "type": "array",
          "items": {
            "type": "string",
            "maxLength": 500
          },
          "maxItems": 50,
          "description": "Substrings or /regex/flags stripped from both texts before the text diff — silence timestamps, counters, tokens."
        },
        "minTextChars": {
          "type": "integer",
          "minimum": 0,
          "maximum": 100000,
          "description": "Minimum added + removed characters for a text change to count (ignore tiny edits)."
        },
        "suppressWhilePresent": {
          "type": "array",
          "items": {
            "type": "string",
            "maxLength": 500
          },
          "maxItems": 20,
          "description": "While the page text contains any of these markers (e.g. 'Out of stock'), treat the run as unchanged."
        },
        "uaMode": {
          "type": "string",
          "enum": [
            "auto",
            "identify",
            "stealth"
          ],
          "description": "User-Agent identity: auto (identify then fall back), identify (always RendexWatch), stealth (always a standard browser). See https://rendex.dev/bot"
        }
      },
      "additionalProperties": false,
      "description": "Render knobs applied on every check (a subset of the screenshot capture params)."
    },
    "aiSummary": {
      "type": "boolean",
      "default": false,
      "description": "Pro+ — attach a one-sentence AI 'what changed' summary to each detected change."
    },
    "webhookUrl": {
      "type": "string",
      "format": "uri",
      "description": "Starter+ — HMAC-signed change-webhook target."
    },
    "notifyEmail": {
      "type": "string",
      "format": "email",
      "description": "Any plan — send change alerts here. Must be your OWN account email (others are rejected). Defaults to it if omitted."
    },
    "paused": {
      "type": "boolean",
      "default": false,
      "description": "Create the watch paused (no baseline capture or charge until resumed)."
    }
  },
  "required": [
    "url"
  ],
  "additionalProperties": false,
  "$schema": "http://json-schema.org/draft-07/schema#"
}

watch_list

List your watches (newest first), optionally filtered by status and paged. Returns { items, nextCursor }.

Parameters3

status	string	optional	Filter by status.
cursor	string	optional	Pagination cursor from a previous nextCursor.
limit	integer	optional	Page size (1–100).

Raw schema

{
  "type": "object",
  "properties": {
    "status": {
      "type": "string",
      "enum": [
        "active",
        "paused",
        "all"
      ],
      "default": "all",
      "description": "Filter by status."
    },
    "cursor": {
      "type": "string",
      "description": "Pagination cursor from a previous nextCursor."
    },
    "limit": {
      "type": "integer",
      "minimum": 1,
      "maximum": 100,
      "default": 20,
      "description": "Page size (1–100)."
    }
  },
  "additionalProperties": false,
  "$schema": "http://json-schema.org/draft-07/schema#"
}

watch_get

Fetch one watch by ID, including its current baseline image URL and status. Returns JSON.

Parameters1

string

required

The watch ID (UUID).

Raw schema

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "The watch ID (UUID)."
    }
  },
  "required": [
    "id"
  ],
  "additionalProperties": false,
  "$schema": "http://json-schema.org/draft-07/schema#"
}

watch_run

Run an immediate check now (charges 1 credit). Returns the queued run; poll watch_runs for the result or receive a watch.changed webhook.

Parameters1

string

required

The watch ID (UUID).

Raw schema

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "The watch ID (UUID)."
    }
  },
  "required": [
    "id"
  ],
  "additionalProperties": false,
  "$schema": "http://json-schema.org/draft-07/schema#"
}

watch_runs

Read a watch's run history (newest first), paged. Each run includes changed, diffScore, and signed before/after/overlay image URLs. Returns { items, nextCursor }.

Parameters3

id	string	required	The watch ID (UUID).
cursor	string	optional	Pagination cursor from a previous nextCursor.
limit	integer	optional	Page size (1–100).

Raw schema

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "The watch ID (UUID)."
    },
    "cursor": {
      "type": "string",
      "description": "Pagination cursor from a previous nextCursor."
    },
    "limit": {
      "type": "integer",
      "minimum": 1,
      "maximum": 100,
      "default": 20,
      "description": "Page size (1–100)."
    }
  },
  "required": [
    "id"
  ],
  "additionalProperties": false,
  "$schema": "http://json-schema.org/draft-07/schema#"
}

watch_delete

Delete a watch and its run history. Irreversible.

Parameters1

string

required

The watch ID (UUID).

Raw schema

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "The watch ID (UUID)."
    }
  },
  "required": [
    "id"
  ],
  "additionalProperties": false,
  "$schema": "http://json-schema.org/draft-07/schema#"
}

watch_update

Update a watch in place — pause/resume (paused), re-point (url), change schedule/diff/notify settings, or turn a channel off (webhookUrl/notifyEmail = null). Only the fields you send change; renderParams is deep-merged over the existing config. A scope change (url/selector/fullPage/size/device) re-baselines on the next check. Returns the updated watch as JSON.

Parameters11

id	string	required	The watch ID (UUID) to update.
url	string	optional	Re-point to a new URL (clears the baseline; the next check re-baselines).
name	any	optional	Rename the watch (null to clear).
intervalMinutes	integer	optional	New check frequency in minutes (subject to your plan's floor).
diffMode	string	optional	Change what counts as a change.
threshold	number	optional	Change the visual-change noise floor (0..1).
renderParams	object	optional	Render knobs to deep-merge over the existing capture config.
aiSummary	boolean	optional	Pro+ — toggle the one-sentence AI 'what changed' summary on each detected change.
webhookUrl	any	optional	Starter+ — set or replace the change-webhook target; null to turn it off.
notifyEmail	any	optional	Set the alert email (your account email only); null to turn it off.
paused	boolean	optional	true to pause the watch, false to resume.

Raw schema

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "The watch ID (UUID) to update."
    },
    "url": {
      "type": "string",
      "format": "uri",
      "description": "Re-point to a new URL (clears the baseline; the next check re-baselines)."
    },
    "name": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 120
        },
        {
          "type": "null"
        }
      ],
      "description": "Rename the watch (null to clear)."
    },
    "intervalMinutes": {
      "type": "integer",
      "minimum": 5,
      "maximum": 43200,
      "description": "New check frequency in minutes (subject to your plan's floor)."
    },
    "diffMode": {
      "type": "string",
      "enum": [
        "visual",
        "text",
        "both"
      ],
      "description": "Change what counts as a change."
    },
    "threshold": {
      "type": "number",
      "minimum": 0,
      "maximum": 1,
      "description": "Change the visual-change noise floor (0..1)."
    },
    "renderParams": {
      "type": "object",
      "properties": {
        "format": {
          "type": "string",
          "enum": [
            "png",
            "jpeg",
            "webp",
            "pdf"
          ],
          "description": "Capture format. A pdf cannot be visually diffed — pair it with diffMode 'text'. Default png."
        },
        "width": {
          "type": "integer",
          "minimum": 320,
          "maximum": 3840,
          "description": "Viewport width in px (320–3840)."
        },
        "height": {
          "type": "integer",
          "minimum": 240,
          "maximum": 2160,
          "description": "Viewport height in px (240–2160)."
        },
        "fullPage": {
          "type": "boolean",
          "default": true,
          "description": "Monitor the whole scrollable page (default true for watches). Set false to watch only the viewport."
        },
        "device": {
          "type": "string",
          "enum": [
            "desktop",
            "iphone_15",
            "iphone_se",
            "pixel_8",
            "ipad",
            "ipad_pro"
          ],
          "description": "Device preset (viewport + scale + UA). E.g. 'iphone_15' to monitor the mobile layout."
        },
        "deviceScaleFactor": {
          "type": "number",
          "minimum": 1,
          "maximum": 3,
          "description": "Device pixel ratio (1–3)."
        },
        "darkMode": {
          "type": "boolean",
          "description": "Emulate prefers-color-scheme: dark."
        },
        "blockAds": {
          "type": "boolean",
          "description": "Block ads/trackers before capture (default true)."
        },
        "blockCookieBanners": {
          "type": "boolean",
          "description": "Hide common cookie/consent banners before capture."
        },
        "hideSelectors": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "maxItems": 50,
          "description": "CSS selectors to hide before capture (max 50)."
        },
        "waitUntil": {
          "type": "string",
          "enum": [
            "load",
            "domcontentloaded",
            "networkidle0",
            "networkidle2"
          ],
          "description": "Navigation readiness event."
        },
        "delay": {
          "type": "integer",
          "minimum": 0,
          "maximum": 10000,
          "description": "Delay in ms before capture (0–10000)."
        },
        "timeout": {
          "type": "integer",
          "minimum": 5,
          "maximum": 60,
          "description": "Page-load timeout in seconds (5–60)."
        },
        "geo": {
          "type": "string",
          "description": "Pro+ — ISO country code to render from. VISUAL-ONLY: cannot combine with a 'text' OR 'both' diffMode (a geo render returns no extracted text)."
        },
        "geoCity": {
          "type": "string",
          "description": "City for more precise geo-targeting (requires geo)."
        },
        "geoState": {
          "type": "string",
          "description": "State/region for geo-targeting (requires geo)."
        },
        "selector": {
          "type": "string",
          "maxLength": 500,
          "description": "Capture and diff ONLY this CSS element — watch one price/banner/section instead of the whole page."
        },
        "ignoreRegions": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "x": {
                "type": "number",
                "minimum": 0
              },
              "y": {
                "type": "number",
                "minimum": 0
              },
              "width": {
                "type": "number",
                "exclusiveMinimum": 0
              },
              "height": {
                "type": "number",
                "exclusiveMinimum": 0
              }
            },
            "required": [
              "x",
              "y",
              "width",
              "height"
            ],
            "additionalProperties": false
          },
          "maxItems": 20,
          "description": "Pixel rectangles masked in both captures before the visual diff — silence dynamic zones (ad slot, clock). Visual mode only."
        },
        "ignoreText": {
          "type": "array",
          "items": {
            "type": "string",
            "maxLength": 500
          },
          "maxItems": 50,
          "description": "Substrings or /regex/flags stripped from both texts before the text diff — silence timestamps, counters, tokens."
        },
        "minTextChars": {
          "type": "integer",
          "minimum": 0,
          "maximum": 100000,
          "description": "Minimum added + removed characters for a text change to count (ignore tiny edits)."
        },
        "suppressWhilePresent": {
          "type": "array",
          "items": {
            "type": "string",
            "maxLength": 500
          },
          "maxItems": 20,
          "description": "While the page text contains any of these markers (e.g. 'Out of stock'), treat the run as unchanged."
        },
        "uaMode": {
          "type": "string",
          "enum": [
            "auto",
            "identify",
            "stealth"
          ],
          "description": "User-Agent identity: auto (identify then fall back), identify (always RendexWatch), stealth (always a standard browser). See https://rendex.dev/bot"
        }
      },
      "additionalProperties": false,
      "description": "Render knobs to deep-merge over the existing capture config."
    },
    "aiSummary": {
      "type": "boolean",
      "description": "Pro+ — toggle the one-sentence AI 'what changed' summary on each detected change."
    },
    "webhookUrl": {
      "anyOf": [
        {
          "type": "string",
          "format": "uri"
        },
        {
          "type": "null"
        }
      ],
      "description": "Starter+ — set or replace the change-webhook target; null to turn it off."
    },
    "notifyEmail": {
      "anyOf": [
        {
          "type": "string",
          "format": "email"
        },
        {
          "type": "null"
        }
      ],
      "description": "Set the alert email (your account email only); null to turn it off."
    },
    "paused": {
      "type": "boolean",
      "description": "true to pause the watch, false to resume."
    }
  },
  "required": [
    "id"
  ],
  "additionalProperties": false,
  "$schema": "http://json-schema.org/draft-07/schema#"
}

README.md14 KBView on GitHub

@copperline/rendex-mcp

MCP server for Rendex — render raw HTML, Markdown, or any URL to an image or PDF via AI agents using the Model Context Protocol.

Quick Start

Claude Desktop / Cursor / Windsurf (npx)

Add to your MCP client config:

json

{
  "mcpServers": {
    "rendex": {
      "command": "npx",
      "args": ["-y", "@copperline/rendex-mcp"],
      "env": {
        "RENDEX_API_KEY": "your-api-key"
      }
    }
  }
}

Where to add this:

Client	Config location
Claude Desktop	`~/Library/Application Support/Claude/claude_desktop_config.json` (macOS)
Cursor	`.cursor/mcp.json` in project root, or Settings > MCP
Windsurf	Settings > MCP Servers

Claude Code (CLI)

Add a .mcp.json to your project root with the same config above. Then restart Claude Code.

Important: Add .mcp.json to your .gitignore — it contains your API key.

Remote (zero-install, OAuth or API key)

Connect to the hosted server at https://mcp.rendex.dev/mcp — no install needed. It's fronted by OAuth 2.1 (authorization-code + PKCE S256), so OAuth-capable clients (ChatGPT, Claude, Cursor, the MCP Inspector) connect with no API key — you sign in with a one-time email code and each caller bills against their own Rendex plan and credit pool.

Clients that prefer a static key can still pass one directly:

json

{
  "mcpServers": {
    "rendex": {
      "url": "https://mcp.rendex.dev/mcp",
      "headers": {
        "Authorization": "Bearer your-api-key"
      }
    }
  }
}

Tools

`rendex_screenshot`

Render any webpage, raw HTML, or Markdown to an image or PDF.

code

"Take a screenshot of https://example.com"
"Capture the full page of https://news.ycombinator.com in dark mode"
"Generate a PDF of https://github.com with A4 page size"
"Capture https://amazon.de as seen from Germany"
"Render this HTML invoice as a PDF"
"Render this Markdown release note as a PDF"

Parameters:

Parameter	Type	Default	Description
`url`	string	required*	Webpage URL to capture. Mutually exclusive with `html` and `markdown`.
`html`	string	—	Raw HTML to render. Mutually exclusive with `url` and `markdown`.
`markdown`	string	—	Markdown to render (server converts to HTML). Mutually exclusive with `url` and `html`.
`data`	object	—	Key-value data for Mustache templating. When set, the `html` or `markdown` string is rendered as a logic-less Mustache template before capture. Invalid with `url`.
`format`	`"png"` \| `"jpeg"` \| `"webp"` \| `"pdf"`	`"png"`	Output format
`fullPage`	boolean	`false`	Capture full scrollable page
`darkMode`	boolean	`false`	Emulate dark color scheme
`width`	number	`1280`	Viewport width (320-3840)
`height`	number	`800`	Viewport height (240-2160)
`resizeWidth`	number	—	Downscale output to this width in px (aspect ratio preserved if `resizeHeight` omitted). Ignored for PDF
`resizeHeight`	number	—	Downscale output to this height in px (aspect ratio preserved if `resizeWidth` omitted). Ignored for PDF
`quality`	number	`80`	Image quality 1-100 (JPEG/WebP only, default 80)
`delay`	number	`0`	Wait ms before capture
`blockAds`	boolean	`true`	Block ads and trackers
`blockCookieBanners`	boolean	—	Hide common cookie/consent banners (GDPR/CCPA) before capture
`blockResourceTypes`	string[]	—	Block resource types: `font`, `image`, `media`, `stylesheet`, `other`
`device`	string	—	Device preset: `desktop`, `iphone_15`, `iphone_se`, `pixel_8`, `ipad`, `ipad_pro` — sets viewport, scale, and user agent in one shot. Overrides `width`/`height`/`deviceScaleFactor`/`userAgent`
`deviceScaleFactor`	number	`2`	Device pixel ratio (1-3). 2× Retina by default
`timeout`	number	`30`	Max seconds to wait for page load (5-60)
`waitUntil`	string	`"networkidle2"`	Page readiness: `load`, `domcontentloaded`, `networkidle0`, `networkidle2`
`waitForSelector`	string	—	CSS selector to wait for before capture
`bestAttempt`	boolean	`true`	Return partial render on timeout instead of failing
`selector`	string	—	CSS selector of element to capture instead of full page
`hideSelectors`	string[]	—	CSS selectors to hide (`display:none`) before capture, e.g. `['.modal', '#newsletter-popup']`. Max 50
`css`	string	—	Custom CSS to inject before capture (max 50KB)
`js`	string	—	Custom JavaScript to execute before capture (max 50KB)
`cookies`	array	—	Cookies to set for authenticated captures (max 50)
`headers`	object	—	Custom HTTP headers for the page request
`userAgent`	string	—	Override browser user agent string
`pdfFormat`	string	—	PDF page size: `A4`, `Letter`, `Legal`, `Tabloid`, `A3`
`pdfLandscape`	boolean	—	PDF landscape orientation
`pdfPrintBackground`	boolean	`true`	Print background in PDF
`pdfScale`	number	`1`	PDF scale factor (0.1-2)
`pdfMargin`	object	—	PDF margins: `{top, right, bottom, left}` as CSS values
`geo`	string	—	ISO country code for geo-targeted capture (Pro/Enterprise)
`geoCity`	string	—	City for geo-targeting (requires `geo`)
`geoState`	string	—	State for geo-targeting (requires `geo`)
`async`	boolean	—	Process asynchronously (returns job ID)
`webhookUrl`	string	—	URL to receive callback when async capture completes (Starter+; Free/Basic poll job status)
`cacheTtl`	number	—	Seconds to cache result (3600-2592000)

`rendex_extract`

Extract clean reader-mode content from any webpage as Markdown, JSON, or HTML. Runs the same Chromium render pass as a screenshot, so it captures content after JavaScript runs — handling SPAs that fetch-only readers miss. Strips nav, ads, and boilerplate, returning the article body plus title, byline, and excerpt. Great for feeding page content to an LLM, summarization, or RAG ingestion.

code

"Extract the article text from https://example.com/post as Markdown"
"Pull the readable content from this SPA as JSON so I can summarize it"

Parameters:

Parameter	Type	Default	Description
`url`	string	required	Webpage URL to extract readable content from
`extractFormat`	`"markdown"` \| `"json"` \| `"html"`	`"markdown"`	Output shape — `markdown` (LLM-friendly prose), `json` (structured: title/byline/excerpt/siteName/length), or `html` (cleaned reader-mode HTML)
`device`	string	—	Device preset (`desktop`, `iphone_15`, `iphone_se`, `pixel_8`, `ipad`, `ipad_pro`) — extract the mobile/tablet version of a page
`blockAds`	boolean	`true`	Block ads and trackers before extraction
`blockCookieBanners`	boolean	—	Hide common cookie/consent walls before extraction
`hideSelectors`	string[]	—	CSS selectors to hide before extraction, e.g. `['.modal', '#newsletter-popup']`. Max 50
`waitUntil`	string	`"networkidle2"`	Page readiness: `load`, `domcontentloaded`, `networkidle0`, `networkidle2`
`timeout`	number	`30`	Max seconds to wait for page load (5-60)

`rendex_render_link`

Render a URL, raw HTML, or Markdown and get back a signed, hosted, edge-cached image URL instead of the bytes — ideal for dynamic OG images. Drop the URL into <meta property="og:image"> or an <img> tag and Rendex serves a cached copy on every share. Takes the same parameters as rendex_screenshot, plus an optional expiresIn. Returns { url, expiresAt, format, cacheTtl }.

code

"Make me a hosted OG-image URL for this Markdown release note"
"Give me a render link for this HTML card that I can drop into og:image"

Parameter	Type	Default	Description
(all `rendex_screenshot` params)	—	—	Same source (`url`/`html`/`markdown`), format, sizing, and templating options
`expiresIn`	number	server TTL	Seconds until the signed URL expires (60–2592000)

`render_artifact`

Turn Markdown or HTML into a branded, downloadable artifact — a PDF, a PNG, and a hosted share page — in one call. Ideal for agent outputs: reports, invoices, summaries, release notes, dashboards. Apply a logo, accent color, font, header, and footer; choose PDF page size/orientation/margins. Returns hosted URLs { pdfUrl, pngUrl, shareUrl, expiresAt } — no storage needed on your side. Each requested format costs 1 render credit.

code

"Turn this Markdown report into a branded PDF and PNG with our logo and an orange accent"
"Render this invoice HTML to a PDF and give me a share link that expires in a week"

Parameter	Type	Default	Description
`content`	string	required	The Markdown or HTML body to render (up to ~4MB)
`inputFormat`	`"markdown"` \| `"html"`	`"markdown"`	How to interpret `content` — `markdown` is converted to styled HTML; `html` is used as a body fragment
`formats`	`("pdf" \| "png")[]`	`["pdf","png"]`	Which formats to produce. Each costs 1 credit
`accentColor`	string	—	CSS accent color for the bar, links, and headings (e.g. `#EA580C`)
`logo`	string	—	http(s) URL of a logo image shown in the header
`header`	string	—	plain-text header line shown beside the logo
`footer`	string	—	plain-text footer line shown at the bottom
`font`	string	—	CSS font-family stack for the body
`pageSetup`	object	—	`{ size, orientation, margin{top,right,bottom,left}, scale, width, height, fullPage }`
`data`	object	—	Mustache data — when set, `content` is rendered as a logic-less Mustache template (plus `{{logo}}`/`{{header}}`/… from `branding`) before conversion
`expiresIn`	number	`86400`	Seconds until the hosted URLs expire (3600–2592000). Default 24h

Rendex Watch

Monitor a URL on a schedule and get notified when it changes — real-Chrome visual diff (with a highlighted overlay), an extracted-text diff, or both. Eight tools let an agent set up, inspect, edit, and tear down watches on the shared Rendex platform (one rdx_ key, one credit pool).

code

"Watch https://example.com/pricing for visual changes and alert my webhook"
"Before I save it, test whether you can capture #pricing on that page"
"Show me the last few runs of watch <id> — did anything change?"

Tool	Purpose	Key inputs
`watch_create`	Create a watch (active → captures its baseline now)	`url`, `name?`, `intervalMinutes?`, `diffMode?` (visual/text/both), `threshold?`, `renderParams?`, `webhookUrl?` (Starter+), `notifyEmail?`, `paused?`
`watch_test`	Dry-run a config first (creates nothing)	same as `watch_create`
`watch_list`	List your watches	`status?` (active/paused/all), `cursor?`, `limit?`
`watch_get`	Fetch one watch (+ baseline URL)	`id`
`watch_run`	Run a check now (1 credit)	`id`
`watch_runs`	Run history with signed before/after/overlay URLs	`id`, `cursor?`, `limit?`
`watch_update`	Edit a watch in place — interval, diff mode, channels, render params	`id`, plus any `watch_create` field; `webhookUrl`/`notifyEmail` accept `null` to clear a channel
`watch_delete`	Delete a watch + its runs	`id`

renderParams carries the per-check capture knobs (fullPage defaults to true, selector, device, geo (Pro+), plus noise controls ignoreRegions/ignoreText/minTextChars/suppressWhilePresent and uaMode). Interval floors are per-plan (Free 1440 / Basic 180 / Starter 60 / Pro 30 / Enterprise 5). Watch metadata + signed image URLs are returned as JSON text.

`rendex_account`

Check the account from inside the agent: which plan it's on, how many render credits have been used this month vs. the limit (and when it resets), the per-minute rate limit, and a one-tap upgrade link. Lets an agent answer "how much have I used?" or "how do I get more renders?" without sending the user to the dashboard. Read-only — costs no credits.

code

"How many Rendex renders do I have left this month?"
"What plan am I on, and how do I upgrade for more?"

Returns { plan, usage: { used, limit, remaining, unlimited, resetsAt }, rateLimitPerMinute, upgrade: { recommendedPlan, recommendedPlanCredits, upgradeUrl, manageBillingUrl } }.

Data templating

Turn one reusable template into many documents. Pass a data object alongside html or markdown, and Rendex renders the string as a logic-less Mustache template before capture — {{var}} interpolation, {{#items}}…{{/items}} loops, and nested {{a.b}} access. Great for invoices, reports, certificates, and OG cards.

code

"Render this HTML invoice template to a PDF, filling it with this data:
 <h1>Invoice {{number}}</h1><p>Total: {{total}}</p>
 data = { number: 'INV-014', total: '$2,400' }"

data is valid only with html or markdown — combining it with url returns a validation error.

Authentication

Get your API key at rendex.dev.

Set the RENDEX_API_KEY environment variable in your MCP client configuration.

Pricing

Plan	Calls/Month	Rate
Free	100	3/min
Starter	10,000	60/min
Pro	100,000	300/min
Enterprise	Custom	1,000/min

License

MIT — Copperline Labs LLC

Install

Tools (13)

rendex_screenshotrendex_extractrendex_render_linkrender_artifactrendex_accountwatch_createwatch_testwatch_list

Configuration

Environment variables

RENDEX_API_KEYrequiredsecret

API key from rendex.dev dashboard

Add to VS Code Add to Cursor

claude_desktop_config.json

json

{
  "mcpServers": {
    "rendex-mcp": {
      "command": "npx",
      "args": [
        "-y",
        "@copperline/rendex-mcp@1.8.2"
      ],
      "env": {
        "RENDEX_API_KEY": "<YOUR_RENDEX_API_KEY>"
      }
    }
  }
}

@copperline/rendex-mcp (MCP Server) — Render-to-Image/PDF Web Capture

🛠️ Key Features

🚀 Use Cases

⚡ Developer Benefits

⚠️ Limitations

Topics

rendex_screenshot

rendex_extract

rendex_render_link

render_artifact

rendex_account

watch_create

watch_test

watch_list

watch_get

watch_run

watch_runs

watch_delete

watch_update

@copperline/rendex-mcp

Quick Start

Claude Desktop / Cursor / Windsurf (npx)

Claude Code (CLI)

Remote (zero-install, OAuth or API key)

Tools

rendex_screenshot

rendex_extract

rendex_render_link

render_artifact

Rendex Watch

rendex_account

Data templating

Authentication

Pricing

License

Install

Configuration

Related servers

`rendex_screenshot`

`rendex_extract`

`rendex_render_link`

`render_artifact`

`rendex_account`