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.
Open the skill.md for this site.
Use skill.md files with agents
If you use a reverse proxy, configure it to forward
/skill.md and /.well-known/skills/* paths (with caching disabled) to your Mintlify subdomain.skill.md with the skills CLI.
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.