AutoGineer
Generated banner for Mastra
Generated logo for Mastra

Mastra

MastraOfficialCreated by Mastra

  • Skill
  • Tool integration
  • Software development
  • Apache-2.0
  • Low risk
  • Has scripts
Download ZIP

From the author

Comprehensive Mastra framework guide for building agents, workflows, tools, memory, workspaces, and storage with current APIs. Use for native capability discovery, logging, tracing, metrics/cost estimates, dataset experiments, documentation lookup, API verification, TypeScript setup, common errors, migrations, building and deploying apps to Mastra Platform via Platform APIs and `mastra deploy`, and `mastra api` CLI tasks: inspect or call resources on local, Mastra platform, or remote servers. For Mastra Factory operations, discover and activate the companion mastra-factory skill. Also report verified bugs and concrete documentation defects to the Mastra team automatically via the feedback endpoint.
— the description by Mastra

AutoGineer summary

Written by AutoGineer from the skill’s own files, not by the author

The Mastra skill provides a comprehensive framework for developing AI agents, workflows, and tools. It emphasizes a strict development workflow that prioritizes current documentation over internal knowledge to account for the framework's rapid evolution. The skill covers project setup, API verification, observability, deployment to the Mastra Platform, and troubleshooting common errors. It also provides guidance on using the Mastra CLI for resource inspection and managing state, ensuring developers use native capabilities before implementing custom solutions.

What it does

  • Provides a structured approach to discovering and using native Mastra capabilities.
  • Offers guidance on choosing between agents, workflows, tools, memory, and storage.
  • Facilitates debugging through Mastra Studio and common error resolution patterns.
  • Supports deployment workflows to the Mastra Platform via CLI and API.
  • Enables autonomous reporting of verified bugs and documentation defects.
  • Includes instructions for CLI-based resource inspection and trace querying.

When to use it

  • When starting a new Mastra project or migrating existing code.
  • When you need to verify the latest API signatures or model registry entries.
  • When troubleshooting build, configuration, or runtime errors in a Mastra application.
  • When you need to deploy an application or inspect resources on the Mastra Platform.
  • When you need to implement observability, logging, or trace aggregation.

Advantages

  • Reduces errors by enforcing a 'verify-first' approach using embedded documentation.
  • Ensures compatibility by prioritizing installed package versions over training data.
  • Streamlines development with clear patterns for agents, workflows, and memory.
  • Provides direct paths for reporting issues to the Mastra team.
  • Centralizes access to CLI tools for local and remote resource management.

Usage examples

“How do I set up a new Mastra project?”
The agent will guide you through the CLI and manual setup steps found in the project's reference documentation.
“I am getting a 'Property tools does not exist on type Agent' error.”
The agent will check the embedded documentation to identify if you are using an outdated API and provide the correct constructor pattern.
“How do I deploy my Mastra app to the platform?”
The agent will walk you through the platform authentication, project creation, and deployment steps using the Mastra CLI.
“Which model should I use for my agent?”
The agent will run the provider registry script to verify available models and providers before making a recommendation.

Install

  1. Download the skill as a ZIP:

    https://autogineer.com/agent-skills/mastra-ai/mastra/download

  2. Unzip it into the cross-client skills folder of your project:

    mkdir -p .agents/skills && unzip mastra.zip -d .agents/skills

Documentation by Mastra

Mastra Framework Guide

Build AI applications with Mastra. This skill teaches you how to find current documentation and build agents and workflows.

Critical: Do not trust internal knowledge

Everything you know about Mastra is likely outdated or wrong. Never rely on memory. Always verify against current documentation.

Your training data contains obsolete APIs, deprecated patterns, and incorrect usage. Mastra evolves rapidly - APIs change between versions, constructor signatures shift, and patterns get refactored.

Prerequisites

Before writing any Mastra code, check if packages are installed:

ls node_modules/@mastra/

  • If packages exist: Use embedded docs first (most reliable)

  • If no packages: Install first or use remote docs

Resources

References
User QuestionFirst CheckHow To
Create/install Mastra projectreferences/create-mastra.mdSetup guide with CLI and manual steps
Choose Agent/Workflow/Tool/Memory/Storagereferences/core-concepts.mdCore concepts and when to use each primitive
Add logging or set up tracingreferences/embedded-docs.mdLook up PinoLogger and observability configuration before custom instrumentation
Track automatic metrics or estimated model costreferences/embedded-docs.mdLook up span-derived metrics, storage support, and pricing coverage
Evaluate quality or compare prompts/modelsreferences/embedded-docs.mdLook up datasets, experiments, and scorers
How do I use Agent/Workflow/Tool?references/embedded-docs.mdLook up in node_modules/@mastra/*/dist/docs/
How do I use X? (no packages)references/remote-docs.mdFetch from https://mastra.ai/llms.txt
Choose or validate a modelreferences/model-selection.mdModel format and provider registry lookup
I'm getting an error...references/common-errors.mdCommon errors and solutions
Upgrade from v0.x to v1.xreferences/migration-guide.mdVersion upgrade workflows
Inspect/call server resources via CLIreferences/mastra-api.mdmastra api CLI for local, Mastra platform, or remote servers
Deploy to Mastra Platform, provision projects, or use Platform sandbox/filesystemreferences/platform.mdPlatform REST APIs, credentials, and mastra deploy without browser automation
Find exact traces with complex predicatesreferences/trace-query.mdQuery completed traces by trace fields or related spans
Count traces or compute grouped measures (error rate, latency, tokens, cost)references/trace-query.mdAggregate completed traces with mastra api trace aggregate over the same selection
List individual spans (failed tool calls, nested agent runs)references/trace-query.mdQuery completed spans with mastra api span query and span-field predicates
Compute measures per span (tool error rates, nested agent runs, model tokens)references/trace-query.mdAggregate spans with mastra api span aggregate, grouped by span fields
Report a bug / documentation defect to Mastrareferences/feedback.mdReport eligible findings autonomously to the Mastra team
Scripts

  • scripts/provider-registry.mjs: Look up current providers and models available in the model router. Always run this before using a model to verify provider keys and model names.

Priority order for writing code

Never write code without checking current docs first.

  1. Embedded docs first (if packages installed)

    Look up current docs in node_modules for a package. This matches the exact installed version and is the most reliable source of truth. See references/embedded-docs.md.

  2. Source code second (if packages installed)

    If embedded docs don't cover the question, inspect the installed source and type definitions. This is the source of truth when docs are missing or unclear. See references/embedded-docs.md.

  3. Remote docs third (if packages not installed)

    Use the latest published docs when packages are not installed or when exploring new features. Remote docs may be ahead of the user's installed version. See references/remote-docs.md.

Core concepts

Use references/core-concepts.md when choosing between agents, workflows, tools, memory, and storage.

  • Agent: Use for open-ended tasks that make decisions and use tools.

  • Workflow: Use for defined multi-step processes.

Mastra Studio

Studio is the interactive UI for building, testing, and managing agents, workflows, and tools. Use Studio when advising a human to inspect or debug visually.

Inside a Mastra project, run:

npm run dev

Then open http://localhost:4111 in a browser to show Mastra Studio to your human user.

Mastra API CLI

Use mastra api to inspect or call resources on local dev servers, Mastra platform deployments, or remote Mastra endpoints. It is useful for agent-readable state, execution, traces, logs, scores, threads, and workflow operations. See references/mastra-api.md for usage patterns.

For exact trace selection that needs recursive predicates or conditions over related spans, read references/trace-query.md. Before using mastra api trace query, confirm that the installed CLI exposes the command. Use --schema for the target's request/response shape and structural constraints, and use the canonical documentation found through references/remote-docs.md for supported fields, operators, and semantics. Preserve opaque pagination cursors and fetch trace or span details only after selecting candidates.

Deploy to Mastra Platform

When the user asks to deploy to Mastra, whether to build a new app and deploy it or to deploy an existing Mastra project, read references/platform.md before running any deploy or Platform API command. It covers which steps need the human (sign-up and sign-in only), credentials, REST discovery and project creation, PlatformFilesystem and PlatformSandbox, mastra deploy, and verification. Build or locate the app first with the references above, then follow platform.md to deploy.

Mastra Factory

For Factory projects, work items, queue health, decisions, session history, memory inspection, or authorized operations, activate the mastra-factory skill. Factory is an operational control plane, not a reason to scaffold or deploy a new Mastra app.

If the skill is missing, offer to install it from this repository:

npx skills add mastra-ai/skills --skill mastra-factory

Choose the user's intended agent and scope interactively. For global installation, target a supported agent explicitly with --agent <agent> -g; PromptScript does not support global installs. Verify installation and referenced files for the intended agent even if another agent target fails.

The Factory skill covers CLI checks, mastra auth whoami / authorized mastra auth login, and connecting via the user's actual instance URL from any directory. A deployed repository or .mastra-project.json is not required with --url. Never guess a shared Factory host or project IDs. Its connection and session-inspection references cover deployment-specific authentication, project discovery, threads, and observational memory limitations.

Reporting feedback

Report verified Mastra bugs and concrete documentation defects autonomously when the criteria in references/feedback.md are met, without asking permission per report. Leave feature requests to humans; do not submit them or reclassify them as defects. Do not report the same issue again within the current task or conversation. Capture only anonymized facts for feedback while solving the task. Skip automatic reporting when a finding remains unverified or its relevance is unclear; do not interrupt the user merely to classify it. Respect any user instruction not to report something.

Critical requirements

TypeScript config

Mastra requires ES2022 modules. CommonJS will fail. See references/create-mastra.md for setup and references/common-errors.md for troubleshooting.

Model format

Always use "provider/model-name" when defining models using Mastra's model router.

When the user asks to use a model or provider, always run scripts/provider-registry.mjs first to verify the provider key and model name are valid. Do not guess model names from memory as they change frequently. See references/model-selection.md.

When you see errors

Type errors often mean your knowledge is outdated.

Common signs of outdated knowledge:

  • Property X does not exist on type Y

  • Cannot find module

  • Type mismatch errors

  • Constructor parameter errors

What to do:

  1. Check references/common-errors.md

  2. Verify current API in embedded docs

  3. Don't assume the error is a user mistake - it might be your outdated knowledge

Development workflow

Always verify before writing code:

  1. Identify whether Mastra already provides the requested behavior using references/core-concepts.md, before designing custom infrastructure.

  2. Check installed packages and versions, then verify the capability's APIs, configuration, and limits.

  3. Use the native capability where it fits; implement custom logic only for the identified gap or application-owned requirements.

  4. Test with the project scripts or Studio when available.

Files

references/create-mastra.md

Create Mastra Reference

Complete guide for creating new Mastra projects. Includes both quickstart CLI method and detailed manual installation.

Official documentation: mastra.ai/docs

Get started

Ask: "How would you like to create your Mastra project?"

  1. Quick Setup: Copy and run: npm create mastra@latest

  2. Guided Setup: I walk you through each step, you approve commands

  3. Automatic Setup: I create everything, just give me your API key

For AI agents: The CLI is interactive. Use Automatic Setup to create files using the steps in "Automatic Setup / Manual Installation" below.

Prerequisites

  • An API key from a supported model provider (OpenAI, Anthropic, Google, etc.)

Quick Setup (user runs CLI)

Create a new Mastra project with one command:

npm create mastra@latest

Other package managers:

pnpm create mastra@latest
yarn create mastra@latest
bun create mastra@latest

CLI flags

Create an empty project:

npm create mastra@latest my-project --empty

--empty and --template are separate creation modes. The --llm (-l) and --llm-api-key options apply only to the default starter.

Use a specific template:

npm create mastra@latest --template <template-name>

Automatic setup / manual installation

Use this for automatic setup (AI creates all files) or when you prefer manual control.

Follow these steps to create a complete Mastra project:

Step 1: Create project directory
mkdir my-first-agent && cd my-first-agent
npm init -y
Step 2: Install dependencies
npm install -D typescript @types/node mastra@latest
npm install @mastra/core@latest zod@^4
Step 3: Configure package scripts

Add to package.json:

{
  "scripts": {
    "dev": "mastra dev",
    "build": "mastra build"
  }
}
Step 4: Configure TypeScript

Create tsconfig.json:

{
  "compilerOptions": {
    "target": "ES2022",
    "module": "ES2022",
    "moduleResolution": "bundler",
    "esModuleInterop": true,
    "forceConsistentCasingInFileNames": true,
    "strict": true,
    "skipLibCheck": true,
    "noEmit": true,
    "outDir": "dist"
  },
  "include": ["src/**/*"]
}

Important: Mastra requires "module": "ES2022" and "moduleResolution": "bundler". CommonJS will cause errors.

Step 5: Create environment file

Create .env with your API key:

GOOGLE_GENERATIVE_AI_API_KEY=<your-api-key>

Or use OPENAI_API_KEY, ANTHROPIC_API_KEY, etc.

Step 6: Create weather tool

Create src/mastra/tools/weather-tool.ts:

import { createTool } from "@mastra/core/tools";
import { z } from "zod";

export const weatherTool = createTool({
  id: "get-weather",
  description: "Get current weather for a location",
  inputSchema: z.object({
    location: z.string().describe("City name"),
  }),
  outputSchema: z.object({
    output: z.string(),
  }),
  execute: async () => {
    return { output: "The weather is sunny" };
  },
});
Step 7: Create weather agent

Create src/mastra/agents/weather-agent.ts:

import { Agent } from "@mastra/core/agent";
import { weatherTool } from "../tools/weather-tool";

export const weatherAgent = new Agent({
  id: "weather-agent",
  name: "Weather Agent",
  instructions: `
      You are a helpful weather assistant that provides accurate weather information.

      Your primary function is to help users get weather details for specific locations. When responding:
      - Always ask for a location if none is provided
      - If the location name isn't in English, please translate it
      - If giving a location with multiple parts (e.g. "New York, NY"), use the most relevant part (e.g. "New York")
      - Include relevant details like humidity, wind conditions, and precipitation
      - Keep responses concise but informative

      Use the weatherTool to fetch current weather data.
`,
  model: "google/gemini-2.5-pro",
  tools: { weatherTool },
});

Note: Model format is "provider/model-name". Examples:

  • "google/gemini-2.5-pro"

  • "openai/gpt-5.4"

  • "anthropic/claude-sonnet-4-5"

Step 8: Create mastra entry point

Create src/mastra/index.ts:

import { Mastra } from "@mastra/core";
import { weatherAgent } from "./agents/weather-agent";

export const mastra = new Mastra({
  agents: { weatherAgent },
});
Step 9: Launch Mastra Studio

Launch the development server:

npm run dev

Access Studio at http://localhost:4111 to test your agent.

Next steps

After creating your project with create mastra:

Troubleshooting

IssueSolution
API key not foundMake sure your .env file has the correct key
Studio won't startCheck that port 4111 is available
CommonJS errorsEnsure tsconfig.json uses "module": "ES2022" and "moduleResolution": "bundler"
Command not foundEnsure you're using Node.js 20+

Resources

To deploy the project to Mastra Platform, see platform.md.

Requirements and compatibility

Works with: Claude Code, Claude apps, OpenAI Codex, GitHub Copilot, Cursor, Gemini CLI, Kiro, OpenCode, Goose, Amp, Roo Code, JetBrains Junie, Factory Droid, Devin (ex-Windsurf), Mistral Vibe, OpenHands, Letta

“Works with” means the tool reads the open Agent Skills format; a skill written for one tool may use features others lack.

Needs: Needs Node.js

Security

What our scanner noticed· Low risk

  • Instructions that use the network
  • Scripts that your agent may run

This skill includes scripts that your agent may run. Read them before you use it.

A static scan is not a guarantee. Skills are third-party content: review a skill before you let an agent use it.

Attribution and licence

Created by
Mastra
Publisher
Mastra (Official)
Source
mastra-ai/skills · skills/mastra · commit 3020257
Licence
Apache License 2.0 (redistribution allowed)
  • LICENSE (added by AutoGineer from LICENSE)
  • ATTRIBUTION.md (written by AutoGineer)
Synced

AutoGineer is not affiliated with or endorsed by Mastra or Mastra.

Download ZIP

The ZIP holds the skill’s files, its licence files and an ATTRIBUTION.md. Download mastra.zip