component-reference

A reference for Mintlify documentation components, including notices, code examples, request and response examples, and other MDX building blocks. MDX is Markdown that can include interactive components.

In plain words
What is it for?
Use it when writing or updating Mintlify pages that need callouts, code samples, multi-language examples, or API request and response sections.
Why use it?
It prevents authors from guessing the syntax for documentation elements. This helps pages render consistently in a Mintlify documentation site.

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

Made for: Cursor.

Per session 2,169 This file is loaded in full into every session.
When invoked 2,169 The same file — it is already loaded in full.
Security scan B 2 findings. Scan, not verified.
Origin 88% 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.02169 $0.02169
Opus 5 $0.01085 $0.01085
Sonnet 5 $0.00434 $0.00434
Haiku 4.5 $0.00217 $0.00217

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

Security

Grade B, and why

component-reference 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

88% identical to mintlify — 250 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.

.cursor/rules/component-reference.mdc · 330 lines

How it starts

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

Mintlify component reference

docs.json schema: https://mintlify.com/docs.json

Callout components

Note - Additional helpful information
Tip - Best practices and pro tips
Warning - Important cautions
Info - Neutral contextual information
Check - Success confirmations

Code components

Single code block
const apiConfig = {
  baseURL: 'https://api.example.com',
  timeout: 5000,
  headers: {
    'Authorization': `Bearer ${process.env.API_TOKEN}`
  }
};
Code group with multiple languages
import requests
response = requests.get('/api/endpoint',
  headers={'Authorization': f'Bearer {api_key}'})
curl -X GET '/api/endpoint' \
  -H 'Authorization: Bearer YOUR_API_KEY'
Request/Response examples

Read the full file on GitHub · 330 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 · 330 lines · 2,169 tokens per session scan B 9df0ea88b0a3

Subscribe to this mod's changes

component-reference is a cursor rule published in the GitHub repository mintlify/docs (438 stars, last pushed 2d ago), licensed MIT. It adds 2,169 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). It is 88% identical to mintlify, differing in 250 lines, and is treated as a copy.