mintlify_skill

Overview

This skill provides comprehensive, ready-to-use documentation for Mintlify Docs, focused on agents, AI features, API playgrounds, authentication personalization, and UI components. It consolidates guidance for building, configuring, and deploying documentation-powered agents and interactive API references. Use it to accelerate integration of Mintlify features into your docs and developer workflows.

How this skill works

The skill inspects Mintlify’s docs content and surfaces targeted instructions, examples, and configuration snippets for relevant features (agents, assistant configuration, API playgrounds, auth, and components). It maps user questions to the appropriate documentation topics and returns concise implementation steps, recommended settings, and example code patterns. When needed, it combines multiple sections to cover end-to-end flows like creating an agent, protecting pages, and embedding interactive API demos.

When to use it

• You need to configure or customize a Mintlify agent or assistant behavior.
• You want to add an API playground or SDK examples to documentation pages.
• You need guidance on authentication, access controls, or personalization for docs pages.
• You’re embedding UI components (accordions, snippets, demos) into docs pages.
• You want best-practice deployment and preview workflows for documentation.

Best practices

• Start by defining the agent’s scope and user intents before writing AGENTS.md or assistant config.
• Use the API playground to surface runnable SDK examples and AsyncAPI files for interactive endpoints.
• Protect sensitive docs with group-based access and test public/private flows in preview deployments.
• Prefer small, focused components (accordions, snippets) with clear props and examples for reuse.
• Keep changelogs and release notes in a dedicated create flow and connect session recordings or analytics to measure adoption.

Example use cases

• Create an assistant that answers product API questions using a dedicated AGENTS.md and example prompts.
• Embed an API playground with SDK and WebSocket examples so users can run calls in-browser.
• Configure authentication so internal docs are group-restricted while public pages remain accessible.
• Add accordion-based component docs with properties, usage examples, and code samples for a design system.
• Set up preview deployments to validate changes and let stakeholders review before publishing.