What is 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.

Use it when writing or updating Mintlify pages that need callouts, code samples, multi-language examples, or API request and response sections.

It prevents authors from guessing the syntax for documentation elements. This helps pages render consistently in a Mintlify documentation site.

component-reference — Cursor rule for Cursor by mintlify/docs

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.

Clone the repo

git clone --depth 1 https://github.com/mintlify/docs

Made for: Cursor.

Wrote this? Show the measurements

A badge with what this costs and how it scanned, read live from this page, so it follows the numbers instead of freezing them. Markdown for a README, HTML for a documentation site or a project page.

README.md

[![agentmods](https://agentmods.dev/badge/rules/mintlify/docs/component-reference/github.svg)](https://agentmods.dev/rules/mintlify/docs/component-reference)

Your own site

<a href="https://agentmods.dev/rules/mintlify/docs/component-reference"><img src="https://agentmods.dev/badge/rules/mintlify/docs/component-reference/github.svg" alt="Measured on agentmods" height="20"></a>

Or the 80×15 button, for a site that already has a row of RSS and ATOM ones. Only the verdict fits; the numbers stay here.

Your own site · 80×15

<a href="https://agentmods.dev/rules/mintlify/docs/component-reference"><img src="https://agentmods.dev/badge/rules/mintlify/docs/component-reference.svg" alt="Reviewed on agentmods" width="80" height="20"></a>

Per session 1,418 This file is loaded in full into every session.

When invoked 1,418 The same file — it is already loaded in full.

Security scan B 2 findings. A grade says what 26 rules found in the file — not that it is safe.

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.

Model	Per session	Once invoked
Fable 5.1	$0.01418	$0.01418
Opus 5.5	$0.00567	$0.00567
Sonnet 5.5	$0.00284	$0.00284
Haiku 4.5	$0.00142	$0.00142

Measured 21d ago against content hash 45879dc20423, method: parsed. Prices are Anthropic first-party input rates as of 2026-10-07, 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 21d 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 — 258 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 · 250 lines

How it starts

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

Mintlify component reference

Syntax examples for Mintlify components. For when to use each component, and for all other writing and formatting rules, follow style-guide/formatting-and-components.md.

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

Callout components

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

Structural components

Steps for procedures

API_KEY=your_api_key_here

Read the full file on GitHub · 250 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.

21d ago Changed · -80 lines · -751 tokens per session 45879dc20423
1mo 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 (457 stars, last pushed today), licensed MIT. It adds 1,418 tokens to every session, about $0.0057 per session on Opus 5.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 258 lines, and is treated as a copy.

Writing and docs

component-reference