Skip to main content

Squillify development is paused indefinitely. Read why, and discover what this experiment achieved. Read the story

MicroSkills Reference

Markdown Link Validator

text.validate_markdown_links

ProductionBounded custom (Class B)Deterministicverifiablefastv1.0.0
No network

Overview

Two validation levels, both offline: (1) SYNTACTIC — parses Markdown (CommonMark) and checks link/image and external-URL syntax and flags dangerous URI schemes; (2) LOCAL RESOLUTION — resolves internal heading anchors and relative file references against a provided known-files list. It does NOT do NETWORK resolution: 'valid' means no error-level syntactic or local-resolution finding, never that an external URL is reachable.

Broken links hurt docs quality — we lint Markdown link and anchor syntax locally, with no network crawl.

Reliability

VERIFIABLE and deterministic — identical markdown and options always yield the same findings. No network access; valid means no error-level syntactic or local-resolution finding, not that external URLs are reachable. Input validation (not retryable): maxFindings outside 1 to 20,000; markdown missing, not a string, or longer than 2,000,000 characters.

Context footprint

Bounded input (2 MB); findings capped by maxFindings. A successful call costs 1 execution credit.

When to use it

Before you publish Markdown, to catch broken anchors, malformed links, and dangerous URI schemes.

Do not use when you need to verify that external URLs actually resolve (use web.check_url_status for reachability).

Scope

Note
Validates Markdown link/image syntax, internal heading anchors, relative file references, and external URL syntax using CommonMark parsing. No network access.

Non-goals

  • Does not check whether external URLs are reachable
  • Does not fetch or crawl any URL
  • Does not render the Markdown

Properties

IdempotentRetry safeStreaming supportedFile input supportedRequires external service

Capabilities

parsingvalidation

Cost & billing

Flat rate per invocation

MetercallsBillable onsuccessCost per call1 credit

File handling

Accepts file_refProduces file_refMax input1.9 MB

How we handle your data

Sensitive input, safe output
What this means

This skill may receive sensitive content, but it does not target sensitive data and returns only a structured non-sensitive result.

Squillify guarantees
  • Runs inside Squillify
  • This skill runs inside Squillify.
  • Payloads are not sent to an external service by this skill.
  • Squillify does not permanently store submitted payloads.
  • Telemetry records metadata only, not submitted content.
  • Submitted payloads are not used for training.
  • Submitted payloads are not reviewed by humans.
  • This skill does not target sensitive data.
  • The response does not contain submitted content.
Your responsibility

Squillify does not determine whether submitted content is sensitive. Your application is responsible for deciding what data it is allowed to submit. Your application is responsible for securing the response.

Read the Microskill Data Handling Policy

Input schema

FieldTypeRequiredDescription
markdownstringYesMarkdown document whose links and anchors are validated.
basePathstringNoReserved base path; omit it because it has no effect in this version.
knownFilesarrayNoBounded optional array of known relative file paths; omit it to treat no relative file as known. The item shape is defined by the nested schema and the array contains from 0 through 20000 items.
checkImagesbooleanNoWhether image links are checked; omit it for true.
checkExternalUrlSyntaxbooleanNoWhether external URL syntax is checked; omit it for true.
checkInternalAnchorsbooleanNoWhether heading anchors are checked; omit it for true.
maxFindingsintegerNoFinding cap; omit it for one thousand.

Output schema

FieldTypeRequiredDescription
validbooleanYesWhether no error-severity finding exists.
linksarrayYesBounded array of discovered link receipts in document order with text, target, kind, line, and column. The item shape is defined by the nested schema and the array contains from 0 through 20000 items.
findingsarrayYesBounded array of link findings with severity, code, message, target, and optional source coordinates. The item shape is defined by the nested schema and the array contains from 0 through 20000 items.

API contract

POST /v1/execute
curl
curl -sS -X POST "$BASE/v1/execute" -H "Authorization: Bearer $KEY" -H 'Content-Type: application/json' -d '{"skillKey":"text.validate_markdown_links","input":{"markdown":"[x](#missing)"}}'
Integrations
TypeScript SDK
import { Squillify } from "@squillify/sdk";

const sq = new Squillify({ apiKey: process.env.SQUILLIFY_API_KEY });

const { output } = await sq.execute("text.validate_markdown_links", {"markdown":"# Title\n[jump](#missing)\n"});

Errors

CodeHTTPRetryableDescription
VALIDATION_ERROR400NoThe request payload failed schema validation.
UNAUTHORIZED401NoMissing or invalid API key.
SKILL_NOT_ACCESSIBLE403NoThe API key is not granted access to this skill.
SKILL_NOT_AVAILABLE_FOR_PLAN403NoThis skill is not included in your current plan.
PLAN_ELIGIBILITY_UNAVAILABLE503YesPlan eligibility could not be decided. Retry after backoff.
SKILL_NOT_FOUND404NoThe requested skill or version does not exist.
TENANT_RATE_LIMITED429YesRequest rate limit exceeded. Retry after backoff.
QUOTA_EXCEEDED429YesPlan quota exhausted. Retryable once the quota period resets.
EXECUTION_TIMEOUT504YesExecution exceeded the allowed time budget.

Other limits

LimitValue
Recommended inline bytes32 KiB

Limitations

  • Does not check whether external URLs are reachable
  • Does not fetch or crawl any URL
  • Does not render the Markdown
  • Checking external URL availability
  • Rendering Markdown to HTML

How to call

POST /v1/execute (requires authentication)

Request bodyjson
{
  "skillKey": "text.validate_markdown_links",
  "input": {
    "markdown": "# Title\n[jump](#missing)\n"
  }
}

Examples

Broken internal anchor

Inputjson
{
  "markdown": "# Title\n[jump](#missing)\n"
}
Expected outputjson
{
  "links": [
    {
      "column": 1,
      "target": "#missing",
      "kind": "inline",
      "text": "jump",
      "line": 2
    }
  ],
  "valid": false,
  "findings": [
    {
      "message": "Internal anchor not found: #missing",
      "code": "BROKEN_ANCHOR",
      "severity": "error",
      "target": "#missing",
      "column": 1,
      "line": 2
    }
  ]
}
Tip
Anchors are matched against slugs built from your headings, so "# Title" answers to #title

Valid external link syntax

Inputjson
{
  "markdown": "[docs](https://example.com/docs)"
}
Expected outputjson
{
  "links": [
    {
      "column": 1,
      "target": "https://example.com/docs",
      "kind": "inline",
      "text": "docs",
      "line": 1
    }
  ],
  "valid": true,
  "findings": []
}
Tip
Reachability is not checked — syntax only
  • Lint agent-generated documentation for broken links
  • Validate internal anchors before publishing docs
  • Catch dangerous URI schemes in Markdown

Avoid for

  • Checking external URL availability
  • Rendering Markdown to HTML

Composable with

Safety & privacy

  • Runs without calling any external service.
  • Your payloads are never stored permanently.
  • Telemetry captures metadata only — never your payload contents.
  • We never train models on your payloads.
  • No human reviews your payloads.

Tags

textvalidationparsing