跳到主要内容

概览

本文介绍如何使用现有的 Mastra 模板以及创建自己的模板，也涵盖如何向社区生态系统贡献模板。

Mastra 模板是预先构建的项目结构，用于展示特定用例和模式。它们提供：

  • 可运行示例：完整且功能正常的 Mastra 应用
  • 最佳实践：恰当的项目结构和编码约定
  • 学习资源：通过真实实现学习 Mastra 模式
  • 快速入门：比从零构建更快地初始化项目

可用模板
可用模板的直接链接

以下模板展示以 Gateway 为先的 Mastra 应用：

  • template-docs-expert：借助 Gateway Web 搜索、引用、内存和结构化响应来回答文档问题。
  • template-browser-agent：使用 AgentBrowser 浏览、检查和与网页交互。
  • template-meeting-notes：将 Zoom 转录文本或上传的转录文本转换为包含决策和行动项的结构化笔记。
  • template-company-knowledge：将 Linear 和 Notion 内容索引到 pgvector 中，并回答内部知识问题。
  • template-claw-assistant：使用文件系统、Sandbox、浏览器和 Web 搜索 Tool 操作 Workspace。

使用模板
使用模板的直接链接

安装
安装的直接链接

使用 create-mastra 命令安装模板：

npx create-mastra@latest my-project --template template-name

这会创建一个完整项目并安装其依赖项。模板作者决定模型、Provider 依赖项、环境变量和源代码。

设置流程
设置流程的直接链接

安装后：

  1. 进入项目目录：

    cd your-project-name

  2. 配置环境变量：

    cp .env.example .env

    按模板 README 中的说明，用所需 API 密钥编辑 .env。

  3. 启动开发服务器：

    npm run dev

模板结构
模板结构的直接链接

所有模板均遵循以下标准化结构：

your-template/
├── src/
│   └── mastra/
│       ├── agents/       # Agent definitions
│       ├── tools/        # Tool definitions
│       ├── workflows/    # Workflow definitions
│       └── index.ts      # Main Mastra config
├── .env.example          # Required environment variables
├── package.json
├── tsconfig.json
└── README.md
On this page