Skip to content
Closed
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 29 additions & 6 deletions ai/skillmd.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -8,13 +8,13 @@

The [skill.md specification](https://agentskills.io/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.
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 to override the auto-generated one, or define [multiple skills](#multiple-skills) using the `.mintlify/skills/` directory.

<Note>
Generating or updating a `skill.md` file can take up to 24 hours.
</Note>

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.
View your `skill.md` by appending `/skill.md` to your documentation site's URL. When your project has [multiple skills](#multiple-skills), `/skill.md` redirects to `/.well-known/skills/index.json` so agents can discover all available skills. Mintlify only generates `skill.md` files for documentation sites that are public.

<PreviewButton href="https://mintlify.com/docs/skill.md">Open the skill.md for this site.</PreviewButton>

Expand Down Expand Up @@ -43,7 +43,7 @@
Teach your users how to use `skill.md` files with agents so that they have better results using your product with their AI tools.
</Tip>

## `skill.md` structure

Check warning on line 46 in ai/skillmd.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/skillmd.mdx#L46

'structure' should use sentence-style capitalization.

Mintlify generates a `skill.md` file following the [agentskills.io specification](https://agentskills.io/specification). The generated file includes:

Expand All @@ -54,15 +54,38 @@
- **Integration**: Supported tools and services.
- **Context**: Background on your product's architecture.

## Custom `skill.md` files
## Custom skill 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.
Add custom skill files to override the automatically generated skill. If you delete all custom files, 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](https://agentskills.io/specification) to ensure compatibility with agent tooling.
Write custom files when you want precise control over how agents interact with your product. Follow the [agentskills.io specification](https://agentskills.io/specification) to ensure compatibility with agent tooling.

### Single skill

Add a `skill.md` file to the root of your project to override the auto-generated skill. This is the simplest approach when your product has one skill.

### Multiple skills

To define multiple skills, create a `.mintlify/skills/` directory with a subdirectory for each skill:

```
.mintlify/
skills/
my-first-skill/
SKILL.md
my-second-skill/
SKILL.md
```

Each `SKILL.md` file follows the same format as a root `skill.md`. When multiple skills are defined, the `/skill.md` endpoint redirects to `/.well-known/skills/index.json` so agents can discover all available skills.

Check warning on line 80 in ai/skillmd.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/skillmd.mdx#L80

In general, use active voice instead of passive voice ('are defined').

<Note>
If both a root `skill.md` and `.mintlify/skills/` directory exist, the multi-skill directory takes precedence.
</Note>

### Frontmatter fields

Custom `skill.md` files must start with YAML frontmatter.
Custom skill files must start with YAML frontmatter.

| Field | Type | Description |
| --------------- | ------ | ----------------------------------------------------------------------------------- |
Expand Down
Loading