Mintlify skill for Claude Code: set up, write and publish a docs site

Mintlify's own skill that teaches Claude to build, write and publish a documentation site with the Mintlify CLI.

Installs: 19.6K; on skills.sh
Stars: 460; on GitHub
Updated: Nov 2026; last commit

The mintlify skill makes Claude follow Mintlify's workflow for a docs site. It checks Node, installs or updates the mint CLI, previews with mint dev, validates with mint validate and mint broken-links, and deploys. It triggers when you ask for a docs site, a README turned into docs, an OpenAPI reference, a migration, or edits to a project with docs.json.

The skill is 21 files: SKILL.md plus 20 reference files that Claude reads only when a task needs them. Some steps change real things. Claude can install mint globally, log in to your Mintlify account, push to your connected repository, create a hosted site with mint deploy, and, if you connect the Admin MCP server, edit and publish pages. See the safety notes before you use it.

Good for

Developers who want a hosted docs site for a repo or product
Docs writers working in an existing Mintlify project with docs.json
Teams moving docs from Docusaurus, GitBook, ReadMe or Fern

Install mintlify

Claude Code

Copy this prompt.

Install the mintlify skill in Claude Code. Run this command:

npx skills@latest add https://github.com/mintlify/docs/tree/main/agent-context/context/skills/mintlify --skill mintlify

Then check that it loaded and tell me how to use it.

2
Paste it into Claude Code. It shows the change and asks before running it.

Requires Node.js.

Use the exact folder URL in the command. The skill needs the Mintlify CLI (mint, installed with npm i -g mint) for most tasks, which SKILL.md installs for you when it is missing. Pick your agent when the skills CLI asks.

From the project README. Source.

What's in the skill

When it loads

Set up, write, and publish documentation sites with Mintlify, and work on existing Mintlify projects. Use when the user wants to create a docs site for a repo or product, turn a docs/ folder or README into a hosted docs site, document an API from an OpenAPI spec, migrate docs from Docusaurus, GitBook, ReadMe, Fern, or another platform, preview docs locally, or publish docs to a shareable URL. Also use when editing a project with docs.json, including pages, navigation, components, API references, and customizing appearance or browser behavior with CSS, JavaScript, React, and snippets.

Sections in SKILL.md

Reference index
Starting a new docs site
No local repository
Migrating from another platform
MCP servers
Mintlify Search
Mintlify Admin
Before you start
File format
File naming
Internal links
Images
Page frontmatter
Common frontmatter fields
Quick component reference
Callouts

Key facts

Author: Mintlify (the mintlify/docs repository)
License: MIT
Needs: Node.js v20.17.0 or newer and the mint CLI (npm i -g mint)
Works in: The agent-context README says the skill is distributed through Codex, Cursor and Claude plugins and a Kiro power
Files: 21 files including SKILL.md: 20 reference files, 9 of them in reference/customization/
Installs on skills.sh: 19,596 as of 2026-11-02
GitHub stars: 460 for the whole mintlify/docs repo, 2026-11-02
Last repo commit: 2026-11-01
skills.sh audits: Gen Agent Trust Hub: pass, Socket: pass, Snyk: warn

What it includes

Check Node, install or update mint, log in, preview, validate, deploy
Runs mint --version, npm i -g mint when missing, mint status, mint login, mint new, mint dev --no-open, mint validate and mint broken-links. With an account it commits and pushes to the connected repository.
Try: “Turn the docs/ folder in this repo into a Mintlify docs site.”
Runs code · Start a new docs site
Create a hosted site with mint deploy, then claim it by email
Runs mint deploy --subdomain, pushes to the hosted repository, then mint claim --email. The site expires unless someone claims it, and the skill says never to invent the email.
Runs code · No-account deploy and claim
mint deploy --github writes a GitHub workflow
Writes .github/workflows/mintlify.yml. It needs a GitHub origin remote and a signed-in GitHub CLI, and works only for unclaimed sites.
Runs code · Deploy on every push
Docusaurus, GitBook, ReadMe, Fern, Document360
Uses mint migrate, mint migrate --from <platform> and mint migrate --topic <name> for the agent guides.
Runs code · Migrate from another platform
Fetch current task guidance from the live Mintlify docs
mint instructions lists topics and mint instructions <topic> fetches one. The skill says to follow it when it differs from the skill file.
Runs code · mint instructions
Read-only search of Mintlify's published docs
Three tools: search_mintlify, query_docs_filesystem_mintlify and submit_feedback, which reports an incorrect or outdated docs page.
Network · Mintlify Search MCP
Edit pages, navigation and settings; publish on request
Needs OAuth on first use. Covers branches, edit_page, write_page, create_node, delete_node, update_config, file uploads, project settings, publish and discard. The skill says to publish only when you ask.
Try: “Create a branch and add a quickstart page to my Mintlify docs.”
Delete · Mintlify Admin MCP
MDX file format, frontmatter, links, images and components
Covers callouts, steps, tabs, code groups, cards and accordions, the docs.json rule (mint.json is deprecated), and a list of common mistakes.
Write · Authoring essentials
mint validate --no-build --format json, then --fix
A fast check after edits, automatic fixes, and a full mint validate before you push.
Runs code · Validation
Second person, active voice, sentence-case headings
No marketing language, filler or emoji. Code blocks need language tags and images need alt text.
Read · Writing standards
20 files for components, navigation, API docs, CLI, widgets and more
Read only when a task needs them. They include reference/widgets.md for live React widgets, reference/writing.md and a customization folder for CSS and JavaScript.
Read · Reference files

From the official docs

Permissions

Medium risk

Claude runs terminal commands and can push code, create a hosted site and, with the Admin MCP server, edit and delete docs pages. Work on a branch, check the connected account, and publish only when you decide to.

What it can do

Read your data
Create and change things
Delete things
Read-only mode

Watch out for

Project settings change the live site at once
SKILL.md lists management tools such as update_deployment_settings, manage_custom_domain, manage_git_source, manage_access_auth and manage_members_sharing. It says these writes apply immediately to the live project, with no branch or pull request, and that a project setting change is not undone by discarding drafts (reference/publishing-and-review.md). Confirm each one before you let Claude run it. github.com
It installs a global npm tool
SKILL.md tells Claude to install mint with npm i -g mint when it is missing and to run mint update when it is present. Check the command before you approve it. github.com
It can push and deploy for you
The new-site workflow commits and pushes to your connected repository, and mint deploy creates a hosted site. Say so if you only want local edits. github.com
The Admin server can delete and publish pages
It lists delete_node, update_config and publish among its tools. The skill says to publish only when you ask, and a publish is not undone by discarding drafts. github.com
An unclaimed hosted site expires
The no-account path creates a site that expires unless claimed. Give Claude your own email for mint claim, as the skill says never to invent one. github.com

Technical details

Talks to	Mintlify (mint login, mint deploy, mint instructions, MCP servers). mintlify.com/docs. GitHub (push, and mint deploy --github)
Scopes	Runs mint, node and npm commands Commits and pushes to your connected repository Can create a hosted site with mint deploy Admin MCP server: edit, create, delete and publish pages after OAuth sign-in Admin MCP project-management tools: change domains, git source, access and members on the live project

Questions

What does the Mintlify skill do?

It teaches Claude how to set up, write, publish and edit documentation sites on Mintlify. It covers the mint CLI, docs.json, MDX components, navigation, API references from OpenAPI and migrations from other platforms.

How do I install it?

Use the install box at the top of this page. It uses the skills command from Mintlify's agent-context README with the exact skill folder URL, so you do not download the whole docs repository.

Does it need a Mintlify account or API key?

For a hosted site, yes in most cases. The skill runs mint login and tells Claude not to run mint signup itself. Without an account it can create a site with mint deploy that expires unless you claim it with your email. The Admin MCP server asks you to sign in with OAuth.

Is it safe to use?

It runs real commands. Claude can install mint globally, push commits to your connected repository, create a hosted site and write a GitHub workflow. With the Admin MCP server connected it can edit and delete pages. Use a branch and read each command. The skill says to publish only when you ask.

Does it come with the MCP servers?

The skill describes two Mintlify MCP servers, Search and Admin, and says to use them alongside the reference files. Installing the skill with the skills command adds the skill folder. The agent-context README keeps the server names and addresses in a separate file, context/mcp-servers.json, so you add the servers to your client yourself.

Does it work in the Claude app?

The install box covers Claude Code, Codex and the skills command. The skill relies on terminal commands such as mint, so the Claude app tab is left out. Mintlify's README names Codex, Cursor and Claude plugins and a Kiro power as other routes.

Information

updated Nov 2, 2026

Repository: mintlify/docs

mintlify/docs skills.sh

Sources

Docs, issue trackers and discussions this page is built from.

Show all 5

README.md · github.com
mintlify · skills.sh
SKILL.md · github.com
publishing-and-review.md · github.com
mcp-servers.json · github.com