mintlify

A set of writing rules for creating technical documentation with Mintlify, a documentation platform. It covers clear language, structure, terminology, instructions, headings, and the use of documentation components.

In plain words
What is it for?
Use it to write or review developer documentation, including instructions, headings, procedures, lists, and pages built with Mintlify components.
Why use it?
It helps make technical documentation easier to understand and navigate. It gives writers consistent guidance for explaining procedures, prerequisites, outcomes, and complex information.

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

Made for: Cursor.

Per session 2,162 This file is loaded in full into every session.
When invoked 2,162 The same file — it is already loaded in full.
Security scan B 2 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.02162 $0.02162
Opus 5 $0.01081 $0.01081
Sonnet 5 $0.00432 $0.00432
Haiku 4.5 $0.00216 $0.00216

Measured yesterday against content hash f9c0317c1bc7, 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 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.

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',
.cursor/rules/mintlify.mdc · 384 lines

How it starts

The opening of the file, as written. The whole thing — 384 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 · 384 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 · 384 lines · 2,162 tokens per session scan B f9c0317c1bc7

Subscribe to this mod's changes

mintlify is a cursor rule published in the GitHub repository redongreen/uSpec (239 stars, last pushed 1mo ago), licensed MIT. It adds 2,162 tokens to every session, about $0.0108 per session on Opus 5. A static security scan graded it B with 2 findings (asks for root, makes network calls). No closer match exists in the catalogue, so it is treated as the original; first seen 2026-08-30.