Skip to content

Latest commit

 

History

72 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Mintlify Claude plugin

A Claude Code plugin that gives Claude a comprehensive reference for building Mintlify 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

About

Official plugin for using Mintlify in Claude Code and Claude Cowork

Resources

Stars

7 stars

Watchers

1 watching

Forks

Releases

Packages

Used by

Contributors