mirror of
https://github.com/mintlify/docs.git
synced 2026-09-14 13:35:46 +08:00
mintlify[bot]
2a072981b4
* Document /.well-known/agent-skills discovery endpoint Generated-By: mintlify-agent * Update skillmd.mdx --------- Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com> Co-authored-by: Ethan Palm <56270045+ethanpalm@users.noreply.github.com>
163 lines
8.3 KiB
Plaintext
163 lines
8.3 KiB
Plaintext
---
|
|
title: "skill.md"
|
|
description: "Générez automatiquement des fichiers skill.md décrivant les capacités de votre produit pour les agents d'IA."
|
|
keywords: ["agents IA", "compétences", "compétences d'agent", "agents"]
|
|
---
|
|
|
|
Mintlify héberge un fichier `skill.md` à la racine de votre projet qui décrit ce que les agents d'IA peuvent faire avec votre produit.
|
|
|
|
La [spécification skill.md](https://agentskills.io/specification) est un format structuré et lisible par les machines qui rend explicites les capacités, les entrées requises et les contraintes des produits afin que les agents puissent les utiliser de manière plus fiable.
|
|
|
|
Mintlify génère automatiquement un fichier `skill.md` pour votre projet en analysant votre documentation avec une boucle pilotée par des agents. Ce fichier reste à jour à mesure que vous mettez à jour votre documentation et ne nécessite aucune maintenance. Vous pouvez également ajouter un fichier `skill.md` personnalisé à la racine de votre projet qui remplace celui généré automatiquement.
|
|
|
|
Affichez votre `skill.md` en ajoutant `/skill.md` à l'URL de votre site de documentation. Mintlify ne génère des fichiers `skill.md` que pour les sites de documentation publics.
|
|
|
|
<PreviewButton href="https://mintlify.com/docs/skill.md">Ouvrir le skill.md de ce site.</PreviewButton>
|
|
|
|
<Tip>
|
|
Les fichiers `llms.txt` et `skill.md` aident tous deux les agents à travailler avec votre documentation, mais ils ont des objectifs différents.
|
|
|
|
* `llms.txt` est un index. Il répertorie toutes les pages de votre documentation avec des descriptions pour que les agents sachent où trouver l'information.
|
|
* `skill.md` est un résumé de capacités. Il indique aux agents ce qu'ils peuvent accomplir avec votre produit, quelles entrées sont nécessaires et quelles contraintes s'appliquent.
|
|
</Tip>
|
|
|
|
<div id="use-skillmd-files-with-agents">
|
|
## Utiliser les fichiers `skill.md` avec des agents
|
|
</div>
|
|
|
|
<Note>
|
|
Si vous utilisez un [proxy inverse](/fr/deploy/reverse-proxy), configurez-le pour qu'il redirige les chemins `/skill.md`, `/.well-known/skills/*` et `/.well-known/agent-skills/*` vers votre sous-domaine Mintlify.
|
|
</Note>
|
|
|
|
Les agents peuvent traiter votre fichier `skill.md` avec la [CLI skills](https://www.npmjs.com/package/skills).
|
|
|
|
```bash
|
|
npx skills add https://your-docs-domain.com
|
|
```
|
|
|
|
Cela ajoute les capacités de votre produit au contexte de l'agent afin qu'il puisse effectuer des actions au nom des utilisateurs.
|
|
|
|
<Tip>
|
|
Expliquez à vos utilisateurs comment utiliser les fichiers `skill.md` avec des agents afin qu'ils obtiennent de meilleurs résultats en utilisant votre produit avec leurs outils d'IA.
|
|
</Tip>
|
|
|
|
<div id="skillmd-structure">
|
|
## Structure de `skill.md`
|
|
</div>
|
|
|
|
Mintlify génère un fichier `skill.md` selon la [spécification agentskills.io](https://agentskills.io/specification). Le fichier généré comprend :
|
|
|
|
* **Metadata** : nom du projet, description et version.
|
|
* **Capacités** : ce que les agents peuvent accomplir avec votre produit.
|
|
* **Compétences** : actions spécifiques organisées par catégorie.
|
|
* **Flux de travail** : procédures étape par étape pour les tâches courantes.
|
|
* **Intégrations** : outils et services pris en charge.
|
|
* **Contexte** : informations générales sur l'architecture de votre produit.
|
|
|
|
<div id="custom-skillmd-files">
|
|
## Fichiers `skill.md` personnalisés
|
|
</div>
|
|
|
|
Ajoutez un fichier `skill.md` à la racine de votre projet pour remplacer le fichier généré automatiquement. Si vous supprimez un fichier personnalisé, Mintlify génère un nouveau fichier `skill.md`.
|
|
|
|
Rédigez un fichier personnalisé si vous souhaitez un contrôle précis sur la manière dont les agents interagissent avec votre produit. Suivez la [spécification agentskills.io](https://agentskills.io/specification) pour garantir la compatibilité avec les outils des agents.
|
|
|
|
<div id="frontmatter-fields">
|
|
### Champs de frontmatter
|
|
</div>
|
|
|
|
Les fichiers `skill.md` personnalisés doivent commencer par un frontmatter YAML.
|
|
|
|
| Nom du champ | Type | Description |
|
|
| --------------- | ------ | --------------------------------------------------------------------------------------------------------------------------- |
|
|
| `name` | string | Le nom de votre skill. |
|
|
| `description` | string | Une brève description de ce que fait votre skill. |
|
|
| `license` | string | La licence de votre skill (par exemple : `MIT` ou `Apache-2.0`). |
|
|
| `compatibility` | string | Exigences ou notes de compatibilité (par exemple : dépendances d'exécution). |
|
|
| `metadata` | object | Métadonnées supplémentaires sous forme de paires clé-valeur de chaînes de caractères (par exemple : `author` ou `version`). |
|
|
| `allowed-tools` | string | Liste, séparée par des espaces, des outils préautorisés que le skill peut utiliser (expérimental). |
|
|
|
|
```md Example frontmatter
|
|
---
|
|
name: mintlify
|
|
description: Créez et maintenez des sites de documentation avec Mintlify. À utiliser lors de la création de pages de documentation, de la configuration de la navigation, de l'ajout de composants ou de la mise en place de références API.
|
|
license: MIT
|
|
compatibility: Nécessite Node.js pour l'interface en ligne de commande (CLI). Fonctionne avec tout workflow basé sur Git.
|
|
metadata:
|
|
author: mintlify
|
|
version: "1.0"
|
|
---
|
|
```
|
|
|
|
<div id="skills-discovery-endpoints">
|
|
## Endpoints de découverte des skills
|
|
</div>
|
|
|
|
Mintlify héberge des répertoires de skills à `/.well-known/skills/` et `/.well-known/agent-skills/` que les agents peuvent utiliser pour découvrir et récupérer vos fichiers de skills de manière programmatique.
|
|
|
|
<Note>
|
|
Si vous utilisez un [proxy inverse](/fr/deploy/reverse-proxy), configurez-le pour qu'il redirige les chemins `/.well-known/skills/*` et `/.well-known/agent-skills/*` vers votre sous-domaine Mintlify.
|
|
</Note>
|
|
|
|
<div id="agent-skills-discovery">
|
|
### Découverte agent-skills (recommandé)
|
|
</div>
|
|
|
|
L'endpoint `/.well-known/agent-skills/` suit la [spécification agent-skills discovery 0.2.0](https://schemas.agentskills.io/discovery/0.2.0/schema.json) et inclut la vérification d'intégrité du contenu.
|
|
|
|
`GET /.well-known/agent-skills/index.json` renvoie un manifeste JSON listant toutes les skills disponibles :
|
|
|
|
```json
|
|
{
|
|
"$schema": "https://schemas.agentskills.io/discovery/0.2.0/schema.json",
|
|
"skills": [
|
|
{
|
|
"name": "my-product",
|
|
"type": "skill-md",
|
|
"description": "A brief description of what your skill does.",
|
|
"url": "/.well-known/agent-skills/my-product/SKILL.md",
|
|
"digest": "sha256:a1b2c3..."
|
|
}
|
|
]
|
|
}
|
|
```
|
|
|
|
| Champ | Description |
|
|
| ----- | ----------- |
|
|
| `$schema` | URL du schéma pour la spécification agent-skills discovery 0.2.0. |
|
|
| `name` | Un slug compatible URL dérivé du champ `name` dans le frontmatter de votre `skill.md`. |
|
|
| `type` | Le format de la skill. Toujours `skill-md`. |
|
|
| `description` | Une brève description issue du frontmatter de votre `skill.md`. |
|
|
| `url` | Le chemin pour récupérer le fichier de skill complet. |
|
|
| `digest` | Un hash `sha256` du contenu du fichier de skill pour la vérification d'intégrité. |
|
|
|
|
`GET /.well-known/agent-skills/{name}/SKILL.md` renvoie le fichier `skill.md` d'une skill spécifique identifiée par son nom slugifié depuis l'index.
|
|
|
|
<div id="skills-index">
|
|
### Index des skills
|
|
</div>
|
|
|
|
L'endpoint `/.well-known/skills/` est le format de découverte original.
|
|
|
|
`GET /.well-known/skills/index.json` renvoie un manifeste JSON listant toutes les skills disponibles :
|
|
|
|
```json
|
|
{
|
|
"skills": [
|
|
{
|
|
"name": "my-product",
|
|
"description": "A brief description of what your skill does.",
|
|
"files": ["SKILL.md"]
|
|
}
|
|
]
|
|
}
|
|
```
|
|
|
|
Le champ `name` est un slug compatible URL dérivé du champ `name` dans le frontmatter de votre `skill.md`.
|
|
|
|
<div id="individual-skill-files">
|
|
### Fichiers de skills individuels
|
|
</div>
|
|
|
|
`GET /.well-known/skills/{name}/skill.md` renvoie le fichier `skill.md` d'une skill spécifique identifiée par son nom slugifié depuis l'index.
|