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
29 changes: 27 additions & 2 deletions ai/skillmd.mdx
Original file line number Diff line number Diff line change
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 @@ -56,13 +56,38 @@

## Custom `skill.md` files

Write custom skill 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 file

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](https://agentskills.io/specification) to ensure compatibility with agent tooling.
### Multiple skill files

Add multiple skill files to the `.mintlify/skills/` directory when your product has distinct capabilities that benefit from separate skill definitions. Each skill lives in its own subdirectory with a `SKILL.md` file:

```
.mintlify/
skills/
api-reference/
SKILL.md
cli-tools/
SKILL.md
integrations/
SKILL.md
```

Mintlify sanitizes the subdirectory name into a URL-safe slug by lowercasing it and replacing non-alphanumeric characters with hyphens (for example, `API Reference` becomes `api-reference`). Each `SKILL.md` file can include frontmatter with `name` and `description` fields to provide additional metadata. If multiple skill files resolve to the same slug, only the last one is used. During deployment, Mintlify uploads each skill and generates a `skills/index.json` manifest automatically.

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

Did you really mean 'lowercasing'?

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 ('is used').

When a `.mintlify/skills/` directory with valid skill files is present, Mintlify skips automatic AI skill generation and uses your custom skills instead. If you remove the `.mintlify/skills/` directory, Mintlify resumes AI-generated skill creation on the next deployment.

<Note>
You can use both approaches simultaneously. A root `skill.md` file is detected alongside `.mintlify/skills/` entries, but the presence of custom skills in `.mintlify/skills/` prevents AI-generated skill replacement.

Check warning on line 85 in ai/skillmd.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/skillmd.mdx#L85

In general, use active voice instead of passive voice ('is detected').
</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