Microlink

A Model Context Protocol (MCP) server that exposes Microlink API capabilities to AI assistants. Runs over stdio transport, making it compatible with Claude Desktop, VS Code, Cursor, and any other MCP-capable client.

It turns natural-language requests into Microlink calls: take screenshots, generate PDFs, extract metadata or readable text, detect video/audio sources, run Lighthouse audits, and scrape custom fields with CSS selectors, all without leaving the assistant.

See the MCP integration page for a guided walkthrough, or the @microlink/mcp npm package.

Table of contents

• Install
• MCP client configuration
• Usage
• Tools
• Authentication
• Development
• License

Install

Use the published package (recommended)

No local installation is required. Run directly with npx:

npx -y @microlink/mcp

Optional: install globally

npm install -g @microlink/mcp
microlink-mcp

During installation, the package prints a console reminder about the free Microlink plan (50 requests/day) and where to get an API key for higher/unlimited usage at microlink.io/#pricing.

MCP client configuration

Claude Desktop

Edit ~/Library/Application\ Support/Claude/claude_desktop_config.json:

{
  "mcpServers": {
    "microlink": {
      "command": "npx",
      "args": ["-y", "@microlink/mcp"],
      "env": {
        "MICROLINK_API_KEY": "YOUR_MICROLINK_API_KEY"
      }
    }
  }
}

VS Code / Codex

Published package:

{
  "mcpServers": {
    "microlink": {
      "command": "npx",
      "args": ["-y", "@microlink/mcp"],
      "env": {
        "MICROLINK_API_KEY": "YOUR_MICROLINK_API_KEY"
      }
    }
  }
}

Local repository:

{
  "mcpServers": {
    "microlink": {
      "command": "node",
      "args": ["/absolute/path/to/mcp/src/index.js"],
      "env": {
        "MICROLINK_API_KEY": "YOUR_MICROLINK_API_KEY"
      }
    }
  }
}

Cursor

Add to your Cursor MCP settings (.cursor/mcp.json):

{
  "mcpServers": {
    "microlink": {
      "command": "npx",
      "args": ["-y", "@microlink/mcp"],
      "env": {
        "MICROLINK_API_KEY": "YOUR_MICROLINK_API_KEY"
      }
    }
  }
}

Usage

Once the server is configured, talk to your assistant in plain language. It picks the right tool and parameters for you:

• "Take a full-page screenshot of https://example.com in dark mode." → microlink_screenshot
• "Generate a Letter-size PDF of https://example.com." → microlink_pdf
• "Get the title, description, and image for https://example.com." → microlink_meta
• "Convert https://news.ycombinator.com to Markdown." → microlink_markdown
• "Find the playable video in this YouTube link." → microlink_video
• "Run a Lighthouse performance audit on https://example.com." → microlink_insights
• "Scrape every article title from this page using the .title selector." → microlink_extract with data

Tools can also be invoked directly. Every tool takes a url and returns structuredContent (see Response shape):

{
  "name": "microlink_screenshot",
  "arguments": {
    "url": "https://example.com",
    "screenshot": { "fullPage": true, "type": "png" },
    "colorScheme": "dark"
  }
}

Tools

Capabilities at a glance

• microlink_extract: metadata extraction + custom scraping rules (data) + multi-capability composition in one call.
• microlink_screenshot: screenshot generation with element/full-page modes and browser controls.
• microlink_pdf: PDF generation with page/layout controls.
• microlink_video: playable video source extraction.
• microlink_audio: playable audio source extraction.
• microlink_insights: Lighthouse + technology detection.
• microlink_meta: normalized metadata extraction with include/exclude config.
• microlink_palette: image palette and contrast color extraction.
• microlink_markdown: URL to Markdown conversion.
• microlink_text: URL to plain text conversion.
• Cross-cutting request capabilities: device/viewport emulation, click/scroll actions, JS/CSS injection, modules, wait conditions, cache controls (ttl, staleTtl, force), retries/timeouts, media mode, headers/proxy, and endpoint/auth routing.

Response shape

• All tools (microlink_extract, microlink_screenshot, microlink_pdf, microlink_video, microlink_audio, microlink_insights, microlink_meta, microlink_palette, microlink_markdown, microlink_text) return structuredContent with:
  • endpoint, requestUrl, finalUrl, statusCode, responseHeaders, microlink
  • microlink preserves Microlink API JSend payload (status, data, and error fields like code, id, message, more, report).
  • responseHeaders includes key cache/rate headers (such as x-cache-status, cf-cache-status, cache-control, x-rate-limit-*) when present.
  • MCP isError is set when transport fails or when microlink.status !== "success".

Parameters labeled PRO in the official Microlink docs require a paid plan. For compatibility with some MCP clients:

• boolean parameters also accept the strings "true" and "false" and are normalized before validation.
• parameters that accept objects also accept JSON stringified objects (for example, screenshot: "{\"overlay\":{\"browser\":\"dark\"}}").

microlink_extract

Extract structured metadata from any public URL. Returns normalized fields (title, description, author, publisher, date, image, logo, lang, url) plus any custom fields defined via CSS selectors.

Supports combining multiple features in a single request: screenshot, PDF, video, audio, insights, and palette. For screenshot, pdf, and insights, use true for defaults or an object for options. Empty objects ({}) are treated as true.

Key parameters:

Parameter	Type	Description
url	string	The URL to extract data from (required)
apiKey	string	Microlink API key (optional; see Authentication)
data	object	Custom CSS-selector extraction rules
meta	boolean | object	Include/exclude normalized metadata fields
embed	string	Microlink embed mode
iframe	boolean | object	Include iframe payload options
function	string	Custom Microlink function hook
ping	boolean | object	Enable ping checks
screenshot	boolean | object	Capture a screenshot
pdf	boolean | object	Generate a PDF
video	boolean	Extract video source
audio	boolean	Extract audio source
insights	boolean | object	Run Lighthouse / tech detection
palette	boolean	Extract color palette
adblock	boolean	Enable ad blocking
animations	boolean	Enable/disable animations
device	string	Emulate a device (e.g. "iPhone 12")
colorScheme	"light" | "dark" | "no-preference"	Preferred color scheme
viewport	object	Custom viewport dimensions
click	string | string[]	CSS selector(s) to click before capture
scroll	string	CSS selector to scroll to
javascript	boolean	Toggle JavaScript execution
modules	string | string[]	Browser module(s) to inject
scripts	string | string[]	JavaScript to inject
styles	string | string[]	CSS to inject
mediaType	"screen" | "print"	CSS media mode
prerender	"auto" | boolean	Prerender strategy
proxy	string | object	Proxy configuration (PRO)
retry	number	Retry count
ttl	string | number	Cache TTL
staleTtl	string | number | boolean	Stale cache TTL policy (PRO)
force	boolean	Bypass cache
timeout	string | number	Request timeout
headers	object	Custom HTTP headers (PRO)
filename	string	Preferred output filename (PRO)
filter	string	Response filter
waitForSelector	string	Wait for element before capture
waitForTimeout	string | number	Wait an additional timeout before capture
waitUntil	string | string[]	Navigation event(s): auto, load, domcontentloaded, networkidle0, networkidle2

---

microlink_screenshot

Capture a screenshot of any public URL and receive a permanent CDN asset URL (data.screenshot.url). Set screenshot to true for defaults, or pass screenshot: { ... } for options. screenshot: {} is treated as true.

Key parameters:

Parameter	Type	Description
url	string	The URL to screenshot (required)
screenshot	boolean | object	Enable screenshot with defaults (true) or provide screenshot options ({...}); {} behaves as true
screenshot.fullPage	boolean	Capture the full scrollable page
screenshot.element	string	CSS selector to capture a specific element
screenshot.type	"jpeg" | "png"	Output format (default: "png")
screenshot.omitBackground	boolean	Transparent background
screenshot.overlay	object	Browser chrome overlay (browser: "light"|"dark", background: CSS color)
screenshot.codeScheme	string	Syntax-highlight theme for code pages (e.g. "dracula")
colorScheme	"light" | "dark" | "no-preference"	Preferred color scheme
device	string	Device emulation
viewport	object	Custom viewport
click	string | string[]	Click before capture
scroll	string	Scroll to element
scripts	string | string[]	JavaScript to inject before capture
styles	string | string[]	CSS to inject before capture
modules	string | string[]	Browser module(s) to inject
proxy	string | object	Proxy configuration (PRO)
headers	object	Custom HTTP headers (PRO)
force	boolean	Bypass cache
ttl	string | number	Cache TTL
staleTtl	string | number | boolean	Stale cache TTL policy (PRO)
retry	number	Retry count
timeout	string | number	Request timeout
prerender	"auto" | boolean	Prerender strategy
adblock	boolean	Enable ad blocking
animations	boolean	Enable/disable animations
javascript	boolean	Toggle JavaScript execution
mediaType	"screen" | "print"	CSS media mode
filename	string	Preferred output filename (PRO)
filter	string	Response filter
waitForSelector	string	Wait for element
waitForTimeout	string | number	Wait an additional timeout before capture
waitUntil	string | string[]	Navigation event(s): auto, load, domcontentloaded, networkidle0, networkidle2

---

microlink_pdf

Generate a PDF of any public URL and receive a permanent CDN asset URL (data.pdf.url). Set pdf to true for defaults, or pass pdf: { ... } for options. pdf: {} is treated as true.

Key parameters:

Parameter	Type	Description
url	string	The URL to convert (required)
pdf	boolean | object	Enable PDF with defaults (true) or provide PDF options ({...}); {} behaves as true
pdf.format	string	Paper size: "A4" (default), "Letter", "Legal", "Tabloid", "Ledger", "A0"–"A6"
pdf.landscape	boolean	Landscape orientation
pdf.margin	string | object	Page margins (e.g. "0.35cm" or {top, bottom, left, right})
pdf.scale	number	Page scale factor (0.1–2.0)
pdf.pageRanges	string	Page range (e.g. "1-5")
pdf.width / pdf.height	string	Custom dimensions (overrides format)
scripts	string | string[]	JavaScript to inject before rendering
styles	string | string[]	CSS to inject before rendering
modules	string | string[]	Browser module(s) to inject
proxy	string | object	Proxy configuration (PRO)
headers	object	Custom HTTP headers (PRO)
force	boolean	Bypass cache
ttl	string | number	Cache TTL
staleTtl	string | number | boolean	Stale cache TTL policy (PRO)
retry	number	Retry count
timeout	string | number	Request timeout
prerender	"auto" | boolean	Prerender strategy
adblock	boolean	Enable ad blocking
animations	boolean	Enable/disable animations
javascript	boolean	Toggle JavaScript execution
device	string	Device emulation
viewport	object	Custom viewport
filename	string	Preferred output filename (PRO)
filter	string	Response filter
mediaType	"screen" | "print"	CSS media type
waitForSelector	string	Wait for element
waitForTimeout	string | number	Wait an additional timeout before rendering
waitUntil	string | string[]	Navigation event(s): auto, load, domcontentloaded, networkidle0, networkidle2

---

microlink_video

Detect and extract a playable video source from any URL. Returns the video URL in data.video.url along with type, duration, size, width, height, duration_pretty, and size_pretty.

Supports YouTube, Vimeo, Twitter/X, TikTok, Instagram, Dailymotion, and hundreds of other platforms.

Key parameters:

Parameter	Type	Description
url	string	The URL containing a video (required)
proxy	string | object	Proxy for restricted platforms (PRO)
meta	boolean | object	Include/suppress page metadata

---

microlink_audio

Detect and extract a playable audio source from any URL. Returns the audio URL in data.audio.url along with type, duration, size, duration_pretty, and size_pretty.

Supports SoundCloud, Spotify, Mixcloud, and other audio platforms.

Key parameters:

Parameter	Type	Description
url	string	The URL containing audio (required)
proxy	string | object	Proxy for restricted platforms (PRO)
meta	boolean | object	Include/suppress page metadata

---

microlink_insights

Get web performance and technology-stack insights for any URL. Set insights to true for defaults, or pass insights: { ... } for options. insights: {} is treated as true.

Key parameters:

Parameter	Type	Description
url	string	The URL to analyze (required)
insights	boolean | object	Enable default insights (true) or provide insights options ({...}); {} behaves as true
insights.lighthouse	boolean | object	Run a Lighthouse audit
insights.lighthouse.output	"json" | "html" | "csv"	Report format (default: "json")
insights.lighthouse.preset	string	Audit preset: "default", "desktop", "perf", "experimental", "full", "lr-desktop", "lr-mobile"
insights.lighthouse.onlyCategories	string | string[]	Lighthouse category IDs (e.g. ["performance", "accessibility"])
insights.technologies	boolean	Detect tech stack via Wappalyzer

---

microlink_meta

Extract normalized metadata from any public URL. Returns: title, description, lang, author, publisher, date, url, image (with dimensions and file info), and logo (publisher favicon).

Key parameters:

Parameter	Type	Description
url	string	The URL to inspect (required)
meta	boolean | object	false to skip all metadata; object to include/exclude specific fields (e.g. { logo: true, title: true })

---

microlink_palette

Extract a color palette from images detected on any public URL. For each image returns: palette (hex colors from most to least dominant), background_color (optimal WCAG-contrast background), color (best overlay color), and alternative_color.

Color data is nested under each image field (e.g. data.image.palette). Useful for generating design tokens, theming, or accessibility checks.

Key parameters:

Parameter	Type	Description
url	string	The URL to analyze (required)
meta	boolean | object	Control metadata fields returned
palette	boolean	Enable palette extraction (default: true)

---

microlink_markdown

Convert any public URL to Markdown. Returns JSON output with Markdown content in microlink.data.markdown, useful for extracting readable content from web pages, articles, and documentation.

Key parameters:

Parameter	Type	Description
url	string	The URL to convert (required)
apiKey	string	Microlink API key (optional)

---

microlink_text

Extract plain text from any public URL. Returns JSON output with plain text content in microlink.data.text.

Key parameters:

Parameter	Type	Description
url	string	The URL to extract text from (required)
apiKey	string	Microlink API key (optional)

---

Skills

This package bundles Agent Skills in the skills/ directory. Each skill is a self-contained SKILL.md that teaches an AI agent how to accomplish a task with the Microlink MCP tools above. They follow the open Agent Skills standard, so they work with any agent that supports it (Claude Code, Claude Desktop, Cursor, VS Code agents, and others).

Skill	What it does	Tools used
capture-web-screenshot	Screenshots & PDFs (full-page, element, device, dark mode, OG images)	microlink_screenshot, microlink_pdf
extract-web-content	URL → clean Markdown, plain text, metadata, or custom CSS-scraped fields	microlink_markdown, microlink_text, microlink_meta, microlink_extract
build-link-preview	Rich link-unfurl / social cards from metadata, palette, and thumbnail	microlink_meta, microlink_palette, microlink_screenshot
audit-website-insights	Lighthouse performance / SEO / a11y audits and tech-stack detection	microlink_insights
extract-media-source	Resolve a page to a direct, playable video or audio source URL	microlink_video, microlink_audio

To use a skill in Claude Code, copy its directory into .claude/skills/. For other agents, see your tool's skills or extensions catalog. More detail in skills/README.md.

---

Authentication

Every tool accepts an optional apiKey parameter. The key is resolved from these sources in order of priority:

1. apiKey field in the tool input parameters
2. Authorization: Bearer <key> header from the MCP request
3. x-api-key header from the MCP request
4. MICROLINK_API_KEY environment variable

The MICROLINK_API_KEY environment variable is the recommended approach for most integrations. Get your key at microlink.io.

If an API key is present, requests are sent to https://pro.microlink.io; otherwise they go to https://api.microlink.io (free endpoint).

When the free endpoint returns 429, this MCP adds a clear hint in the tool error message: free daily quota reached (50 requests/day) and upgrade/API key guidance at microlink.io/#pricing.

License

microlink © Microlink, released under the MIT License.
Authored and maintained by Kiko Beats with help from contributors.

microlink.io · GitHub microlinkhq · X @microlinkhq