Skip to main content

​
Prérequis

  • Un projet Mintlify connecté à un dépôt GitHub ou GitLab
  • Pour GitHub : la GitHub App Mintlify installée sur chaque dépôt que vous prévoyez d’utiliser dans l’automatisation
  • Pour GitLab : un compte GitLab connecté (voir Configuration GitLab ci-dessous)

​
Créer une automatisation personnalisée

L’agent s’exécute dans un sandbox isolé avec un accès Internet restreint. Il ne peut pas installer de packages ou d’outils supplémentaires à l’exécution. Les prompts qui font référence à des outils indisponibles peuvent produire des résultats inattendus ou échouer.
Dans le sandbox, l’agent peut :
  • Lire les fichiers de votre dépôt de documentation et de tout dépôt de contexte connecté.
  • Utiliser les intégrations partagées et personnelles que vous sélectionnez comme outils.
  • Modifier des fichiers MDX et ouvrir une pull request sur votre dépôt de documentation.
Le sandbox ne peut pas effectuer de requêtes réseau sortantes arbitraires, installer des packages, ni exécuter des commandes shell au-delà des outils fournis par Mintlify.
  1. Ouvrez la page Automations dans votre dashboard.
  2. Cliquez sur Create a custom automation.
  3. Configurez l’automatisation :
    • Nom : Une étiquette courte et descriptive affichée dans le dashboard et l’historique des exécutions.
    • Déclencheur : Le moment où l’automatisation s’exécute (mise à jour de contenu, modification de code, calendrier personnalisé ou événement d’intégration).
    • Instructions : Le prompt que l’agent suit à chaque exécution.
    • Dépôts de contexte : Dépôts supplémentaires que l’agent peut lire pour obtenir plus de contexte.
    • Intégrations : Intégrations partagées que l’agent peut appeler comme outils pendant l’exécution.
    • Mode de mise à jour : Comment l’agent propose les modifications — ouvrir une pull request, committer directement, ou un autre mode.
    Pour plus de détails sur chaque champ, consultez Configurations.
  4. Cliquez sur Create automation.

​
Rédiger des instructions efficaces

Des instructions d’automatisation efficaces se concentrent sur une seule tâche et définissent un résultat clair et vérifiable. Les automatisations présentent une certaine variabilité car les agents sont non déterministes, mais des instructions bien formulées produisent des résultats plus cohérents.
  • Décrivez le résultat. Indiquez à l’agent à quoi devrait ressembler une exécution réussie.
  • Rédigez une procédure. Donnez à l’agent un guide étape par étape à suivre.
  • Restez précis dans la portée. Divisez les tâches complexes en plusieurs automatisations plutôt que de les combiner dans un seul prompt.
Pour plus d’exemples et de modèles, consultez Utiliser les automatisations.
Vérifiez les résultats de vos automatisations personnalisées pour confirmer qu’elles fonctionnent comme prévu. Mettez à jour vos instructions pour améliorer les résultats.

​
Configuration GitLab

Pour utiliser des dépôts GitLab dans une automatisation, connectez chaque projet via la page de paramètres OAuth GitLab. Connectez chaque dépôt que l’automatisation utilise — votre dépôt de documentation et tous les dépôts de déclenchement ou de contexte. Vous devez disposer au minimum du rôle Mainteneur sur chaque projet.
Les automatisations nécessitent un forfait GitLab payant. L’agent utilise des jetons d’accès de projet à courte durée de vie pour l’accès aux dépôts, ce que le forfait gratuit de GitLab ne prend pas en charge.

​
Supprimer une automatisation personnalisée

La suppression d’une automatisation est définitive et supprime sa configuration ainsi que l’historique de ses exécutions.
  1. Accédez à la page Automations dans votre dashboard.
  2. Cliquez sur le bouton de paramètres à côté d’une automatisation.
  3. Cliquez sur Delete.