Skip to main content
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.
Both llms.txt and skill.md files help agents work with your documentation, but they serve different purposes.
  • llms.txt is a directory. It lists all your documentation pages with descriptions so agents know where to find information.
  • skill.md is a capability summary. It tells agents what they can accomplish with your product, what inputs they need, and what constraints apply.

​
Use skill.md files with agents

If you use a reverse proxy, configure it to forward /skill.md and /.well-known/skills/* paths to your Mintlify subdomain.
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.
Teach your users how to use skill.md files with agents so that they have better results using your product with their AI tools.

​
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.
FieldTypeDescription
namestringThe name of your skill.
descriptionstringA brief description of what your skill does.
licensestringThe license for your skill (for example, MIT or Apache-2.0).
compatibilitystringRequirements or compatibility notes (for example, runtime dependencies).
metadataobjectAdditional metadata as string key-value pairs (for example, author or version).
allowed-toolsstringSpace-delimited list of pre-approved tools the skill may use (experimental).
Example frontmatter
---
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"
---

​
Skills discovery endpoints

Mintlify hosts a skills directory at /.well-known/skills/ that agents can use to discover and fetch your skill files programmatically.

​
Skills index

GET /.well-known/skills/index.json returns a JSON manifest listing all available skills: 
{
  "skills": [
    {
      "name": "my-product",
      "description": "A brief description of what your skill does.",
      "files": ["SKILL.md"]
    }
  ]
}
The name field is a URL-safe slug derived from the name in your skill.md frontmatter.

​
Individual skill files

GET /.well-known/skills/{name}/skill.md returns the skill.md file for a specific skill identified by its slugified name from the index.