@microlink/mcp 2.3.0 → 2.4.1

package/README.md

@@ -161,7 +161,7 @@ Each tool is a thin wrapper over a [`microlink.io`](https://github.com/microlink
 ### Response shape
 
 - Each tool returns the library's **direct result** under `structuredContent.data` (and the same value as pretty-printed JSON text). For example `microlink_markdown` → `{ data: "# Title\n..." }`, `microlink_screenshot` → `{ data: { url, type, width, height, size } }`, `microlink_links` → `{ data: ["https://...", ...] }`.
-- On failure the tool sets MCP `isError` and returns `{ error: { message, code?, status?, statusCode?, url?, more? } }`. A `429` also includes a free-quota `hint`.
+- On failure the tool sets MCP `isError` and returns `{ error: { message, code?, status?, statusCode?, url?, more?, details? } }`, where `message` carries the specific cause reported by the API. Capability errors that retrying cannot fix (for example `EPROXYNEEDED` or `EINTEGRATION`) also include machine-readable `reason` (`upgrade_required`), `capability`, an `upgrade` object with the plan and pricing URL, and an agent-facing `hint` with the next step. A `429` includes `reason: "quota_exceeded"` and a free-quota `hint`.
 
 Parameters labeled `PRO` in the official Microlink docs require a paid plan.
 For compatibility with some MCP clients:
@@ -522,7 +522,7 @@ The `MICROLINK_API_KEY` environment variable is the recommended approach for mos
 
 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](https://microlink.io/#pricing).
+When the free endpoint returns `429`, this MCP adds a clear hint in the tool error message: free daily quota reached, plus upgrade/API key guidance at [microlink.io/#pricing](https://microlink.io/#pricing).
 
 ## License
 

package/package.json

@@ -2,7 +2,7 @@
   "name": "@microlink/mcp",
   "description": "MCP server for Microlink API",
   "homepage": "https://github.com/microlinkhq/microlink",
-  "version": "2.3.0",
+  "version": "2.4.1",
   "main": "./src/index.js",
   "exports": {
     ".": "./src/index.js"
@@ -66,5 +66,5 @@
     "access": "public"
   },
   "type": "module",
-  "gitHead": "9e479486674289cd4f5257b4c1fd5ad527f6ebb1"
+  "gitHead": "f2d20e6f64995a7084ed097d5441d0f0f4950c76"
 }

package/src/microlink-client.js

@@ -1,7 +1,25 @@
 import createClient, { MicrolinkError } from 'microlink.io'
 
-const FREE_QUOTA_EXCEEDED_HINT =
-  'Free daily quota reached (50 requests/day). Extend your limit by getting an API key at https://microlink.io/#pricing.'
+const UPGRADE_URL = 'https://microlink.io/#pricing'
+
+const FREE_QUOTA_EXCEEDED_HINT = `Free daily quota reached. Extend your limit by getting an API key at ${UPGRADE_URL}.`
+
+// Actionable guidance for capability errors that retrying cannot fix:
+// what happened, why, and how to continue. `reason` and `capability` are
+// machine-readable so clients can react programmatically; `hint` is the
+// agent-facing next step.
+const ERROR_GUIDANCE = {
+  EPROXYNEEDED: {
+    reason: 'upgrade_required',
+    capability: 'proxy',
+    hint: `The target website is behind antibot protection and needs the Microlink proxy network, included in PRO plans. The request is correct: get an API key at ${UPGRADE_URL}, pass it as \`apiKey\` (or set MICROLINK_API_KEY) and repeat the same call.`
+  },
+  EINTEGRATION: {
+    reason: 'upgrade_required',
+    capability: 'integration',
+    hint: `This capability requires a PRO plan. Get an API key at ${UPGRADE_URL}, pass it as \`apiKey\` (or set MICROLINK_API_KEY) and repeat the same call.`
+  }
+}
 
 // A single shared client; the per-request apiKey travels in the options bag.
 export const client = createClient()
@@ -14,24 +32,52 @@ export function resolveApiKey (inputApiKey, headerApiKey) {
   )
 }
 
+const isPlainObject = value =>
+  value !== null && typeof value === 'object' && !Array.isArray(value)
+
+function toToolResponse (isError, field, value) {
+  return {
+    isError,
+    structuredContent: { [field]: value },
+    content: [{ type: 'text', text: JSON.stringify(value, null, 2) }]
+  }
+}
+
 // Every tool returns the library's direct result (a string, array, or object).
 // MCP `structuredContent` must be an object, so wrap the value under `data`.
 export function asToolResult (value) {
-  const data = value ?? null
-  return {
-    isError: false,
-    structuredContent: { data },
-    content: [{ type: 'text', text: JSON.stringify(data, null, 2) }]
-  }
+  return toToolResponse(false, 'data', value ?? null)
 }
 
-export function asErrorResult (error) {
+// The API wraps some failures in a generic top-level message ("The request
+// has been not processed…"), while the specific cause travels in `data`
+// (e.g. `data.url`). Only then should the data-derived message lead: a
+// specific description is the real cause and must not be hidden by
+// auxiliary strings in `data`.
+const GENERIC_API_MESSAGE = 'The request has been not processed.'
+
+function toErrorPayload (error) {
   const isMql = error instanceof MicrolinkError
   const statusCode = isMql ? error.statusCode : undefined
+  const description = isMql ? error.description : undefined
+
+  const details = isMql && isPlainObject(error.data) ? error.data : undefined
+  const detailMessage =
+    details &&
+    Object.values(details)
+      .filter(value => typeof value === 'string')
+      .join(' ')
+
+  const isGenericDescription =
+    typeof description === 'string' &&
+    description.startsWith(GENERIC_API_MESSAGE)
 
   const payload = {
     message:
-      (isMql ? error.description : undefined) || error?.message || String(error)
+      (isGenericDescription ? detailMessage : undefined) ||
+      description ||
+      error?.message ||
+      String(error)
   }
 
   if (isMql) {
@@ -40,13 +86,32 @@ export function asErrorResult (error) {
     if (statusCode) payload.statusCode = statusCode
     if (error.url) payload.url = error.url
     if (error.more) payload.more = error.more
+    if (details) payload.details = details
   }
 
-  if (statusCode === 429) payload.hint = FREE_QUOTA_EXCEEDED_HINT
+  const guidance = isMql && ERROR_GUIDANCE[error.code]
+  if (guidance) {
+    payload.reason = guidance.reason
+    payload.capability = guidance.capability
+    payload.hint = guidance.hint
+    payload.upgrade = { plan: 'pro', url: UPGRADE_URL }
+  }
 
-  return {
-    isError: true,
-    structuredContent: { error: payload },
-    content: [{ type: 'text', text: JSON.stringify(payload, null, 2) }]
+  if (statusCode === 429) {
+    payload.reason = 'quota_exceeded'
+    payload.hint = FREE_QUOTA_EXCEEDED_HINT
   }
+
+  return payload
+}
+
+export function asErrorResult (error) {
+  const payload =
+    isPlainObject(error) &&
+    !(error instanceof Error) &&
+    typeof error.message === 'string'
+      ? error
+      : toErrorPayload(error)
+
+  return toToolResponse(true, 'error', payload)
 }

package/src/schemas.js

@@ -214,6 +214,9 @@ export const metaConfigSchema = objectLikeSchema(
     .strict()
 )
 
+const optionalApiKey = description =>
+  z.string().min(1).optional().describe(description)
+
 const baseSchema = z.object({
   url: z
     .string()
@@ -221,13 +224,9 @@ const baseSchema = z.object({
     .describe(
       'Public URL of the page to process. Include the protocol, for example https://example.com.'
     ),
-  apiKey: z
-    .string()
-    .min(1)
-    .optional()
-    .describe(
-      'Microlink PRO API key. Omit it unless you have one: requests then use the MICROLINK_API_KEY environment variable or the free endpoint.'
-    )
+  apiKey: optionalApiKey(
+    'Microlink PRO API key. Omit it unless you have one: requests then use the MICROLINK_API_KEY environment variable or the free endpoint.'
+  )
 })
 
 const fullShape = {
@@ -242,28 +241,51 @@ const fullShape = {
 // Shared Microlink API query parameters (see microlink.io/docs/api/parameters).
 // Product tools layer their own fields on top; these apply to any URL fetch.
 // `data` is separate: content/collection helpers overwrite it with their field rule.
+// PRO parameters per the Microlink API spec (https://microlink.io/openapi.json):
+// they only take effect with an API key attached to the request.
+const PRO = 'PRO: requires a Microlink API key (Pro plan).'
+
 const browserSchema = {
   adblock: booleanSchema.optional(),
   animations: booleanSchema.optional(),
-  cacheKey: z.string().min(1).optional(),
+  cacheKey: z
+    .string()
+    .min(1)
+    .optional()
+    .describe(`Custom cache key for the request. ${PRO}`),
   click: stringOrStringArraySchema.optional(),
   colorScheme: z.enum(['no-preference', 'light', 'dark']).optional(),
   device: z.string().min(1).optional(),
-  filename: z.string().min(1).optional(),
+  filename: z
+    .string()
+    .min(1)
+    .optional()
+    .describe(`Custom name for the generated asset. ${PRO}`),
   filter: z.string().min(1).optional(),
   force: booleanSchema.optional(),
   headers: objectLikeSchema(
     z.record(z.string(), z.union([z.string(), z.number(), booleanSchema]))
-  ).optional(),
+  )
+    .optional()
+    .describe(`Custom HTTP headers sent to the target URL. ${PRO}`),
   javascript: booleanSchema.optional(),
   mediaType: z.enum(['screen', 'print']).optional(),
   modules: stringOrStringArraySchema.optional(),
   prerender: z.union([z.literal('auto'), booleanSchema]).optional(),
-  proxy: proxySchema.optional(),
+  proxy: proxySchema
+    .optional()
+    .describe(
+      `Proxy rotation to bypass IP rate limits, CAPTCHAs and regional restrictions. ${PRO}`
+    ),
   retry: z.number().int().nonnegative().optional(),
   scripts: stringOrStringArraySchema.optional(),
   scroll: z.string().min(1).optional(),
-  staleTtl: z.union([z.string(), z.number(), booleanSchema]).optional(),
+  staleTtl: z
+    .union([z.string(), z.number(), booleanSchema])
+    .optional()
+    .describe(
+      `Serve stale cached content while refreshing it in the background. ${PRO}`
+    ),
   styles: stringOrStringArraySchema.optional(),
   timeout: stringOrNumberSchema.optional(),
   ttl: stringOrNumberSchema.optional(),
@@ -403,13 +425,9 @@ export const searchInputSchema = z
       .describe(
         'Google search query. Operators like site:, filetype: or quotes work as-is.'
       ),
-    apiKey: z
-      .string()
-      .min(1)
-      .optional()
-      .describe(
-        'Microlink API key. Required for this tool: Google search runs on the PRO endpoint.'
-      ),
+    apiKey: optionalApiKey(
+      'Microlink API key. Required for this tool: Google search runs on the PRO endpoint.'
+    ),
     type: z
       .enum([
         'search',

package/src/tools/register.js

@@ -94,15 +94,10 @@ export function register (
       const parsed = inputSchema.safeParse(args)
 
       if (!parsed.success) {
-        const payload = {
+        return asErrorResult({
           message: 'Input validation failed.',
           issues: parsed.error.issues
-        }
-        return {
-          isError: true,
-          structuredContent: { error: payload },
-          content: [{ type: 'text', text: JSON.stringify(payload, null, 2) }]
-        }
+        })
       }
 
       try {