Structure du projet
Votre nouveau projet Mastra, créé avec la commande create mastra, contient un ensemble prédéfini de fichiers et de dossiers pour vous aider à démarrer.
Mastra est un cadre logiciel, mais il est en grande partie peu contraignant concernant l’organisation ou la colocalisation de vos fichiers. La CLI fournit une structure par défaut judicieuse qui convient à la plupart des projets, mais vous pouvez l’adapter à votre flux de travail ou aux conventions de votre équipe. Vous pouvez même construire l’intégralité de votre projet dans un seul fichier. Quelle que soit la structure choisie, gardez-la cohérente afin que votre code reste facile à maintenir et à parcourir.
Structure de projet par défautLien direct vers Structure de projet par défaut
Un projet créé avec la commande create mastra se présente ainsi :
src/
├── mastra/
│ ├── agents/
│ │ └── weather-agent.ts
│ ├── tools/
│ │ └── weather-tool.ts
│ ├── workflows/
│ │ └── weather-workflow.ts
│ ├── scorers/
│ │ └── weather-scorer.ts
│ └── index.ts
├── .env.example
├── package.json
└── tsconfig.json
Utilisez les fichiers prédéfinis comme modèles. Dupliquez-les et adaptez-les pour créer rapidement vos propres Agents, Tools, Workflows, etc.
DossiersLien direct vers Dossiers
Mastra recommande d’organiser votre code dans les dossiers suivants :
| Dossier | Description |
|---|---|
src/mastra | Point d’entrée de tout le code et de la configuration liés à Mastra. |
src/mastra/agents | Définissez et configurez vos Agents : leur comportement, leurs objectifs et leurs Tools. |
src/mastra/workflows | Définissez des Workflows à plusieurs étapes qui orchestrent ensemble des Agents et des Tools. |
src/mastra/tools | Créez des Tools réutilisables que vos Agents peuvent appeler. |
src/mastra/mcp | Implémentez des serveurs MCP personnalisés pour partager vos Tools avec des Agents externes. |
src/mastra/scorers | Définissez des Scorers pour évaluer les performances des Agents au fil du temps. |
Mastra possède deux conventions de dossiers spéciales :
src/mastra/agents/<name>: vous pouvez définir un Agent par convention de fichiers au lieu de le construire dans le code. Pour en savoir plus, consultez la documentation sur les Agents basés sur des fichiers.src/mastra/public: son contenu est copié dans le répertoire.build/outputlors du processus de compilation, ce qui le rend disponible pour être servi à l’exécution.
Fichiers à la racineLien direct vers Fichiers à la racine
Les fichiers à la racine définissent comment votre projet Mastra est configuré, compilé et connecté à son environnement.
| Fichier | Description |
|---|---|
src/mastra/index.ts | Point d’entrée central où vous configurez et initialisez Mastra. |
.env.example | Modèle pour les variables d’environnement : copiez-le et renommez-le en .env pour ajouter les clés secrètes de votre fournisseur de modèles. |
package.json | Définit les métadonnées du projet, les dépendances et les scripts npm disponibles. |
tsconfig.json | Configure les options TypeScript telles que les alias de chemin, les paramètres du compilateur et la sortie de compilation. |