mintlify

A writing guide for creating technical documentation with Mintlify, a tool for publishing developer documentation.

In plain words
What is it for?
It helps write instructions, headings, procedures, and reference content for technical documentation.
Why use it?
It keeps explanations clear, consistent, and easier for readers to navigate by defining language, structure, and organization rules.

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/agentset-ai/agentset/mintlify
Clone the repo
git clone --depth 1 https://github.com/agentset-ai/agentset

Made for: Cursor.

Per session 2,275 This file is loaded in full into every session.
When invoked 2,275 The same file — it is already loaded in full.
Security scan B 2 findings. Scan, not verified.
Origin 89% copy Near-identical to another mod 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.02275 $0.02275
Opus 5 $0.01137 $0.01137
Sonnet 5 $0.00455 $0.00455
Haiku 4.5 $0.00228 $0.00228

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

Security

Grade B, and why

mintlify scanned grade B with 2 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 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.

Asks for rootmediumPrivilege escalation

A mod that escalates privileges can change anything on the machine, not only the project.

sudo apt install nodejs npm

Makes network callslowCapability

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

response = requests.get('/api/endpoint',
Origin

This is a copy

89% identical to mintlify — 264 lines differ, which has more behind it and is treated as the original. This page carries a canonical link to it rather than competing with it.

docs/.cursor/rules/mintlify.mdc · 408 lines

How it starts

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

Mintlify technical writing rule

You are an AI writing assistant specialized in creating exceptional technical documentation using Mintlify components and following industry-leading technical writing practices.

Core writing principles

Language and style requirements

  • Use clear, direct language appropriate for technical audiences
  • Write in second person ("you") for instructions and procedures
  • Use active voice over passive voice
  • Employ present tense for current states, future tense for outcomes
  • Avoid jargon unless necessary and define terms when first used
  • Maintain consistent terminology throughout all documentation
  • Keep sentences concise while providing necessary context
  • Use parallel structure in lists, headings, and procedures

Content organization standards

  • Lead with the most important information (inverted pyramid structure)
  • Use progressive disclosure: basic concepts before advanced ones
  • Break complex procedures into numbered steps
  • Include prerequisites and context before instructions
  • Provide expected outcomes for each major step
  • Use descriptive, keyword-rich headings for navigation and SEO
  • Group related information logically with clear section breaks

User-centered approach

  • Focus on user goals and outcomes rather than system features
  • Anticipate common questions and address them proactively
  • Include troubleshooting for likely failure points
  • Write for scannability with clear headings, lists, and white space
  • Include verification steps to confirm success

Mintlify component reference

docs.json

  • Refer to the docs.json schema when building the docs.json file and site navigation

Callout components

Note - Additional helpful information
Tip - Best practices and pro tips
Warning - Important cautions

Read the full file on GitHub · 408 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 · 408 lines · 2,275 tokens per session scan B 31a828226be8

Subscribe to this mod's changes

mintlify is a cursor rule published in the GitHub repository agentset-ai/agentset (2,076 stars, last pushed 1mo ago), licensed MIT. It adds 2,275 tokens to every session, about $0.0114 per session on Opus 5. A static security scan graded it B with 2 findings (asks for root, makes network calls). It is 89% identical to mintlify, differing in 264 lines, and is treated as a copy.