mintlify

A set of writing and file-management rules for Mintlify documentation sites. Mintlify is a platform for publishing developer documentation.

In plain words
What is it for?
Use it when adding or editing Mintlify pages, checking site navigation, matching existing documentation style, writing metadata, and handling internal links or images.
Why use it?
It prevents common site problems such as using the wrong configuration filename, creating pages that are not in navigation, or writing links and image references in the wrong format.

Cursor rule

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/mintlify/cursor-plugin/mintlify
Clone the repo
git clone --depth 1 https://github.com/mintlify/cursor-plugin
Per session 0 Nothing until a file matches its globs; then the whole rule loads.
When invoked 692 The whole file, excluding the scripts and references it only reads on demand.
Security scan A 0 findings. 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.00692
Opus 5 $0.00000 $0.00346
Sonnet 5 $0.00000 $0.00138
Haiku 4.5 $0.00000 $0.00069

Measured yesterday against content hash 352c2cc941d9, method: parsed. Prices are Anthropic first-party input rates as of 2026-08-30, from the pricing page.

Security

Grade A, and why

mintlify scanned grade A with 0 findings 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 yesterday.

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.

Nothing flagged

None of the 26 patterns this scan looks for appear in this file: no shell pipes, no recursive deletes, no credential paths, no hidden text, no instruction-override or anti-refusal phrasing, no agent-config snooping. That is not a guarantee, it is the absence of the things that are checkable.

rules/mintlify.mdc · 78 lines

How it starts

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

Mintlify rules

Before you start

Read the project's docs.json file first. It defines the site's navigation, theme, colors, and configuration.

Search for existing content before creating new pages. You may need to update an existing page, add a section, or link to existing content rather than duplicating.

Read 2-3 similar pages to match the site's voice, structure, and formatting.

File conventions

  • Config file is always docs.json — never mint.json (deprecated)
  • File naming: match existing patterns; default to kebab-case (getting-started.mdx)
  • New pages must be added to docs.json navigation or they won't appear in the sidebar

Internal links

  • Use root-relative paths without file extensions: /getting-started/quickstart
  • Do not use relative paths (../) or absolute URLs for internal pages

Images

Store images in an images/ directory. Reference with root-relative paths. All images require descriptive alt text.

![Dashboard showing analytics overview](/images/dashboard.png)

Page frontmatter

Every page requires title. Include description and keywords for SEO.

---
title: "Clear, descriptive title"
description: "Concise summary for SEO and navigation."
keywords: ["relevant", "search", "terms"]
---
Field Type Required Description
title string Yes Page title in navigation and browser tabs.
description string No Brief description for SEO. Displays under the title.
sidebarTitle string No Short title for sidebar navigation.
icon string No Lucide, Font Awesome, or Tabler icon name. Also accepts a URL or file path.
tag string No Label next to page title in sidebar (e.g., "NEW").
hidden boolean No Remove from sidebar. Page still accessible by URL.
mode string No Page layout: default, wide, custom, frame, center.
keywords array No Search terms for internal search and SEO.

Read the full file on GitHub · 78 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. yesterday First seen · 78 lines · 0 tokens per session scan A 352c2cc941d9

Subscribe to this mod's changes

mintlify is a cursor rule published in the GitHub repository mintlify/cursor-plugin (1 stars, last pushed 4d ago), licensed MIT. It costs nothing until one of its globs matches a file; then it loads 692 tokens. A static security scan graded it A with 0 findings. No closer match exists in the catalogue, so it is treated as the original; first seen 2026-08-31.