Skip to main content
plugin

mintlify — Claude Code plugin: what it does, how to install

Equips Claude Code to build and maintain Mintlify documentation sites with correct MDX components, OpenAPI schemas, and docs.json configurations.

MIT ★ 7 updated 2026-10-23

Install into Claude Code · Plugin marketplace All methods and platforms ↓
/plugin install mintlify@claude-plugins-official
/plugin marketplace add anthropics/claude-plugins-official
Open on GitHub

What mintlify does

The plugin adds a mintlify skill and two MCP servers to Claude Code. Mintlify Search connects Claude to official reference material at https://mintlify.com/docs/mcp for checking component properties or sending docs feedback with submit_feedback.

The skill provides reference guides for components like steps, accordions, and cards, alongside docs.json settings, navigation trees, and mint CLI flags. The skill stores audience details in .mintlify/product-brief.md. Writing to projects uses the Mintlify Admin server at https://mcp.mintlify.com, which requires OAuth on first launch. While doc updates route through session branches into pull requests, configuration updates via execute_code alter the live project immediately.

What it helps with

  • Configure theme, fonts, and navigation groups in docs.json
  • Format MDX pages with tabs, callouts, steps, and code groups
  • Set up OpenAPI and AsyncAPI endpoint pages with API playgrounds
  • Store docs audience profile in .mintlify/product-brief.md

Example prompts for the agent

  • /mintlify:mintlify configure the navigation structure with tabs and groups in docs.json
  • /mintlify:mintlify convert this draft into an MDX page with steps and code groups
  • /mintlify:mintlify integrate openapi.json and set up the interactive API playground

How to install mintlify

Plugin marketplace

/plugin install mintlify@claude-plugins-official
/plugin marketplace add anthropics/claude-plugins-official

Step by step, with commands for each platform: Claude Code plugins: marketplaces, installing, and building your own

Questions about mintlify

How do I install mintlify in Claude Code?

Add the marketplace source using /plugin marketplace add anthropics/claude-plugins-official, then install the plugin by running /plugin install mintlify@claude-plugins-official.

What does the mintlify plugin do?

It gives Claude Code syntax guides for Mintlify components, configuration schemas for docs.json, and CLI parameters. It also activates two MCP servers for searching reference docs and managing project files.

How does the Mintlify Admin MCP server handle changes?

It requires OAuth authorization on its first run. Content edits are committed to a session branch to open a pull request, but project-level actions via execute_code apply directly to the live project.

Source text

SKILL.md · MIT
# Mintlify Claude plugin

A Claude Code plugin that gives Claude a comprehensive reference for building [Mintlify](https://mintlify.com) sites.

## What it does

Installs a `mintlify` skill that Claude can invoke when working on Mintlify-powered sites.

The skill covers:

- **Components** — Full syntax and props for all Mintlify components (callouts, cards, steps, tabs, accordions, code groups, fields, frames, and more)
- **Configuration** — Complete `docs.json` settings reference including theme, colors, logo, fonts, navbar, footer, redirects, integrations, and custom CSS/JS
- **Navigation** — All navigation patterns: groups, tabs, anchors, dropdowns, products, versions, and languages
- **API docs** — OpenAPI and AsyncAPI setup, endpoint pages, API playground configuration
- **CLI** — Common `mint` CLI commands and their key flags
- **Product context** — An interview that records who your docs are for in `.mintlify/product-brief.md` in your project, so later sessions don't ask again

## MCP setup

This plugin includes two Mintlify MCP servers that are activated automatically when you install the plugin.

- **Mintlify Search** (`https://mintlify.com/docs/mcp`) — Read-only access to Mintlify's published documentation. Use to look up components, config options, guides, and other reference material. Its `submit_feedback` tool sends a report about an incorrect or outdated docs page to Mintlify.
- **Mintlify Admin** (`https://mcp.mintlify.com`) — Write access to your Mintlify project. Requires OAuth on first use. Content edits go to a session branch and reach your site through a pull request. Project-level changes made through `execute_code`, such as workflows, settings, members, and integrations, apply immediately to your live project, so the skill tells Claude to confirm them with you first.

## Installation

To install the skills in this repo:

```
npx skills add mintlify/mintlify-claude-plugin
```

To install as a Claude Code plugin:

```
/plugin marketplace add mintlify/mintlify-claude-plugin
/plugin install mintlify@mintlify-marketplace
```

## Skills included

### `mintlify`

Invoke with `/mintlify:mintlify` or let Claude use it automatically when working on Mintlify projects.

The skill loads a concise core reference and routes to detailed reference files only when the task requires them:

| Reference file | Contents |
|----------------|----------|
| `reference/components.md` | All component syntax, props, and examples |
| `reference/configuration.md` | Full `docs.json` schema and frontmatter fields |
| `reference/navigation.md` | Navigation patterns and when to use each |
| `reference/api-docs.md` | API documentation setup and playground config |
| `reference/cli.md` | CLI commands and flags |
| `reference/product-context.md` | Product brief interview and how the brief is reused |

## License

MIT

© mintlify · MIT · mintlify/mintlify-claude-plugin

Similar plugins

All plugins for Writing and docs →

Project sponsors

Companies that keep this analytics open