プロジェクト構造
このページではMastraでのフォルダとファイルの整理方法についてのガイドを提供します。Mastraはモジュラーフレームワークであり、各モジュールを個別に、または組み合わせて使用することができます。
すべてを1つのファイルに書くこともできますし、各エージェント、ツール、ワークフローを独自のファイルに分けることもできます。
特定のフォルダ構造を強制することはありませんが、いくつかのベストプラクティスを推奨しており、CLIは適切な構造でプロジェクトをスキャフォールドします。
CLIの使用
Mastra CLIはインタラクティブで、以下のことができます:
- Mastraファイルのディレクトリを選択する:Mastraファイルを配置する場所を指定します(デフォルトは
src/mastra
)。 - インストールするコンポーネントを選択する:プロジェクトに含めたいコンポーネントを選択します:
- エージェント
- ツール
- ワークフロー
- デフォルトのLLMプロバイダーを選択する:OpenAI、Anthropic、Groq、GoogleやCerebrasなどのサポートされているプロバイダーから選択します。
- サンプルコードを含める:開始するのに役立つサンプルコードを含めるかどうかを決定します。
- Mastra docs MCPサーバーをインストールする:あなたのAI IDEをMastraのエキスパートにします
プロジェクト構造の例
すべてのコンポーネントを選択し、サンプルコードを含める場合、プロジェクト構造は次のようになります:
- agent-name.ts
- tool-name.ts
- workflow-name.ts
- index.ts
- .env
- package.json
- tsconfig.json
トップレベルフォルダ
フォルダ | 説明 |
---|---|
src/mastra | コアアプリケーションフォルダ |
src/mastra/agents | エージェントの設定と定義 |
src/mastra/tools | カスタムツールの定義 |
src/mastra/workflows | ワークフローの定義 |
トップレベルファイル
ファイル | 説明 |
---|---|
src/mastra/index.ts | Mastraのメイン設定ファイル |
.env | 環境変数 |
package.json | Node.jsプロジェクトのメタデータ、スクリプト、および依存関係 |
tsconfig.json | TypeScriptコンパイラの設定 |