Skip to main content
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 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. Ouvrir le skill.md de ce site.
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.

​
Utiliser les fichiers skill.md avec des agents

Si vous utilisez un proxy inverse, configurez-le pour qu’il redirige les chemins /skill.md et /.well-known/skills/* (avec la mise en cache désactivée) vers votre sous-domaine Mintlify.
Les agents peuvent traiter votre fichier skill.md avec la CLI skills. 
npx skills add yourdomain.com/docs/skill.md
Cela ajoute les capacités de votre produit au contexte de l’agent afin qu’il puisse effectuer des actions au nom des utilisateurs.
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.

​
Structure de skill.md

Mintlify génère un fichier skill.md selon la spécification agentskills.io. 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.

​
Fichiers skill.md personnalisés

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 pour garantir la compatibilité avec les outils des agents.

​
Champs de frontmatter

Les fichiers skill.md personnalisés doivent commencer par un frontmatter YAML. Les champs suivants sont pris en charge :
Nom du champTypeDescription
namestringLe nom de votre skill.
descriptionstringUne brève description de ce que fait votre skill.
licensestringLa licence de votre skill (par exemple : MIT, Apache-2.0).
compatibilitystringExigences ou notes de compatibilité (par exemple : dépendances d’exécution).
metadataobjectMétadonnées supplémentaires sous forme de paires clé-valeur de chaînes de caractères (par ex. : author, version).
allowed-toolsstringListe, séparée par des espaces, des outils préautorisés que le skill peut utiliser (expérimental).

​
Exemple de fichier skill.md personnalisé

---
name: mintlify-docs
description: Créez et maintenez des sites de documentation avec Mintlify. À utiliser pour créer des pages de documentation, configurer la navigation, ajouter des composants ou mettre en place des références API.
license: MIT
compatibility: Requires Node.js for CLI. Works with any Git-based workflow.
metadata:
  author: mintlify
  version: "1.0"
---