md-lint

Rules and instructions for checking Markdown, YAML, JSON, and security-related documentation files. The documented linting process uses Docker and the project's `yarn lint` command, with manual fixes when Docker is unavailable.

In plain words
What is it for?
Use it when writing or reviewing Markdown documentation and related YAML or JSON files, or when running the project's documentation linter.
Why use it?
It helps catch formatting, structure, and some security problems in project documentation before they create review or build issues.

Cursor rule for Cursor

Install

Getting it into your agent

One page per mod, every tool's command on it. A separate URL per tool would split the same page into five that compete with each other.

agentmods
npx agentmods add rules/adobedocs/ff-services-docs/md-lint
Clone the repo
git clone --depth 1 https://github.com/AdobeDocs/ff-services-docs

Made for: Cursor.

Per session 0 Nothing until a file matches its globs; then the whole rule loads.
When invoked 2,147 The whole file, excluding the scripts and references it only reads on demand.
Security scan A 1 finding. Scan, not verified.
Origin original No closer match found in the catalogue.
Token cost

What it costs to keep this loaded

Counted locally with the o200k_base tokenizer, which is exact for GPT models; Claude uses its own tokenizer and its counts differ. Treat this as one consistent yardstick across the catalogue rather than a bill. Prices are per million input tokens.

ModelPer sessionOnce invoked
Fable 5 $0.00000 $0.02147
Opus 5 $0.00000 $0.01073
Sonnet 5 $0.00000 $0.00429
Haiku 4.5 $0.00000 $0.00215

Measured 2d ago against content hash cecac6c9dc66, method: parsed. Prices are Anthropic first-party input rates as of 2026-08-30, from the pricing page.

Security

Grade A, and why

md-lint scanned grade A with 1 finding against 26 rules in 11 categories — prompt injection, anti-refusal, data exfiltration, privilege escalation, supply chain, agent snooping, system-prompt leakage, SSRF and excessive agency — measured 2d ago.

A static scan of the body, not an audit. Every finding is printed with the line that produced it so you can judge whether it matters here. A mod is markdown that instructs an agent; that is exactly why what it instructs is worth reading.

Makes network callslowCapability

Not a fault in itself. Listed so you know the mod talks to something, and to what.

curl -X POST https://api.example.com/endpoint \
.cursor/rules/md-lint.mdc · 379 lines

How it starts

The opening of the file, as written. The whole thing — 379 lines — stays where its author put it; the contents beside it link to each section on GitHub.

Documentation Linting Rules

Overview

This document outlines the linting rules and best practices for maintaining high-quality documentation in our project.

Linting Process

Running the Linter

⚠️ Prerequisite Check: Docker Availability

Before running the linter, always check if Docker is running:

# Check Docker status
docker info > /dev/null 2>&1

# If the above command fails, Docker is not running
if [ $? -ne 0 ]; then
    echo "❌ Docker is not running!"
    echo "Please start Docker Desktop and try again."
    echo ""
    read -p "Continue with manual linting fixes? (Y/N): " -n 1 -r
    echo
    if [[ ! $REPLY =~ ^[Yy]$ ]]; then
        echo "Exiting. Please start Docker and run 'yarn lint' again."
        exit 1
    fi
    echo "Proceeding with manual linting fixes..."
fi

Then run the linter:

yarn lint

Note: This command requires Docker to be installed and running. If Docker is not available, you can:

  1. Start Docker Desktop manually
  2. Or use the manual linting fixes described in the "Automated Fixes" section below

The linter checks:

  • Markdown files (markdownlint)
  • YAML files (yamllint)
  • JSON files (jsonlint)
  • Security issues (gitleaks)

Link Validation

After successful linting, validate all links in the documentation:

yarn test:links

The link validator checks:

  • Internal links (anchors, file references)
  • External links (URLs)
  • Relative path references
  • Broken or inaccessible links

Note: Link validation should be run AFTER linting is successful, as it depends on properly formatted markdown files.

Link Validation Errors and Resolution

Common Link Issues:

  1. Broken Internal Links

    • Missing anchor references
    • Incorrect file paths
    • Case sensitivity issues
  2. Broken External Links

    • URLs that no longer exist
    • Network connectivity issues
    • Rate limiting from external sites
  3. Relative Path Issues

    • Incorrect relative paths
    • Missing files referenced in links

Read the full file on GitHub · 379 lines

Changes

What this file has done since we first saw it

Hashed on every crawl. A supply-chain change to an agent config is a question of when, not whether, so the history is kept rather than the latest state alone.

  1. 2d ago First seen · 379 lines · 2,147 tokens per session scan A cecac6c9dc66

Subscribe to this mod's changes

md-lint is a cursor rule published in the GitHub repository AdobeDocs/ff-services-docs (4 stars, last pushed 2mo ago), licensed Apache-2.0. It costs nothing until one of its globs matches a file; then it loads 2,147 tokens. A static security scan graded it A with 1 finding (makes network calls). No closer match exists in the catalogue, so it is treated as the original; first seen 2026-08-31.