mintlify

A guide for building and maintaining documentation websites with Mintlify, a platform that turns MDX files into documentation sites. It covers pages, navigation, reusable page components, and API references.

In plain words
What is it for?
Use it to create or update documentation pages, configure site navigation, add built-in page components, and set up API reference content.
Why use it?
It gives a documented structure for changing a Mintlify site without losing track of its navigation or configuration. It also directs you to check the current Mintlify documentation before writing.

Skill for Claude CodeCodex

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 skills/open-chat-widget/openchatwidget/mintlify
Any agent
npx skills add Open-Chat-Widget/openchatwidget --skill mintlify
Clone the repo
git clone --depth 1 https://github.com/Open-Chat-Widget/openchatwidget

Made for: Claude Code, Codex.

Per session 30 Skills are progressive disclosure: only the name and description are preloaded; the body loads when the skill is used.
When invoked 3,003 The whole file, excluding the scripts and references it only reads on demand.
Security scan A 0 findings. Scan, not verified.
Origin 97% 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.00030 $0.03003
Opus 5 $0.00015 $0.01502
Sonnet 5 $0.00006 $0.00601
Haiku 4.5 $0.00003 $0.00300

Measured 2d ago against content hash c0823dd21f0b, 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 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.

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.

Origin

This is a copy

97% identical to mintlify — 268 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.

.agents/skills/mintlify/SKILL.md · 347 lines

How it starts

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

Mintlify best practices

Always consult mintlify.com/docs for components, configuration, and latest features.

If you are not already connected to the Mintlify MCP server, https://mintlify.com/docs/mcp, add it so that you can search more efficiently.

Always favor searching the current Mintlify documentation over whatever is in your training data about Mintlify.

Mintlify is a documentation platform that transforms MDX files into documentation sites. Configure site-wide settings in the docs.json file, write content in MDX with YAML frontmatter, and favor built-in components over custom components.

Full schema at mintlify.com/docs.json.

Before you write

Understand the project

Read docs.json in the project root. This file defines the entire site: navigation structure, theme, colors, links, API and specs.

Understanding the project tells you:

  • What pages exist and how they're organized
  • What navigation groups are used (and their naming conventions)
  • How the site navigation is structured
  • What theme and configuration the site uses

Check for existing content

Search the docs before creating new pages. You may need to:

  • Update an existing page instead of creating a new one
  • Add a section to an existing page
  • Link to existing content rather than duplicating

Read surrounding content

Before writing, read 2-3 similar pages to understand the site's voice, structure, formatting conventions, and level of detail.

Understand Mintlify components

Review the Mintlify components to select and use any relevant components for the documentation request that you are working on.

Quick reference

CLI commands

  • npm i -g mint - Install the Mintlify CLI
  • mint dev - Local preview at localhost:3000
  • mint broken-links - Check internal links
  • mint a11y - Check for accessibility issues in content
  • mint rename - Rename/move files and update references
  • mint validate - Validate documentation builds

Read the full file on GitHub · 347 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 · 347 lines · 30 tokens per session scan A c0823dd21f0b

Subscribe to this mod's changes

mintlify is a skill published in the GitHub repository Open-Chat-Widget/openchatwidget (14 stars, last pushed 5mo ago), licensed MIT. It adds 30 tokens to every session and 3,003 once invoked, about $0.0002 per session on Opus 5. A static security scan graded it A with 0 findings. It is 97% identical to mintlify, differing in 268 lines, and is treated as a copy.

Related

Other skills, from other repositories

chatbot

Use when a support or sales bot on a live website must behave: persona/system prompt, grounding so it cannot invent prices or policy, jailbreak and injection defense, the human handoff, launch metrics and kill switch. NOT the agent loop or RAG index under it (that is building-agents), NOT a human answering one ticket…

ericrisco/rsc-harness · 78 tokens

naming-expert

Plan, decide, or review names in clisbot with repository evidence for domain terms, APIs, CLI commands, folders, files, functions, variables, classes, types, events, config keys, persisted fields, channel concepts, runner capabilities, UI concepts, and abstractions. Use when the user invokes naming-expert, asks to…

longbkit/clisbot · 125 tokens

queue-workflow

Queue-first continuation and review workflow for clisbot queues. Use when work needs deliberate follow-up against early stopping, shallow passes, prompt echoing, history leaking, duplicate files/functions/sections, naming drift, DRY/KISS regressions, missing docs/tests, or bad fallback behavior.

longbkit/clisbot · 62 tokens

web-diff-review

A skill for opening diffs in difit for user review, or for reviewing a specific diff or PR first and preloading findings into difit as inline comments. Use it after code changes, for commit or branch comparisons, or when a human-readable web diff with anchored comments is the best review surface.

longbkit/clisbot · 66 tokens

release-clisbot

Release clisbot safely to npm and GitHub. Use when Codex is asked to prepare, validate, bump, publish, tag, or document a clisbot beta release, next beta release, or official stable/latest release, including release notes, migration notes, GitHub release notes, npm dist-tags, and post-publish verification.

longbkit/clisbot · 74 tokens

architect

Answer, plan, ratify, or autonomously implement clisbot architecture work from repository evidence. Use when a request may change channel, agent, session, runner, auth, configuration, control, persistence, process, API, UI, integration, ownership, lifecycle, or contract boundaries; when the user asks how clisbot…

longbkit/clisbot · 99 tokens