skill.md - Mintlify
Mintlify hosts a skill.md file at the root of your project that describes what AI agents can do with your product.
The skill.md specification is a structured, machine-readable format that makes capabilities, required inputs, and constraints for products explicit so that agents can use them more reliably.
Mintlify automatically generates a skill.md file for your project by analyzing your documentation with an agentic loop. This file stays up to date as you make updates to your documentation and requires no maintenance. You can optionally add a custom skill.md file to the root of your project that overrides the automatically generated one.
View your skill.md by appending /skill.md to your documentation site’s URL. Mintlify only generates skill.md files for documentation sites that are public.
Use skill.md files with agents
Agents can process your skill.md with the skills CLI.
npx skills add https://your-docs-domain.com
This adds your product’s capabilities to the agent’s context so it can take actions on behalf of users.
skill.md structure
Mintlify generates a skill.md file following the agentskills.io specification. The generated file includes:
- Metadata: Project name, description, and version.
- Capabilities: What agents can accomplish with your product.
- Skills: Specific actions organized by category.
- Workflows: Step-by-step procedures for common tasks.
- Integration: Supported tools and services.
- Context: Background on your product’s architecture.
Custom skill.md files
Add a skill.md file to the root of your project to override the automatically generated file. If you delete a custom file, Mintlify generates a new skill.md file.
Write a custom file when you want precise control over how agents interact with your product. Follow the agentskills.io specification to ensure compatibility with agent tooling.
Frontmatter fields
Custom skill.md files must start with YAML frontmatter.
| Field | Type | Description |
|---|---|---|
name | string | The name of your skill. |
description | string | A brief description of what your skill does. |
license | string | The license for your skill (for example, MIT or Apache-2.0). |
compatibility | string | Requirements or compatibility notes (for example, runtime dependencies). |
metadata | object | Additional metadata as string key-value pairs (for example, author or version). |
allowed-tools | string | Space-delimited list of pre-approved tools the skill may use (experimental). |
---
name: mintlify
description: Build and maintain documentation sites with Mintlify. Use when creating docs pages, configuring navigation, adding components, or setting up API references.
license: MIT
compatibility: Requires Node.js for CLI. Works with any Git-based workflow.
metadata:
author: mintlify
version: "1.0"
---