@mastra/mcp-docs-server 1.2.4-alpha.1 → 1.2.4-alpha.6
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.docs/docs/agent-builder/access-control.md +2 -0
- package/.docs/docs/agent-builder/browser.md +2 -0
- package/.docs/docs/agent-builder/channels.md +2 -0
- package/.docs/docs/agent-builder/configuration.md +2 -0
- package/.docs/docs/agent-builder/deploying.md +2 -0
- package/.docs/docs/agent-builder/integrations.md +2 -0
- package/.docs/docs/agent-builder/memory.md +2 -0
- package/.docs/docs/agent-builder/model-policy.md +2 -0
- package/.docs/docs/agent-builder/overview.md +2 -0
- package/.docs/docs/agent-builder/skill-registries.md +2 -0
- package/.docs/docs/agent-builder/workspace.md +2 -0
- package/.docs/docs/agent-controller/modes.md +2 -0
- package/.docs/docs/agent-controller/overview.md +3 -0
- package/.docs/docs/agent-controller/session.md +2 -0
- package/.docs/docs/agent-controller/subagents.md +3 -0
- package/.docs/docs/agent-controller/threads-and-state.md +3 -0
- package/.docs/docs/agent-controller/tool-approvals.md +2 -0
- package/.docs/docs/agents/a2a.md +2 -0
- package/.docs/docs/agents/acp.md +2 -0
- package/.docs/docs/agents/adding-voice.md +2 -0
- package/.docs/docs/agents/agent-approval.md +2 -0
- package/.docs/docs/agents/background-tasks.md +5 -3
- package/.docs/docs/agents/channels.md +6 -1
- package/.docs/docs/agents/code-mode.md +4 -0
- package/.docs/docs/agents/durable-agents.md +3 -1
- package/.docs/docs/agents/file-based-agents.md +13 -2
- package/.docs/docs/agents/goals.md +4 -0
- package/.docs/docs/agents/guardrails.md +2 -0
- package/.docs/docs/agents/heartbeats.md +3 -1
- package/.docs/docs/agents/networks.md +2 -0
- package/.docs/docs/agents/overview.md +112 -0
- package/.docs/docs/agents/processors.md +10 -2
- package/.docs/docs/agents/sdk-agents.md +2 -0
- package/.docs/docs/agents/signal-providers.md +2 -0
- package/.docs/docs/agents/signals.md +2 -0
- package/.docs/docs/agents/skills.md +2 -0
- package/.docs/docs/agents/structured-output.md +2 -0
- package/.docs/docs/agents/supervisor-agents.md +3 -0
- package/.docs/docs/agents/using-tools.md +5 -0
- package/.docs/docs/browser/agent-browser.md +2 -0
- package/.docs/docs/browser/browser-viewer.md +2 -0
- package/.docs/docs/browser/overview.md +2 -0
- package/.docs/docs/browser/recording.md +6 -2
- package/.docs/docs/browser/stagehand.md +2 -0
- package/.docs/docs/community/contributing-templates.md +2 -0
- package/.docs/docs/community/discord.md +2 -0
- package/.docs/docs/community/licensing.md +2 -0
- package/.docs/docs/deployment/cloud-providers.md +2 -0
- package/.docs/docs/deployment/mastra-server.md +2 -0
- package/.docs/docs/deployment/monorepo.md +2 -0
- package/.docs/docs/deployment/overview.md +2 -0
- package/.docs/docs/deployment/web-framework.md +2 -0
- package/.docs/docs/deployment/workflow-runners.md +2 -0
- package/.docs/docs/editor/overview.md +3 -0
- package/.docs/docs/editor/prompts.md +2 -0
- package/.docs/docs/editor/tools.md +2 -0
- package/.docs/docs/evals/built-in-scorers.md +2 -0
- package/.docs/docs/evals/custom-scorers.md +2 -0
- package/.docs/docs/evals/datasets/overview.md +2 -0
- package/.docs/docs/evals/datasets/running-experiments.md +2 -0
- package/.docs/docs/evals/evals-with-memory.md +2 -0
- package/.docs/docs/evals/gates-and-verdicts.md +2 -0
- package/.docs/docs/evals/overview.md +3 -0
- package/.docs/docs/evals/quick-checks.md +3 -0
- package/.docs/docs/evals/running-in-ci.md +2 -0
- package/.docs/docs/getting-started/build-with-ai.md +5 -5
- package/.docs/docs/getting-started/manual-install.md +17 -5
- package/.docs/docs/getting-started/project-structure.md +2 -0
- package/.docs/docs/index.md +112 -0
- package/.docs/docs/mastra-platform/configuration.md +2 -0
- package/.docs/docs/mastra-platform/database.md +2 -0
- package/.docs/docs/mastra-platform/github.md +2 -0
- package/.docs/docs/mastra-platform/observability.md +2 -0
- package/.docs/docs/mastra-platform/overview.md +2 -0
- package/.docs/docs/mastra-platform/server.md +2 -0
- package/.docs/docs/mastra-platform/studio.md +2 -0
- package/.docs/docs/mcp/mcp-apps.md +2 -0
- package/.docs/docs/mcp/overview.md +2 -0
- package/.docs/docs/memory/memory-processors.md +4 -0
- package/.docs/docs/memory/message-history.md +2 -0
- package/.docs/docs/memory/multi-user-threads.md +2 -0
- package/.docs/docs/memory/observational-memory.md +6 -0
- package/.docs/docs/memory/overview.md +5 -1
- package/.docs/docs/memory/semantic-recall.md +8 -0
- package/.docs/docs/memory/storage.md +6 -0
- package/.docs/docs/memory/working-memory.md +2 -0
- package/.docs/docs/observability/config.md +2 -0
- package/.docs/docs/observability/integrations/bridges/datadog.md +2 -0
- package/.docs/docs/observability/integrations/bridges/otel.md +2 -0
- package/.docs/docs/observability/integrations/exporters/arize.md +2 -0
- package/.docs/docs/observability/integrations/exporters/arthur.md +2 -0
- package/.docs/docs/observability/integrations/exporters/braintrust.md +2 -0
- package/.docs/docs/observability/integrations/exporters/datadog.md +2 -0
- package/.docs/docs/observability/integrations/exporters/laminar.md +2 -0
- package/.docs/docs/observability/integrations/exporters/langfuse.md +3 -0
- package/.docs/docs/observability/integrations/exporters/langsmith.md +2 -0
- package/.docs/docs/observability/integrations/exporters/mastra-platform.md +2 -0
- package/.docs/docs/observability/integrations/exporters/mastra-storage.md +2 -0
- package/.docs/docs/observability/integrations/exporters/otel.md +2 -0
- package/.docs/docs/observability/integrations/exporters/posthog.md +2 -0
- package/.docs/docs/observability/integrations/exporters/sentry.md +2 -0
- package/.docs/docs/observability/integrations/overview.md +2 -0
- package/.docs/docs/observability/integrations/processors/sensitive-data-filter.md +2 -0
- package/.docs/docs/observability/logging.md +2 -0
- package/.docs/docs/observability/metrics/overview.md +2 -0
- package/.docs/docs/observability/metrics/querying.md +2 -0
- package/.docs/docs/observability/overview.md +2 -0
- package/.docs/docs/observability/storage.md +2 -0
- package/.docs/docs/observability/tracing/overview.md +2 -0
- package/.docs/docs/rag/chunking-and-embedding.md +2 -0
- package/.docs/docs/rag/graph-rag.md +2 -0
- package/.docs/docs/rag/overview.md +2 -0
- package/.docs/docs/rag/retrieval.md +2 -0
- package/.docs/docs/rag/vector-databases.md +2 -0
- package/.docs/docs/server/auth/auth0.md +2 -0
- package/.docs/docs/server/auth/better-auth.md +2 -0
- package/.docs/docs/server/auth/clerk.md +2 -0
- package/.docs/docs/server/auth/composite-auth.md +2 -0
- package/.docs/docs/server/auth/custom-auth-provider.md +2 -0
- package/.docs/docs/server/auth/fga.md +2 -0
- package/.docs/docs/server/auth/firebase.md +2 -0
- package/.docs/docs/server/auth/google.md +2 -0
- package/.docs/docs/server/auth/jwt.md +2 -0
- package/.docs/docs/server/auth/okta.md +2 -0
- package/.docs/docs/server/auth/simple-auth.md +2 -0
- package/.docs/docs/server/auth/supabase.md +2 -0
- package/.docs/docs/server/auth/workos.md +2 -0
- package/.docs/docs/server/auth.md +2 -0
- package/.docs/docs/server/custom-adapters.md +2 -0
- package/.docs/docs/server/custom-api-routes.md +2 -0
- package/.docs/docs/server/mastra-client.md +2 -0
- package/.docs/docs/server/mastra-server.md +2 -0
- package/.docs/docs/server/middleware.md +2 -0
- package/.docs/docs/server/pubsub.md +2 -0
- package/.docs/docs/server/request-context.md +2 -0
- package/.docs/docs/server/server-adapters.md +2 -0
- package/.docs/docs/studio/auth.md +2 -0
- package/.docs/docs/studio/deployment.md +2 -0
- package/.docs/docs/studio/observability.md +2 -0
- package/.docs/docs/studio/overview.md +2 -0
- package/.docs/docs/voice/overview.md +2 -0
- package/.docs/docs/voice/speech-to-speech.md +2 -0
- package/.docs/docs/voice/speech-to-text.md +2 -0
- package/.docs/docs/voice/text-to-speech.md +2 -0
- package/.docs/docs/workflows/agents-and-tools.md +2 -0
- package/.docs/docs/workflows/control-flow.md +2 -0
- package/.docs/docs/workflows/error-handling.md +2 -0
- package/.docs/docs/workflows/human-in-the-loop.md +2 -0
- package/.docs/docs/workflows/overview.md +2 -0
- package/.docs/docs/workflows/scheduled-workflows.md +2 -0
- package/.docs/docs/workflows/snapshots.md +2 -0
- package/.docs/docs/workflows/suspend-and-resume.md +2 -0
- package/.docs/docs/workflows/time-travel.md +2 -0
- package/.docs/docs/workflows/workflow-state.md +2 -0
- package/.docs/docs/workspace/filesystem.md +5 -1
- package/.docs/docs/workspace/lsp.md +2 -0
- package/.docs/docs/workspace/overview.md +2 -0
- package/.docs/docs/workspace/sandbox.md +4 -0
- package/.docs/docs/workspace/search.md +2 -0
- package/.docs/docs/workspace/skills.md +2 -0
- package/.docs/guides/agent-frameworks/ai-sdk.md +2 -0
- package/.docs/guides/build-your-ui/ai-sdk-ui.md +2 -0
- package/.docs/guides/build-your-ui/assistant-ui.md +2 -0
- package/.docs/guides/build-your-ui/copilotkit.md +2 -0
- package/.docs/guides/build-your-ui/openui.md +2 -0
- package/.docs/guides/concepts/multi-agent-systems.md +2 -0
- package/.docs/guides/concepts/streaming.md +2 -0
- package/.docs/guides/deployment/amazon-ec2.md +2 -0
- package/.docs/guides/deployment/aws-bedrock-agentcore.md +2 -0
- package/.docs/guides/deployment/aws-lambda.md +2 -0
- package/.docs/guides/deployment/azure-app-services.md +2 -0
- package/.docs/guides/deployment/cloudflare.md +2 -0
- package/.docs/guides/deployment/digital-ocean.md +2 -0
- package/.docs/guides/deployment/inngest.md +2 -0
- package/.docs/guides/deployment/netlify.md +2 -0
- package/.docs/guides/deployment/temporal.md +2 -0
- package/.docs/guides/deployment/vercel.md +2 -0
- package/.docs/guides/getting-started/astro.md +2 -0
- package/.docs/guides/getting-started/electron.md +2 -0
- package/.docs/guides/getting-started/express.md +2 -0
- package/.docs/guides/getting-started/hono.md +2 -0
- package/.docs/guides/getting-started/nestjs.md +2 -0
- package/.docs/guides/getting-started/next-js.md +2 -0
- package/.docs/guides/getting-started/nuxt.md +2 -0
- package/.docs/guides/getting-started/quickstart.md +4 -0
- package/.docs/guides/getting-started/sveltekit.md +2 -0
- package/.docs/guides/getting-started/vite-react.md +2 -0
- package/.docs/guides/guide/ai-recruiter.md +2 -0
- package/.docs/guides/guide/chef-michel.md +2 -0
- package/.docs/guides/guide/code-review-bot.md +2 -0
- package/.docs/guides/guide/dev-assistant.md +2 -0
- package/.docs/guides/guide/docs-manager.md +2 -0
- package/.docs/guides/guide/firecrawl.md +2 -0
- package/.docs/guides/guide/github-actions-pr-description.md +2 -0
- package/.docs/guides/guide/notes-mcp-server.md +2 -0
- package/.docs/guides/guide/publishing-mcp-server.md +2 -0
- package/.docs/guides/guide/research-assistant.md +2 -0
- package/.docs/guides/guide/research-coordinator.md +2 -0
- package/.docs/guides/guide/signal-provider.md +2 -0
- package/.docs/guides/guide/slack-assistant.md +2 -0
- package/.docs/guides/guide/stock-agent.md +2 -0
- package/.docs/guides/guide/web-search.md +2 -0
- package/.docs/guides/guide/whatsapp-chat-bot.md +2 -0
- package/.docs/guides/index.md +2 -0
- package/.docs/guides/migrations/agentnetwork.md +3 -0
- package/.docs/guides/migrations/ai-sdk-v4-to-v5.md +2 -0
- package/.docs/guides/migrations/mastra-cloud.md +2 -0
- package/.docs/guides/migrations/network-to-supervisor.md +2 -0
- package/.docs/guides/migrations/upgrade-to-v1/agent.md +2 -0
- package/.docs/guides/migrations/upgrade-to-v1/cli.md +2 -0
- package/.docs/guides/migrations/upgrade-to-v1/client.md +2 -0
- package/.docs/guides/migrations/upgrade-to-v1/deployment.md +2 -0
- package/.docs/guides/migrations/upgrade-to-v1/evals.md +2 -0
- package/.docs/guides/migrations/upgrade-to-v1/mastra.md +2 -0
- package/.docs/guides/migrations/upgrade-to-v1/mcp.md +2 -0
- package/.docs/guides/migrations/upgrade-to-v1/memory.md +3 -0
- package/.docs/guides/migrations/upgrade-to-v1/overview.md +2 -0
- package/.docs/guides/migrations/upgrade-to-v1/processors.md +2 -0
- package/.docs/guides/migrations/upgrade-to-v1/rag.md +2 -0
- package/.docs/guides/migrations/upgrade-to-v1/storage.md +2 -0
- package/.docs/guides/migrations/upgrade-to-v1/tools.md +2 -0
- package/.docs/guides/migrations/upgrade-to-v1/tracing.md +2 -0
- package/.docs/guides/migrations/upgrade-to-v1/vectors.md +2 -0
- package/.docs/guides/migrations/upgrade-to-v1/voice.md +3 -0
- package/.docs/guides/migrations/upgrade-to-v1/workflows.md +2 -0
- package/.docs/guides/migrations/vnext-to-standard-apis.md +2 -0
- package/.docs/models/embeddings.md +2 -0
- package/.docs/models/environment-variables.md +144 -0
- package/.docs/models/gateways/azure-openai.md +2 -0
- package/.docs/models/gateways/custom-gateways.md +2 -0
- package/.docs/models/gateways/mastra.md +2 -0
- package/.docs/models/gateways/netlify.md +5 -2
- package/.docs/models/gateways/openrouter.md +4 -1
- package/.docs/models/gateways/vercel.md +4 -1
- package/.docs/models/gateways.md +2 -0
- package/.docs/models/index.md +10 -8
- package/.docs/models/providers/302ai.md +2 -0
- package/.docs/models/providers/abacus.md +2 -0
- package/.docs/models/providers/abliteration-ai.md +2 -0
- package/.docs/models/providers/agentrouter.md +2 -0
- package/.docs/models/providers/aihubmix.md +2 -0
- package/.docs/models/providers/alibaba-cn.md +2 -0
- package/.docs/models/providers/alibaba-coding-plan-cn.md +2 -0
- package/.docs/models/providers/alibaba-coding-plan.md +2 -0
- package/.docs/models/providers/alibaba-token-plan-cn.md +2 -0
- package/.docs/models/providers/alibaba-token-plan.md +2 -0
- package/.docs/models/providers/alibaba.md +2 -0
- package/.docs/models/providers/amazon-bedrock.md +2 -0
- package/.docs/models/providers/ambient.md +2 -0
- package/.docs/models/providers/anthropic.md +2 -0
- package/.docs/models/providers/anyapi.md +2 -0
- package/.docs/models/providers/atomic-chat.md +2 -0
- package/.docs/models/providers/auriko.md +2 -0
- package/.docs/models/providers/azure.md +2 -0
- package/.docs/models/providers/bailing.md +2 -0
- package/.docs/models/providers/baseten.md +2 -0
- package/.docs/models/providers/berget.md +2 -0
- package/.docs/models/providers/cerebras.md +7 -4
- package/.docs/models/providers/chutes.md +2 -0
- package/.docs/models/providers/clarifai.md +2 -0
- package/.docs/models/providers/claudinio.md +2 -0
- package/.docs/models/providers/cloudferro-sherlock.md +2 -0
- package/.docs/models/providers/cloudflare-ai-gateway.md +2 -0
- package/.docs/models/providers/cloudflare-workers-ai.md +2 -0
- package/.docs/models/providers/cohere.md +2 -0
- package/.docs/models/providers/cortecs.md +2 -0
- package/.docs/models/providers/crof.md +2 -0
- package/.docs/models/providers/databricks.md +2 -0
- package/.docs/models/providers/deepinfra.md +2 -0
- package/.docs/models/providers/deepseek.md +2 -0
- package/.docs/models/providers/digitalocean.md +2 -0
- package/.docs/models/providers/dinference.md +2 -0
- package/.docs/models/providers/drun.md +2 -0
- package/.docs/models/providers/evroc.md +2 -0
- package/.docs/models/providers/fastrouter.md +2 -0
- package/.docs/models/providers/firepass.md +2 -0
- package/.docs/models/providers/fireworks-ai.md +2 -0
- package/.docs/models/providers/firmware.md +2 -0
- package/.docs/models/providers/freemodel.md +2 -0
- package/.docs/models/providers/friendli.md +2 -0
- package/.docs/models/providers/frogbot.md +2 -0
- package/.docs/models/providers/github-models.md +2 -0
- package/.docs/models/providers/gmicloud.md +5 -1
- package/.docs/models/providers/google-vertex.md +2 -0
- package/.docs/models/providers/google.md +5 -1
- package/.docs/models/providers/groq.md +2 -0
- package/.docs/models/providers/helicone.md +2 -0
- package/.docs/models/providers/hpc-ai.md +2 -0
- package/.docs/models/providers/huggingface.md +2 -0
- package/.docs/models/providers/iflowcn.md +2 -0
- package/.docs/models/providers/inception.md +2 -0
- package/.docs/models/providers/inceptron.md +2 -0
- package/.docs/models/providers/inference.md +2 -0
- package/.docs/models/providers/io-intelligence.md +2 -0
- package/.docs/models/providers/io-net.md +2 -0
- package/.docs/models/providers/jiekou.md +2 -0
- package/.docs/models/providers/kilo.md +2 -0
- package/.docs/models/providers/kimi-for-coding.md +2 -0
- package/.docs/models/providers/kiro.md +2 -0
- package/.docs/models/providers/kuae-cloud-coding-plan.md +2 -0
- package/.docs/models/providers/lilac.md +2 -0
- package/.docs/models/providers/llama.md +2 -0
- package/.docs/models/providers/llmgateway.md +4 -1
- package/.docs/models/providers/llmtr.md +2 -0
- package/.docs/models/providers/lmstudio.md +2 -0
- package/.docs/models/providers/lucidquery.md +2 -0
- package/.docs/models/providers/meganova.md +2 -0
- package/.docs/models/providers/minimax-cn-coding-plan.md +2 -0
- package/.docs/models/providers/minimax-cn.md +2 -0
- package/.docs/models/providers/minimax-coding-plan.md +2 -0
- package/.docs/models/providers/minimax.md +2 -0
- package/.docs/models/providers/mistral.md +2 -0
- package/.docs/models/providers/mixlayer.md +2 -0
- package/.docs/models/providers/moark.md +2 -0
- package/.docs/models/providers/modelscope.md +2 -0
- package/.docs/models/providers/moonshotai-cn.md +2 -0
- package/.docs/models/providers/moonshotai.md +2 -0
- package/.docs/models/providers/morph.md +2 -0
- package/.docs/models/providers/nano-gpt.md +2 -0
- package/.docs/models/providers/nearai.md +2 -0
- package/.docs/models/providers/nebius.md +2 -0
- package/.docs/models/providers/neon.md +2 -0
- package/.docs/models/providers/neuralwatt.md +2 -0
- package/.docs/models/providers/nova.md +2 -0
- package/.docs/models/providers/novita-ai.md +2 -0
- package/.docs/models/providers/nvidia.md +2 -0
- package/.docs/models/providers/ollama-cloud.md +2 -0
- package/.docs/models/providers/ollama.md +2 -0
- package/.docs/models/providers/openai.md +2 -0
- package/.docs/models/providers/opencode-go.md +2 -0
- package/.docs/models/providers/opencode.md +4 -1
- package/.docs/models/providers/orcarouter.md +2 -0
- package/.docs/models/providers/ovhcloud.md +2 -0
- package/.docs/models/providers/perplexity-agent.md +2 -0
- package/.docs/models/providers/perplexity.md +2 -0
- package/.docs/models/providers/poe.md +2 -0
- package/.docs/models/providers/poolside.md +2 -0
- package/.docs/models/providers/privatemode-ai.md +2 -0
- package/.docs/models/providers/qihang-ai.md +2 -0
- package/.docs/models/providers/qiniu-ai.md +2 -0
- package/.docs/models/providers/regolo-ai.md +2 -0
- package/.docs/models/providers/requesty.md +2 -0
- package/.docs/models/providers/routing-run.md +2 -0
- package/.docs/models/providers/sakana.md +2 -0
- package/.docs/models/providers/sarvam.md +2 -0
- package/.docs/models/providers/scaleway.md +2 -0
- package/.docs/models/providers/siliconflow-cn.md +2 -0
- package/.docs/models/providers/siliconflow.md +2 -0
- package/.docs/models/providers/snowflake-cortex.md +2 -0
- package/.docs/models/providers/stackit.md +2 -0
- package/.docs/models/providers/stepfun-ai.md +2 -0
- package/.docs/models/providers/stepfun.md +2 -0
- package/.docs/models/providers/subconscious.md +2 -0
- package/.docs/models/providers/submodel.md +2 -0
- package/.docs/models/providers/synthetic.md +4 -5
- package/.docs/models/providers/tencent-coding-plan.md +2 -0
- package/.docs/models/providers/tencent-token-plan.md +2 -0
- package/.docs/models/providers/tencent-tokenhub.md +2 -0
- package/.docs/models/providers/the-grid-ai.md +2 -0
- package/.docs/models/providers/tinfoil.md +2 -0
- package/.docs/models/providers/togetherai.md +2 -0
- package/.docs/models/providers/umans-ai-coding-plan.md +2 -0
- package/.docs/models/providers/umans-ai.md +2 -0
- package/.docs/models/providers/upstage.md +2 -0
- package/.docs/models/providers/venice.md +2 -0
- package/.docs/models/providers/vivgrid.md +2 -0
- package/.docs/models/providers/vultr.md +2 -0
- package/.docs/models/providers/wafer.ai.md +2 -0
- package/.docs/models/providers/wandb.md +2 -0
- package/.docs/models/providers/xai.md +2 -0
- package/.docs/models/providers/xiaomi-token-plan-ams.md +2 -0
- package/.docs/models/providers/xiaomi-token-plan-cn.md +2 -0
- package/.docs/models/providers/xiaomi-token-plan-sgp.md +2 -0
- package/.docs/models/providers/xiaomi.md +2 -0
- package/.docs/models/providers/xpersona.md +2 -0
- package/.docs/models/providers/zai-coding-plan.md +2 -0
- package/.docs/models/providers/zai.md +2 -0
- package/.docs/models/providers/zeldoc.md +2 -0
- package/.docs/models/providers/zenmux.md +2 -0
- package/.docs/models/providers/zhipuai-coding-plan.md +2 -0
- package/.docs/models/providers/zhipuai.md +3 -1
- package/.docs/models/providers.md +2 -0
- package/.docs/reference/acp/acp-agent.md +2 -0
- package/.docs/reference/acp/create-acp-tool.md +2 -0
- package/.docs/reference/agent-controller/agent-controller-class.md +2 -0
- package/.docs/reference/agent-controller/session.md +2 -0
- package/.docs/reference/agents/agent.md +35 -4
- package/.docs/reference/agents/channels.md +7 -0
- package/.docs/reference/agents/createSkill.md +2 -0
- package/.docs/reference/agents/durable-agent.md +2 -0
- package/.docs/reference/agents/generate.md +94 -92
- package/.docs/reference/agents/generateLegacy.md +2 -0
- package/.docs/reference/agents/getDefaultGenerateOptions.md +2 -0
- package/.docs/reference/agents/getDefaultOptions.md +2 -0
- package/.docs/reference/agents/getDefaultStreamOptions.md +2 -0
- package/.docs/reference/agents/getDescription.md +2 -0
- package/.docs/reference/agents/getInstructions.md +2 -0
- package/.docs/reference/agents/getLLM.md +2 -0
- package/.docs/reference/agents/getMemory.md +2 -0
- package/.docs/reference/agents/getMetadata.md +2 -0
- package/.docs/reference/agents/getModel.md +2 -0
- package/.docs/reference/agents/getSkill.md +2 -0
- package/.docs/reference/agents/getTools.md +2 -0
- package/.docs/reference/agents/getVoice.md +2 -0
- package/.docs/reference/agents/inngest-agent.md +2 -0
- package/.docs/reference/agents/listAgents.md +2 -0
- package/.docs/reference/agents/listScorers.md +2 -0
- package/.docs/reference/agents/listSkills.md +2 -0
- package/.docs/reference/agents/listSuspendedRuns.md +2 -0
- package/.docs/reference/agents/listTools.md +2 -0
- package/.docs/reference/agents/listWorkflows.md +2 -0
- package/.docs/reference/agents/network.md +2 -0
- package/.docs/reference/ai-sdk/chat-route.md +2 -0
- package/.docs/reference/ai-sdk/handle-chat-stream.md +2 -0
- package/.docs/reference/ai-sdk/handle-network-stream.md +2 -0
- package/.docs/reference/ai-sdk/handle-workflow-stream.md +2 -0
- package/.docs/reference/ai-sdk/network-route.md +2 -0
- package/.docs/reference/ai-sdk/to-ai-sdk-messages.md +2 -0
- package/.docs/reference/ai-sdk/to-ai-sdk-stream.md +2 -0
- package/.docs/reference/ai-sdk/to-ai-sdk-v4-messages.md +2 -0
- package/.docs/reference/ai-sdk/to-ai-sdk-v5-messages.md +2 -0
- package/.docs/reference/ai-sdk/with-mastra.md +2 -0
- package/.docs/reference/ai-sdk/workflow-route.md +2 -0
- package/.docs/reference/ai-sdk/workflow-snapshot-to-stream.md +2 -0
- package/.docs/reference/auth/auth0.md +2 -0
- package/.docs/reference/auth/better-auth.md +2 -0
- package/.docs/reference/auth/clerk.md +2 -0
- package/.docs/reference/auth/firebase.md +2 -0
- package/.docs/reference/auth/google.md +2 -0
- package/.docs/reference/auth/jwt.md +2 -0
- package/.docs/reference/auth/okta.md +2 -0
- package/.docs/reference/auth/supabase.md +2 -0
- package/.docs/reference/auth/workos.md +2 -0
- package/.docs/reference/browser/agent-browser.md +2 -0
- package/.docs/reference/browser/browser-viewer.md +2 -0
- package/.docs/reference/browser/mastra-browser.md +2 -0
- package/.docs/reference/browser/stagehand-browser.md +2 -0
- package/.docs/reference/channels/channel-provider.md +2 -0
- package/.docs/reference/channels/slack-provider.md +2 -0
- package/.docs/reference/cli/create-mastra.md +2 -0
- package/.docs/reference/cli/mastra.md +2 -0
- package/.docs/reference/client-js/agent-builder.md +2 -0
- package/.docs/reference/client-js/agents.md +2 -0
- package/.docs/reference/client-js/conversations.md +2 -0
- package/.docs/reference/client-js/error-handling.md +2 -0
- package/.docs/reference/client-js/logs.md +2 -0
- package/.docs/reference/client-js/mastra-client.md +2 -0
- package/.docs/reference/client-js/memory.md +2 -0
- package/.docs/reference/client-js/observability.md +2 -0
- package/.docs/reference/client-js/responses.md +2 -0
- package/.docs/reference/client-js/telemetry.md +2 -0
- package/.docs/reference/client-js/tools.md +2 -0
- package/.docs/reference/client-js/vectors.md +2 -0
- package/.docs/reference/client-js/workflows.md +2 -0
- package/.docs/reference/coding-agent/build-base-prompt.md +2 -0
- package/.docs/reference/coding-agent/create-coding-agent.md +2 -0
- package/.docs/reference/configuration.md +2 -0
- package/.docs/reference/core/addGateway.md +2 -0
- package/.docs/reference/core/getAgent.md +2 -0
- package/.docs/reference/core/getAgentById.md +2 -0
- package/.docs/reference/core/getDeployer.md +2 -0
- package/.docs/reference/core/getEditor.md +2 -0
- package/.docs/reference/core/getGateway.md +2 -0
- package/.docs/reference/core/getGatewayById.md +2 -0
- package/.docs/reference/core/getLogger.md +2 -0
- package/.docs/reference/core/getMCPServer.md +2 -0
- package/.docs/reference/core/getMCPServerById.md +2 -0
- package/.docs/reference/core/getMemory.md +2 -0
- package/.docs/reference/core/getScorer.md +2 -0
- package/.docs/reference/core/getScorerById.md +2 -0
- package/.docs/reference/core/getServer.md +2 -0
- package/.docs/reference/core/getStorage.md +2 -0
- package/.docs/reference/core/getTelemetry.md +2 -0
- package/.docs/reference/core/getVector.md +2 -0
- package/.docs/reference/core/getWorkflow.md +2 -0
- package/.docs/reference/core/listAgents.md +2 -0
- package/.docs/reference/core/listGateways.md +2 -0
- package/.docs/reference/core/listLogs.md +2 -0
- package/.docs/reference/core/listLogsByRunId.md +2 -0
- package/.docs/reference/core/listMCPServers.md +2 -0
- package/.docs/reference/core/listMemory.md +2 -0
- package/.docs/reference/core/listScorers.md +2 -0
- package/.docs/reference/core/listVectors.md +2 -0
- package/.docs/reference/core/listWorkflows.md +2 -0
- package/.docs/reference/core/mastra-class.md +2 -0
- package/.docs/reference/core/mastra-model-gateway.md +2 -0
- package/.docs/reference/core/removeWorkspace.md +2 -0
- package/.docs/reference/core/setLogger.md +2 -0
- package/.docs/reference/core/setStorage.md +2 -0
- package/.docs/reference/datasets/addItem.md +2 -0
- package/.docs/reference/datasets/addItems.md +2 -0
- package/.docs/reference/datasets/compareExperiments.md +2 -0
- package/.docs/reference/datasets/create.md +2 -0
- package/.docs/reference/datasets/dataset.md +2 -0
- package/.docs/reference/datasets/datasets-manager.md +2 -0
- package/.docs/reference/datasets/delete.md +2 -0
- package/.docs/reference/datasets/deleteExperiment.md +2 -0
- package/.docs/reference/datasets/deleteItem.md +2 -0
- package/.docs/reference/datasets/deleteItems.md +2 -0
- package/.docs/reference/datasets/get.md +2 -0
- package/.docs/reference/datasets/getDetails.md +2 -0
- package/.docs/reference/datasets/getExperiment.md +2 -0
- package/.docs/reference/datasets/getItem.md +2 -0
- package/.docs/reference/datasets/getItemHistory.md +2 -0
- package/.docs/reference/datasets/list.md +2 -0
- package/.docs/reference/datasets/listExperimentResults.md +2 -0
- package/.docs/reference/datasets/listExperiments.md +2 -0
- package/.docs/reference/datasets/listItems.md +2 -0
- package/.docs/reference/datasets/listVersions.md +2 -0
- package/.docs/reference/datasets/startExperiment.md +2 -0
- package/.docs/reference/datasets/startExperimentAsync.md +2 -0
- package/.docs/reference/datasets/update.md +2 -0
- package/.docs/reference/datasets/updateItem.md +2 -0
- package/.docs/reference/deployer/cloudflare.md +2 -0
- package/.docs/reference/deployer/netlify.md +2 -0
- package/.docs/reference/deployer/vercel.md +2 -0
- package/.docs/reference/deployer.md +2 -0
- package/.docs/reference/editor/agent-builder/agent-builder-options.md +2 -0
- package/.docs/reference/editor/agent-builder/builder-agent-defaults.md +2 -0
- package/.docs/reference/editor/agent-builder/builder-models.md +2 -0
- package/.docs/reference/editor/blob-store-provider.md +2 -0
- package/.docs/reference/editor/browser-provider.md +2 -0
- package/.docs/reference/editor/filesystem-provider.md +2 -0
- package/.docs/reference/editor/mastra-editor.md +2 -0
- package/.docs/reference/editor/processor-provider.md +2 -0
- package/.docs/reference/editor/sandbox-provider.md +2 -0
- package/.docs/reference/editor/storage-browser-ref.md +2 -0
- package/.docs/reference/editor/storage-workspace-ref.md +2 -0
- package/.docs/reference/editor/tool-provider.md +2 -0
- package/.docs/reference/evals/answer-relevancy.md +2 -0
- package/.docs/reference/evals/answer-similarity.md +2 -0
- package/.docs/reference/evals/bias.md +2 -0
- package/.docs/reference/evals/checks.md +2 -0
- package/.docs/reference/evals/completeness.md +2 -0
- package/.docs/reference/evals/content-similarity.md +2 -0
- package/.docs/reference/evals/context-precision.md +2 -0
- package/.docs/reference/evals/context-relevance.md +2 -0
- package/.docs/reference/evals/create-scorer.md +2 -0
- package/.docs/reference/evals/faithfulness.md +2 -0
- package/.docs/reference/evals/filter-run.md +2 -0
- package/.docs/reference/evals/hallucination.md +3 -0
- package/.docs/reference/evals/keyword-coverage.md +2 -0
- package/.docs/reference/evals/mastra-scorer.md +2 -0
- package/.docs/reference/evals/noise-sensitivity.md +2 -0
- package/.docs/reference/evals/prompt-alignment.md +3 -0
- package/.docs/reference/evals/rubric.md +2 -0
- package/.docs/reference/evals/run-evals.md +2 -0
- package/.docs/reference/evals/scorer-utils.md +2 -0
- package/.docs/reference/evals/textual-difference.md +2 -0
- package/.docs/reference/evals/tone-consistency.md +2 -0
- package/.docs/reference/evals/tool-call-accuracy.md +2 -0
- package/.docs/reference/evals/toxicity.md +2 -0
- package/.docs/reference/evals/trajectory-accuracy.md +2 -0
- package/.docs/reference/index.md +5 -0
- package/.docs/reference/logging/pino-logger.md +2 -0
- package/.docs/reference/mastra-platform/api.md +2 -0
- package/.docs/reference/memory/clone-utilities.md +2 -0
- package/.docs/reference/memory/cloneThread.md +2 -0
- package/.docs/reference/memory/createThread.md +2 -0
- package/.docs/reference/memory/deleteMessages.md +2 -0
- package/.docs/reference/memory/getThreadById.md +2 -0
- package/.docs/reference/memory/listThreads.md +2 -0
- package/.docs/reference/memory/memory-class.md +3 -0
- package/.docs/reference/memory/observational-memory.md +10 -0
- package/.docs/reference/memory/recall.md +2 -0
- package/.docs/reference/memory/serialized-memory-config.md +2 -0
- package/.docs/reference/observability/metrics/automatic-metrics.md +2 -0
- package/.docs/reference/observability/tracing/bridges/datadog.md +2 -0
- package/.docs/reference/observability/tracing/bridges/otel.md +2 -0
- package/.docs/reference/observability/tracing/configuration.md +2 -0
- package/.docs/reference/observability/tracing/exporters/arize.md +2 -0
- package/.docs/reference/observability/tracing/exporters/arthur.md +2 -0
- package/.docs/reference/observability/tracing/exporters/braintrust.md +2 -0
- package/.docs/reference/observability/tracing/exporters/cloud-exporter.md +2 -0
- package/.docs/reference/observability/tracing/exporters/console-exporter.md +2 -0
- package/.docs/reference/observability/tracing/exporters/datadog.md +2 -0
- package/.docs/reference/observability/tracing/exporters/default-exporter.md +2 -0
- package/.docs/reference/observability/tracing/exporters/laminar.md +2 -0
- package/.docs/reference/observability/tracing/exporters/langfuse.md +3 -0
- package/.docs/reference/observability/tracing/exporters/langsmith.md +2 -0
- package/.docs/reference/observability/tracing/exporters/mastra-platform-exporter.md +2 -0
- package/.docs/reference/observability/tracing/exporters/mastra-storage-exporter.md +2 -0
- package/.docs/reference/observability/tracing/exporters/otel.md +2 -0
- package/.docs/reference/observability/tracing/exporters/posthog.md +2 -0
- package/.docs/reference/observability/tracing/exporters/sentry.md +2 -0
- package/.docs/reference/observability/tracing/instances.md +2 -0
- package/.docs/reference/observability/tracing/interfaces.md +2 -0
- package/.docs/reference/observability/tracing/processors/sensitive-data-filter.md +2 -0
- package/.docs/reference/observability/tracing/span-filtering.md +2 -0
- package/.docs/reference/observability/tracing/spans.md +2 -0
- package/.docs/reference/processors/batch-parts-processor.md +3 -0
- package/.docs/reference/processors/cost-guard-processor.md +3 -0
- package/.docs/reference/processors/language-detector.md +2 -0
- package/.docs/reference/processors/message-history-processor.md +3 -0
- package/.docs/reference/processors/moderation-processor.md +4 -0
- package/.docs/reference/processors/pii-detector.md +4 -0
- package/.docs/reference/processors/prefill-error-handler.md +4 -0
- package/.docs/reference/processors/processor-interface.md +5 -2
- package/.docs/reference/processors/prompt-injection-detector.md +3 -0
- package/.docs/reference/processors/provider-history-compat.md +4 -0
- package/.docs/reference/processors/regex-filter-processor.md +3 -0
- package/.docs/reference/processors/response-cache.md +3 -0
- package/.docs/reference/processors/semantic-recall-processor.md +3 -0
- package/.docs/reference/processors/skill-search-processor.md +3 -0
- package/.docs/reference/processors/stream-error-retry-processor.md +4 -0
- package/.docs/reference/processors/system-prompt-scrubber.md +3 -0
- package/.docs/reference/processors/token-limiter-processor.md +5 -0
- package/.docs/reference/processors/tool-call-filter.md +4 -0
- package/.docs/reference/processors/tool-search-processor.md +4 -0
- package/.docs/reference/processors/unicode-normalizer.md +2 -0
- package/.docs/reference/processors/working-memory-processor.md +3 -0
- package/.docs/reference/pubsub/base.md +2 -0
- package/.docs/reference/pubsub/caching-pubsub.md +2 -0
- package/.docs/reference/pubsub/event-emitter.md +2 -0
- package/.docs/reference/pubsub/google-cloud-pubsub.md +2 -0
- package/.docs/reference/pubsub/lease-provider.md +2 -0
- package/.docs/reference/pubsub/redis-streams.md +2 -0
- package/.docs/reference/pubsub/unix-socket-pubsub.md +2 -0
- package/.docs/reference/rag/chunk.md +2 -0
- package/.docs/reference/rag/database-config.md +2 -0
- package/.docs/reference/rag/document.md +2 -0
- package/.docs/reference/rag/embeddings.md +2 -0
- package/.docs/reference/rag/extract-params.md +2 -0
- package/.docs/reference/rag/graph-rag.md +2 -0
- package/.docs/reference/rag/metadata-filters.md +2 -0
- package/.docs/reference/rag/rerank.md +2 -0
- package/.docs/reference/rag/rerankWithScorer.md +2 -0
- package/.docs/reference/server/create-route.md +2 -0
- package/.docs/reference/server/express-adapter.md +2 -0
- package/.docs/reference/server/fastify-adapter.md +2 -0
- package/.docs/reference/server/hono-adapter.md +2 -0
- package/.docs/reference/server/koa-adapter.md +2 -0
- package/.docs/reference/server/mastra-server.md +2 -0
- package/.docs/reference/server/nestjs-adapter.md +2 -0
- package/.docs/reference/server/register-api-route.md +2 -0
- package/.docs/reference/server/routes.md +2 -0
- package/.docs/reference/signals/create-notification-inbox-tool.md +2 -0
- package/.docs/reference/signals/signal-provider.md +3 -0
- package/.docs/reference/signals/task-signal-provider.md +3 -0
- package/.docs/reference/signals/webhook-signal-provider.md +3 -0
- package/.docs/reference/storage/clickhouse.md +2 -0
- package/.docs/reference/storage/cloudflare-d1.md +2 -0
- package/.docs/reference/storage/cloudflare.md +2 -0
- package/.docs/reference/storage/composite.md +2 -0
- package/.docs/reference/storage/convex.md +2 -0
- package/.docs/reference/storage/dsql.md +2 -0
- package/.docs/reference/storage/duckdb.md +2 -0
- package/.docs/reference/storage/dynamodb.md +2 -0
- package/.docs/reference/storage/lance.md +2 -0
- package/.docs/reference/storage/libsql.md +2 -0
- package/.docs/reference/storage/mongodb.md +2 -0
- package/.docs/reference/storage/mssql.md +2 -0
- package/.docs/reference/storage/overview.md +2 -0
- package/.docs/reference/storage/postgresql.md +2 -0
- package/.docs/reference/storage/redis.md +2 -0
- package/.docs/reference/storage/retention.md +180 -0
- package/.docs/reference/storage/spanner.md +2 -0
- package/.docs/reference/storage/upstash.md +2 -0
- package/.docs/reference/streaming/ChunkType.md +2 -0
- package/.docs/reference/streaming/agents/MastraModelOutput.md +2 -0
- package/.docs/reference/streaming/agents/stream.md +2 -0
- package/.docs/reference/streaming/agents/streamLegacy.md +2 -0
- package/.docs/reference/streaming/agents/streamUntilIdle.md +2 -0
- package/.docs/reference/streaming/workflows/observeStream.md +2 -0
- package/.docs/reference/streaming/workflows/resumeStream.md +2 -0
- package/.docs/reference/streaming/workflows/stream.md +2 -0
- package/.docs/reference/streaming/workflows/timeTravelStream.md +2 -0
- package/.docs/reference/templates/overview.md +3 -0
- package/.docs/reference/tools/brightdata.md +2 -0
- package/.docs/reference/tools/create-code-mode.md +3 -0
- package/.docs/reference/tools/create-tool.md +62 -58
- package/.docs/reference/tools/document-chunker-tool.md +2 -0
- package/.docs/reference/tools/graph-rag-tool.md +2 -0
- package/.docs/reference/tools/mcp-client.md +3 -0
- package/.docs/reference/tools/mcp-server.md +3 -1
- package/.docs/reference/tools/perplexity.md +2 -0
- package/.docs/reference/tools/tavily.md +2 -0
- package/.docs/reference/tools/vector-query-tool.md +2 -0
- package/.docs/reference/vectors/astra.md +2 -0
- package/.docs/reference/vectors/chroma.md +2 -0
- package/.docs/reference/vectors/convex.md +2 -0
- package/.docs/reference/vectors/couchbase.md +2 -0
- package/.docs/reference/vectors/duckdb.md +2 -0
- package/.docs/reference/vectors/elasticsearch.md +2 -0
- package/.docs/reference/vectors/lance.md +2 -0
- package/.docs/reference/vectors/libsql.md +2 -0
- package/.docs/reference/vectors/mongodb.md +2 -0
- package/.docs/reference/vectors/opensearch.md +2 -0
- package/.docs/reference/vectors/pg.md +2 -0
- package/.docs/reference/vectors/pinecone.md +2 -0
- package/.docs/reference/vectors/qdrant.md +2 -0
- package/.docs/reference/vectors/s3vectors.md +2 -0
- package/.docs/reference/vectors/turbopuffer.md +2 -0
- package/.docs/reference/vectors/upstash.md +2 -0
- package/.docs/reference/vectors/vectorize.md +2 -0
- package/.docs/reference/voice/aws-nova-sonic.md +2 -0
- package/.docs/reference/voice/azure.md +2 -0
- package/.docs/reference/voice/cloudflare.md +2 -0
- package/.docs/reference/voice/composite-voice.md +2 -0
- package/.docs/reference/voice/deepgram.md +2 -0
- package/.docs/reference/voice/elevenlabs.md +2 -0
- package/.docs/reference/voice/google-gemini-live.md +2 -0
- package/.docs/reference/voice/google.md +2 -0
- package/.docs/reference/voice/inworld-realtime.md +2 -0
- package/.docs/reference/voice/inworld.md +2 -0
- package/.docs/reference/voice/mastra-voice.md +2 -0
- package/.docs/reference/voice/murf.md +2 -0
- package/.docs/reference/voice/openai-realtime.md +2 -0
- package/.docs/reference/voice/openai.md +2 -0
- package/.docs/reference/voice/playai.md +2 -0
- package/.docs/reference/voice/sarvam.md +2 -0
- package/.docs/reference/voice/speechify.md +2 -0
- package/.docs/reference/voice/voice.addInstructions.md +3 -0
- package/.docs/reference/voice/voice.addTools.md +2 -0
- package/.docs/reference/voice/voice.answer.md +2 -0
- package/.docs/reference/voice/voice.close.md +2 -0
- package/.docs/reference/voice/voice.connect.md +2 -0
- package/.docs/reference/voice/voice.events.md +2 -0
- package/.docs/reference/voice/voice.getSpeakers.md +2 -0
- package/.docs/reference/voice/voice.listen.md +2 -0
- package/.docs/reference/voice/voice.off.md +2 -0
- package/.docs/reference/voice/voice.on.md +2 -0
- package/.docs/reference/voice/voice.send.md +2 -0
- package/.docs/reference/voice/voice.speak.md +2 -0
- package/.docs/reference/voice/voice.updateConfig.md +2 -0
- package/.docs/reference/voice/xai-realtime.md +2 -0
- package/.docs/reference/workflows/run-methods/cancel.md +2 -0
- package/.docs/reference/workflows/run-methods/restart.md +2 -0
- package/.docs/reference/workflows/run-methods/resume.md +2 -0
- package/.docs/reference/workflows/run-methods/start.md +2 -0
- package/.docs/reference/workflows/run-methods/startAsync.md +2 -0
- package/.docs/reference/workflows/run-methods/timeTravel.md +2 -0
- package/.docs/reference/workflows/run.md +2 -0
- package/.docs/reference/workflows/step.md +2 -0
- package/.docs/reference/workflows/workflow-methods/branch.md +2 -0
- package/.docs/reference/workflows/workflow-methods/commit.md +2 -0
- package/.docs/reference/workflows/workflow-methods/create-run.md +2 -0
- package/.docs/reference/workflows/workflow-methods/dountil.md +2 -0
- package/.docs/reference/workflows/workflow-methods/dowhile.md +2 -0
- package/.docs/reference/workflows/workflow-methods/foreach.md +2 -0
- package/.docs/reference/workflows/workflow-methods/map.md +2 -0
- package/.docs/reference/workflows/workflow-methods/parallel.md +2 -0
- package/.docs/reference/workflows/workflow-methods/sleep.md +2 -0
- package/.docs/reference/workflows/workflow-methods/sleepUntil.md +2 -0
- package/.docs/reference/workflows/workflow-methods/then.md +2 -0
- package/.docs/reference/workflows/workflow-state-reader.md +2 -0
- package/.docs/reference/workflows/workflow.md +2 -0
- package/.docs/reference/workspace/agentcore-runtime-sandbox.md +3 -0
- package/.docs/reference/workspace/agentfs-filesystem.md +3 -0
- package/.docs/reference/workspace/apple-container-sandbox.md +259 -0
- package/.docs/reference/workspace/archil-filesystem.md +3 -0
- package/.docs/reference/workspace/azure-blob-filesystem.md +3 -0
- package/.docs/reference/workspace/blaxel-sandbox.md +2 -0
- package/.docs/reference/workspace/daytona-sandbox.md +2 -0
- package/.docs/reference/workspace/docker-sandbox.md +3 -0
- package/.docs/reference/workspace/e2b-sandbox.md +3 -0
- package/.docs/reference/workspace/files-sdk-filesystem.md +3 -0
- package/.docs/reference/workspace/filesystem.md +2 -0
- package/.docs/reference/workspace/gcs-filesystem.md +3 -0
- package/.docs/reference/workspace/google-drive-filesystem.md +2 -0
- package/.docs/reference/workspace/local-filesystem.md +2 -0
- package/.docs/reference/workspace/local-sandbox.md +2 -0
- package/.docs/reference/workspace/mesa-filesystem.md +321 -0
- package/.docs/reference/workspace/modal-sandbox.md +2 -0
- package/.docs/reference/workspace/process-manager.md +2 -0
- package/.docs/reference/workspace/railway-sandbox.md +2 -0
- package/.docs/reference/workspace/s3-filesystem.md +3 -0
- package/.docs/reference/workspace/sandbox.md +2 -0
- package/.docs/reference/workspace/vercel-microvm-sandbox.md +2 -0
- package/.docs/reference/workspace/vercel.md +3 -0
- package/.docs/reference/workspace/workspace-class.md +2 -0
- package/CHANGELOG.md +23 -0
- package/package.json +4 -4
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
|
|
2
|
+
|
|
1
3
|
# BrowserViewer
|
|
2
4
|
|
|
3
5
|
The `@mastra/browser-viewer` package provides browser automation for CLI-based tools like [agent-browser](https://www.npmjs.com/package/agent-browser), [browser-use](https://pypi.org/project/browser-use/), and [browse](https://www.npmjs.com/package/browse). BrowserViewer launches Chrome via Playwright, exposes a Chrome DevTools Protocol (CDP) URL, and automatically injects it into CLI commands run through [workspace tools](https://mastra.ai/docs/workspace/overview).
|
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
|
|
2
|
+
|
|
1
3
|
# Browser overview
|
|
2
4
|
|
|
3
5
|
Browser support enables agents to navigate websites, interact with page elements, fill forms, and extract data. Mastra provides browser capabilities through SDK providers that wrap browser automation libraries and a CLI provider for agents that drive browsers through command-line tools.
|
|
@@ -1,8 +1,12 @@
|
|
|
1
|
-
|
|
1
|
+
> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
|
|
2
|
+
|
|
3
|
+
# Browser recording (beta)
|
|
4
|
+
|
|
5
|
+
**Added in:** `@mastra/core@1.43.0`
|
|
2
6
|
|
|
3
7
|
Browser recording adds two opt-in tools that let an agent save a browser session as a Motion-JPEG AVI video. The agent can also add short captions while it works.
|
|
4
8
|
|
|
5
|
-
> **
|
|
9
|
+
> **Beta:** This feature is in beta. Breaking changes may occur without a major version bump until the API is stable.
|
|
6
10
|
|
|
7
11
|
## When to use browser recording
|
|
8
12
|
|
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
|
|
2
|
+
|
|
1
3
|
# Stagehand
|
|
2
4
|
|
|
3
5
|
The `@mastra/stagehand` package provides browser automation using the [Stagehand SDK](https://docs.browserbase.com/stagehand/introduction) from Browserbase. Stagehand uses AI to understand page context and locate elements, enabling natural language descriptions instead of explicit selectors.
|
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
|
|
2
|
+
|
|
1
3
|
# Contributing templates
|
|
2
4
|
|
|
3
5
|
The Mastra community plays a vital role in creating templates that showcase innovative application patterns. We're currently reworking our template contribution process to ensure high-quality, valuable templates for the community. For the time being, we're not accepting new template contributions. Please keep an eye on this page for updates on when contributions will reopen and the new submission process.
|
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
|
|
2
|
+
|
|
1
3
|
# Discord community
|
|
2
4
|
|
|
3
5
|
The Discord server has over 1000 members and serves as the main discussion forum for Mastra. The Mastra team monitors Discord during North American and European business hours, with community members active across other time zones.
|
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
|
|
2
|
+
|
|
1
3
|
# Deploy to cloud providers
|
|
2
4
|
|
|
3
5
|
Mastra applications can be deployed to cloud providers and serverless platforms. Mastra includes optional built-in deployers for Vercel, Netlify, and Cloudflare to automate the deployment process.
|
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
|
|
2
|
+
|
|
1
3
|
# Deploy in a monorepo
|
|
2
4
|
|
|
3
5
|
Deploying Mastra in a monorepo follows the same process as a standalone application. This guide covers monorepo-specific considerations. For the core build and deployment steps, see [Deploy a Mastra Server](https://mastra.ai/docs/deployment/mastra-server).
|
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
|
|
2
|
+
|
|
1
3
|
# Deployment overview
|
|
2
4
|
|
|
3
5
|
Mastra applications can be deployed to any Node.js-compatible environment. You can deploy a Mastra server, integrate with an existing web framework, deploy to cloud providers, or use [Mastra platform](https://mastra.ai/docs/mastra-platform/overview) for observability, Studio, and server deployment.
|
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
|
|
2
|
+
|
|
1
3
|
# Deploy with a web framework
|
|
2
4
|
|
|
3
5
|
When Mastra is integrated with a web framework, it deploys alongside your application using the framework's standard deployment process. Follow the instructions below to ensure your Mastra integration deploys correctly.
|
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
|
|
2
|
+
|
|
1
3
|
# Workflow runners
|
|
2
4
|
|
|
3
5
|
Mastra [workflows](https://mastra.ai/docs/workflows/overview) can be executed using the built-in workflow runner or deployed to specialized workflow execution platforms that handle orchestration, monitoring, and reliability.
|
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
|
|
2
|
+
|
|
1
3
|
# Editor overview
|
|
2
4
|
|
|
3
5
|
The editor is a CMS-style system that separates agent configuration from code. Subject-matter experts, prompt engineers, and product teams can iterate on agents directly while developers keep the codebase stable.
|
|
@@ -194,6 +196,7 @@ Use the `editor` field on a code-defined agent to control which fields the edito
|
|
|
194
196
|
import { Agent } from '@mastra/core/agent'
|
|
195
197
|
|
|
196
198
|
export const supportAgent = new Agent({
|
|
199
|
+
id: 'support-agent',
|
|
197
200
|
name: 'support-agent',
|
|
198
201
|
model: 'openai/gpt-5.5',
|
|
199
202
|
editor: { instructions: true, tools: { description: true } },
|
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
|
|
2
|
+
|
|
1
3
|
# Prompts
|
|
2
4
|
|
|
3
5
|
Prompt blocks are reusable instruction templates that you compose into an agent's system prompt. Each block can contain plain text, template variables, and display conditions. Non-technical team members can edit prompt content, test different phrasings, and publish changes. Every edit is versioned, so you can compare prompt variations, roll back, and track what changed over time. You can create and manage prompt blocks through the Studio UI or programmatically through the server API, then reference them across multiple agents.
|
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
|
|
2
|
+
|
|
1
3
|
# Built-in scorers
|
|
2
4
|
|
|
3
5
|
Mastra provides a comprehensive set of built-in scorers for evaluating AI outputs. These scorers are optimized for common evaluation scenarios and are ready to use in your agents and workflows.
|
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
|
|
2
|
+
|
|
1
3
|
# Custom scorers
|
|
2
4
|
|
|
3
5
|
Mastra provides a unified `createScorer` factory that allows you to build custom evaluation logic using either JavaScript functions or LLM-based prompt objects for each step. This flexibility lets you choose the best approach for each part of your evaluation pipeline.
|
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
|
|
2
|
+
|
|
1
3
|
# Evals with memory
|
|
2
4
|
|
|
3
5
|
Agents that use memory in `thread` scope — including observational memory — require a thread ID at run time. When an eval invokes the agent without one, you'll see:
|
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
|
|
2
|
+
|
|
1
3
|
# Gates and verdicts
|
|
2
4
|
|
|
3
5
|
Gates and verdicts add severity semantics to `runEvals`. Gates are scorers that must score 1.0 — hard requirements that block a run. Thresholds are minimum acceptable scores on tracked metrics. The verdict summarizes the outcome as `passed`, `scored`, or `failed`.
|
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
|
|
2
|
+
|
|
1
3
|
# Scorers overview
|
|
2
4
|
|
|
3
5
|
While traditional software tests have clear pass/fail conditions, AI outputs are non-deterministic — they can vary with the same input. **Scorers** help bridge this gap by providing quantifiable metrics for measuring agent quality.
|
|
@@ -55,6 +57,7 @@ import { Agent } from '@mastra/core/agent'
|
|
|
55
57
|
import { createAnswerRelevancyScorer, createToxicityScorer } from '@mastra/evals/scorers/prebuilt'
|
|
56
58
|
|
|
57
59
|
export const evaluatedAgent = new Agent({
|
|
60
|
+
id: 'evaluated-agent',
|
|
58
61
|
scorers: {
|
|
59
62
|
relevancy: {
|
|
60
63
|
scorer: createAnswerRelevancyScorer({ model: 'openai/gpt-5-mini' }),
|
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
|
|
2
|
+
|
|
1
3
|
# Quick Checks
|
|
2
4
|
|
|
3
5
|
Quick Checks are composable micro-scorers for common assertions like "output contains X" or "agent called tool Y." They require no LLM, run instantly, and plug into the same `scorers: [...]` array as any other scorer.
|
|
@@ -100,6 +102,7 @@ import { Agent } from '@mastra/core/agent'
|
|
|
100
102
|
import { checks } from '@mastra/evals/checks'
|
|
101
103
|
|
|
102
104
|
export const weatherAgent = new Agent({
|
|
105
|
+
id: 'weather-agent',
|
|
103
106
|
name: 'Weather Agent',
|
|
104
107
|
instructions: 'Answer weather questions using the get_weather tool.',
|
|
105
108
|
model: 'openai/gpt-5.5',
|
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
|
|
2
|
+
|
|
1
3
|
# Running scorers in CI
|
|
2
4
|
|
|
3
5
|
Running scorers in your CI pipeline provides quantifiable metrics for measuring agent quality over time. The `runEvals` function processes multiple test cases through your agent or workflow and returns aggregate scores.
|
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
|
|
2
|
+
|
|
1
3
|
# Build with AI
|
|
2
4
|
|
|
3
5
|
AI agents may not have up-to-date knowledge about Mastra's APIs, patterns, and best practices. These resources give your AI tools direct access to current Mastra documentation, enabling them to generate accurate code and help you build faster.
|
|
@@ -132,13 +134,11 @@ In addition to the [context files](#context-files) each documentation page also
|
|
|
132
134
|
|
|
133
135
|
## MCP docs server
|
|
134
136
|
|
|
135
|
-
The `@mastra/mcp-docs-server` package provides direct access to Mastra’s full documentation via the [Model Context Protocol (MCP)](https://modelcontextprotocol.io/docs/getting-started/intro). It works with Cursor, Windsurf, Cline, Claude Code, VS Code, Codex or any tool that supports MCP.
|
|
136
|
-
|
|
137
|
-
These tools are designed to help agents retrieve precise, task-specific information — whether you're adding a feature to an agent, scaffolding a new project, or exploring how something works.
|
|
137
|
+
The `@mastra/mcp-docs-server` package provides direct local access to Mastra’s full documentation via the [Model Context Protocol (MCP)](https://modelcontextprotocol.io/docs/getting-started/intro). It works with Cursor, Windsurf, Cline, Claude Code, VS Code, Codex or any tool that supports MCP.
|
|
138
138
|
|
|
139
|
-
|
|
139
|
+
These tools are designed to help agents retrieve precise, task-specific information, whether you're adding a feature to an agent, scaffolding a new project, or exploring how something works.
|
|
140
140
|
|
|
141
|
-
|
|
141
|
+
If you're unable to use a local MCP server and need to connect to a remote server, use this URL: `https://mastra.mcp.kapa.ai`. You need to authenticate with your Google Account (only an anonymous ID is transmitted) for rate-limiting purposes. If possible, Mastra recommends using a local MCP server for better performance and reliability.
|
|
142
142
|
|
|
143
143
|
### Installation
|
|
144
144
|
|
|
@@ -1,5 +1,9 @@
|
|
|
1
|
+
> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
|
|
2
|
+
|
|
1
3
|
# Manual install
|
|
2
4
|
|
|
5
|
+
**For AI agents:** Use this guide when tasked to create a runnable Mastra project from scratch without a CLI/boilerplate. It provides code examples for agents, tools, model configuration and how to install dependencies. Do not navigate to the quickstart guide, which is for humans.
|
|
6
|
+
|
|
3
7
|
> **Info:** Use this guide to manually build a standalone Mastra server step by step. In most cases, it's quicker to follow the [quickstart guide](https://mastra.ai/guides/getting-started/quickstart), which achieves the same result using the [`mastra create`](https://mastra.ai/reference/cli/create-mastra) command. For existing projects, you can also use [`mastra init`](https://mastra.ai/reference/cli/mastra).
|
|
4
8
|
|
|
5
9
|
If you prefer not to use our automatic CLI tool, you can set up your project yourself by following the guide below.
|
|
@@ -118,12 +122,16 @@ If you prefer not to use our automatic CLI tool, you can set up your project you
|
|
|
118
122
|
|
|
119
123
|
> **Note:** This guide uses Google Gemini, but you can use any supported [model provider](https://mastra.ai/models), including OpenAI, Anthropic, and more.
|
|
120
124
|
|
|
125
|
+
You can also use OpenAI (`OPENAI_API_KEY`) or Anthropic (`ANTHROPIC_API_KEY`) instead of Google Gemini. Go to <https://mastra.ai/models/environment-variables> for a full list of supported providers and their environment variable names.
|
|
126
|
+
|
|
121
127
|
4. Create a `weather-tool.ts` file:
|
|
122
128
|
|
|
123
129
|
```bash
|
|
124
130
|
mkdir -p src/mastra/tools && touch src/mastra/tools/weather-tool.ts
|
|
125
131
|
```
|
|
126
132
|
|
|
133
|
+
Use `import { createTool } from "@mastra/core/tools"`. Plain object tool definitions silently fail to execute; tools MUST be defined via createTool() with id, description, inputSchema (zod), execute
|
|
134
|
+
|
|
127
135
|
Add the following code:
|
|
128
136
|
|
|
129
137
|
```ts
|
|
@@ -139,9 +147,9 @@ If you prefer not to use our automatic CLI tool, you can set up your project you
|
|
|
139
147
|
outputSchema: z.object({
|
|
140
148
|
output: z.string(),
|
|
141
149
|
}),
|
|
142
|
-
execute: async () => {
|
|
150
|
+
execute: async ({ location }) => {
|
|
143
151
|
return {
|
|
144
|
-
output:
|
|
152
|
+
output: `The weather in ${location} is sunny`,
|
|
145
153
|
}
|
|
146
154
|
},
|
|
147
155
|
})
|
|
@@ -155,11 +163,13 @@ If you prefer not to use our automatic CLI tool, you can set up your project you
|
|
|
155
163
|
mkdir -p src/mastra/agents && touch src/mastra/agents/weather-agent.ts
|
|
156
164
|
```
|
|
157
165
|
|
|
166
|
+
Use `import { Agent } from "@mastra/core/agent"`. Constructor takes `{ id, name, instructions, model: 'openai/gpt-5.5' }`. The model string is Mastra's model router format ('provider/model'; use / and not : to separate provider and model). Do not install any ai-sdk package unless Mastra's documentation says otherwise.
|
|
167
|
+
|
|
158
168
|
Add the following code:
|
|
159
169
|
|
|
160
170
|
```ts
|
|
161
171
|
import { Agent } from '@mastra/core/agent'
|
|
162
|
-
import { weatherTool } from '../tools/weather-tool'
|
|
172
|
+
import { weatherTool } from '../tools/weather-tool.ts'
|
|
163
173
|
|
|
164
174
|
export const weatherAgent = new Agent({
|
|
165
175
|
id: 'weather-agent',
|
|
@@ -191,14 +201,16 @@ If you prefer not to use our automatic CLI tool, you can set up your project you
|
|
|
191
201
|
|
|
192
202
|
```ts
|
|
193
203
|
import { Mastra } from '@mastra/core'
|
|
194
|
-
import { weatherAgent } from './agents/weather-agent'
|
|
204
|
+
import { weatherAgent } from './agents/weather-agent.ts'
|
|
195
205
|
|
|
196
206
|
export const mastra = new Mastra({
|
|
197
207
|
agents: { weatherAgent },
|
|
198
208
|
})
|
|
199
209
|
```
|
|
200
210
|
|
|
201
|
-
7.
|
|
211
|
+
7. **For AI agents:** Do not launch Studio when working on a script that e.g. should print to the console. Studio is a long-running web-based interfaced for humans. Instead, call the agent.generate() method directly. Example: `import { mastra } from './src/mastra/index.ts'; const agent = mastra.getAgentById('weather-agent'); const response = await agent.generate('Weather in SF'); console.log(response.text);`
|
|
212
|
+
|
|
213
|
+
You can now launch [Studio](https://mastra.ai/docs/studio/overview) and test your agent.
|
|
202
214
|
|
|
203
215
|
**npm**:
|
|
204
216
|
|
package/.docs/docs/index.md
CHANGED
|
@@ -1,7 +1,119 @@
|
|
|
1
|
+
> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
|
|
2
|
+
|
|
1
3
|
# Get started
|
|
2
4
|
|
|
3
5
|
Build AI agents your users actually depend on. Mastra is a TypeScript framework that gives you everything you need to prototype fast and ship with confidence. Create your first agent with a single command and start building.
|
|
4
6
|
|
|
7
|
+
**For AI agents:** If you're tasked to build a Mastra project from scratch, follow the condensed instructions until the next heading. Adjust the example code for the agent & tool to your needs.
|
|
8
|
+
|
|
9
|
+
Create a `package.json` file with `{ "type": "module" }`. Install the required dependencies: `npm install @mastra/core@latest zod@latest typescript@latest @types/node@latest mastra@latest`
|
|
10
|
+
|
|
11
|
+
Create a tsconfig.json file:
|
|
12
|
+
|
|
13
|
+
```json
|
|
14
|
+
{
|
|
15
|
+
"compilerOptions": {
|
|
16
|
+
"target": "ES2022",
|
|
17
|
+
"module": "ES2022",
|
|
18
|
+
"moduleResolution": "bundler",
|
|
19
|
+
"esModuleInterop": true,
|
|
20
|
+
"forceConsistentCasingInFileNames": true,
|
|
21
|
+
"strict": true,
|
|
22
|
+
"skipLibCheck": true,
|
|
23
|
+
"noEmit": true,
|
|
24
|
+
"allowImportingTsExtensions": true,
|
|
25
|
+
"outDir": "dist"
|
|
26
|
+
},
|
|
27
|
+
"include": ["src/**/*"]
|
|
28
|
+
}
|
|
29
|
+
```
|
|
30
|
+
|
|
31
|
+
If you need to add a tool to the agent, create a new file and use `import { createTool } from "@mastra/core/tools"`. Plain object tool definitions silently fail to execute; tools MUST be defined via `createTool()` with `id`, `description`, `inputSchema` (zod), `execute()`. `execute()` receives two parameters: the validated input data based on inputSchema (first parameter) and an optional execution context object (second parameter) containing `requestContext`, `tracingContext`, `abortSignal`, and other execution metadata.
|
|
32
|
+
|
|
33
|
+
Example:
|
|
34
|
+
|
|
35
|
+
```ts
|
|
36
|
+
// src/mastra/tools/weather-tool.ts
|
|
37
|
+
import { createTool } from '@mastra/core/tools'
|
|
38
|
+
import { z } from 'zod'
|
|
39
|
+
|
|
40
|
+
export const weatherTool = createTool({
|
|
41
|
+
id: 'get-weather',
|
|
42
|
+
description: 'Get current weather for a location',
|
|
43
|
+
inputSchema: z.object({
|
|
44
|
+
location: z.string().describe('City name'),
|
|
45
|
+
}),
|
|
46
|
+
outputSchema: z.object({
|
|
47
|
+
output: z.string(),
|
|
48
|
+
}),
|
|
49
|
+
execute: async ({ location }) => {
|
|
50
|
+
return {
|
|
51
|
+
output: `The weather in ${location} is sunny`,
|
|
52
|
+
}
|
|
53
|
+
},
|
|
54
|
+
})
|
|
55
|
+
```
|
|
56
|
+
|
|
57
|
+
If you need to create an agent, create a new file and use `import { Agent } from "@mastra/core/agent"`. Constructor takes `{ id, name, instructions, model: 'openai/gpt-5.5' }`. The model string is Mastra's model router format ('provider/model'; use / and not : to separate provider and model). It's a bundled model gateway. Do not install any ai-sdk package unless Mastra's documentation says otherwise.
|
|
58
|
+
|
|
59
|
+
Add a tool an agent by importing the tool and passing it to the agent constructor as a tools object.
|
|
60
|
+
|
|
61
|
+
Example:
|
|
62
|
+
|
|
63
|
+
```ts
|
|
64
|
+
// src/mastra/agents/weather-agent.ts
|
|
65
|
+
import { Agent } from '@mastra/core/agent'
|
|
66
|
+
import { weatherTool } from '../tools/weather-tool.ts'
|
|
67
|
+
|
|
68
|
+
export const weatherAgent = new Agent({
|
|
69
|
+
id: 'weather-agent',
|
|
70
|
+
name: 'Weather Agent',
|
|
71
|
+
instructions: `
|
|
72
|
+
You are a helpful weather assistant that provides accurate weather information.
|
|
73
|
+
|
|
74
|
+
Your primary function is to help users get weather details for specific locations. When responding:
|
|
75
|
+
- Include relevant details like humidity, wind conditions, and precipitation
|
|
76
|
+
- Keep responses concise but informative
|
|
77
|
+
|
|
78
|
+
Use the weatherTool to fetch current weather data.
|
|
79
|
+
`,
|
|
80
|
+
model: 'openai/gpt-5.5',
|
|
81
|
+
tools: { weatherTool },
|
|
82
|
+
})
|
|
83
|
+
```
|
|
84
|
+
|
|
85
|
+
By defining the model using `provider/model` format Mastra automatically looks for environment variables for the given provider. The defined model requires an environment variable to be set for the provider. OpenAI: `OPENAI_API_KEY`. Anthropic: `ANTHROPIC_API_KEY`. Google: `GOOGLE_API_KEY`. Example: Any `openai/<model>` requires the `OPENAI_API_KEY` environment variable. Go to <https://mastra.ai/models/environment-variables> for a full list of supported providers and their environment variable names.
|
|
86
|
+
|
|
87
|
+
Short list of known model IDs are:
|
|
88
|
+
|
|
89
|
+
- `openai/gpt-5.5`, `openai/gpt-5-mini`
|
|
90
|
+
- `anthropic/claude-sonnet-4-6`, `anthropic/claude-opus-4-7`, `anthropic/claude-haiku-4-5`
|
|
91
|
+
- `google/gemini-2.5-flash`
|
|
92
|
+
|
|
93
|
+
Go to <https://mastra.ai/models> for a full list of supported models.
|
|
94
|
+
|
|
95
|
+
Create a Mastra entry point at `src/mastra/index.ts` and register the agent:
|
|
96
|
+
|
|
97
|
+
```ts
|
|
98
|
+
import { Mastra } from '@mastra/core'
|
|
99
|
+
import { weatherAgent } from './agents/weather-agent.ts'
|
|
100
|
+
|
|
101
|
+
export const mastra = new Mastra({
|
|
102
|
+
agents: { weatherAgent },
|
|
103
|
+
})
|
|
104
|
+
```
|
|
105
|
+
|
|
106
|
+
You're now able to run the agent directly. For this, import the Mastra instance and call the agent.generate() after retrieving the agent by its id. Node.js 22.18.0 and later are able to run TypeScript files directly. Make sure to add file extensions when importing local files. Example:
|
|
107
|
+
|
|
108
|
+
```ts
|
|
109
|
+
// run.mjs
|
|
110
|
+
import { mastra } from './src/mastra/index.ts'
|
|
111
|
+
|
|
112
|
+
const agent = mastra.getAgentById('weather-agent')
|
|
113
|
+
const response = await agent.generate('Weather in SF')
|
|
114
|
+
console.log(response.text)
|
|
115
|
+
```
|
|
116
|
+
|
|
5
117
|
## Quickstart
|
|
6
118
|
|
|
7
119
|
Run this command to create a new project:
|
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
|
|
2
|
+
|
|
1
3
|
# Hosted databases
|
|
2
4
|
|
|
3
5
|
From your [platform](https://mastra.ai/docs/mastra-platform/overview) project settings, provision a fully managed database and attach it to your project. Mastra creates it with your provider, stores credentials securely, and injects connection details as runtime environment variables when the database is ready, so there are no connection strings to copy or configure.
|
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
|
|
2
|
+
|
|
1
3
|
# GitHub integration on Mastra platform
|
|
2
4
|
|
|
3
5
|
The GitHub integration links a Mastra platform project to a GitHub repository. When you push changes to your repository Studio and Server will automatically be deployed.
|
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
|
|
2
|
+
|
|
1
3
|
# Observability on Mastra platform
|
|
2
4
|
|
|
3
5
|
Observability on Mastra platform is a standalone hosted product for searchable traces, logs, and metrics across Mastra projects and deploys. Use it when you want observability without deploying Studio first or setting up local storage.
|
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
|
|
2
|
+
|
|
1
3
|
# Mastra platform
|
|
2
4
|
|
|
3
5
|
The [Mastra platform](https://projects.mastra.ai) provides three products for deploying, monitoring, and managing AI applications built with the Mastra framework:
|
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
|
|
2
|
+
|
|
1
3
|
# Server on Mastra platform
|
|
2
4
|
|
|
3
5
|
Server on Mastra platform is a production deployment target that runs your Mastra application as an API server. Use it when you want the platform to build, deploy, host, and manage your Mastra server.
|
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
|
|
2
|
+
|
|
1
3
|
# Studio on Mastra platform
|
|
2
4
|
|
|
3
5
|
Studio on Mastra platform is a hosted visual environment for testing agents, running workflows, and inspecting traces. Use it when you want to share Studio with your team without hosting the Studio UI yourself.
|
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
|
|
2
|
+
|
|
1
3
|
# MCP Apps
|
|
2
4
|
|
|
3
5
|
The [MCP Apps extension](https://github.com/modelcontextprotocol/ext-apps) allows MCP tools to serve interactive HTML UIs via `ui://` resources. When a tool has an associated app resource, Mastra Studio renders it in a sandboxed iframe alongside the tool form or inline in agent chat.
|
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
|
|
2
|
+
|
|
1
3
|
# MCP overview
|
|
2
4
|
|
|
3
5
|
Mastra supports the [Model Context Protocol (MCP)](https://modelcontextprotocol.io/introduction), an open standard for connecting AI agents to external tools and resources. It serves as a universal plugin system, enabling agents to call tools regardless of language or hosting environment.
|
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
|
|
2
|
+
|
|
1
3
|
# Memory processors
|
|
2
4
|
|
|
3
5
|
Memory processors transform and filter messages as they pass through an agent with memory enabled. They manage context window limits, remove unnecessary content, and optimize the information sent to the language model.
|
|
@@ -248,6 +250,7 @@ const contentBlocker = {
|
|
|
248
250
|
}
|
|
249
251
|
|
|
250
252
|
const agent = new Agent({
|
|
253
|
+
id: 'safe-agent',
|
|
251
254
|
name: 'safe-agent',
|
|
252
255
|
instructions: 'You are a helpful assistant',
|
|
253
256
|
model: 'openai/gpt-5.5',
|
|
@@ -287,6 +290,7 @@ const inputValidator = {
|
|
|
287
290
|
}
|
|
288
291
|
|
|
289
292
|
const agent = new Agent({
|
|
293
|
+
id: 'validated-agent',
|
|
290
294
|
name: 'validated-agent',
|
|
291
295
|
instructions: 'You are a helpful assistant',
|
|
292
296
|
model: 'openai/gpt-5.5',
|
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
|
|
2
|
+
|
|
1
3
|
# Message history
|
|
2
4
|
|
|
3
5
|
Message history is the most basic and important form of memory. It gives the LLM a view of recent messages in the context window, enabling your agent to reference earlier exchanges and respond coherently.
|
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
|
|
2
|
+
|
|
1
3
|
# Multi-user threads
|
|
2
4
|
|
|
3
5
|
A single Mastra thread can be shared by multiple users, each with their own name and functional role. You carry speaker identity in the message body so the agent can tell users apart while reading from a single shared thread.
|
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
|
|
2
|
+
|
|
1
3
|
# Observational Memory
|
|
2
4
|
|
|
3
5
|
**Added in:** `@mastra/memory@1.1.0`
|
|
@@ -13,6 +15,7 @@ import { Memory } from '@mastra/memory'
|
|
|
13
15
|
import { Agent } from '@mastra/core/agent'
|
|
14
16
|
|
|
15
17
|
export const agent = new Agent({
|
|
18
|
+
id: 'my-agent',
|
|
16
19
|
name: 'my-agent',
|
|
17
20
|
instructions: 'You are a helpful assistant.',
|
|
18
21
|
model: 'openai/gpt-5-mini',
|
|
@@ -57,6 +60,7 @@ import { Memory } from '@mastra/memory'
|
|
|
57
60
|
import { Agent } from '@mastra/core/agent'
|
|
58
61
|
|
|
59
62
|
export const agent = new Agent({
|
|
63
|
+
id: 'my-agent',
|
|
60
64
|
name: 'my-agent',
|
|
61
65
|
instructions: 'You are a helpful assistant.',
|
|
62
66
|
model: 'openai/gpt-5-mini',
|
|
@@ -196,6 +200,7 @@ const memory = new Memory({
|
|
|
196
200
|
})
|
|
197
201
|
|
|
198
202
|
export const agent = new Agent({
|
|
203
|
+
id: 'assistant',
|
|
199
204
|
name: 'assistant',
|
|
200
205
|
instructions: 'You are a helpful assistant.',
|
|
201
206
|
model: 'openai/gpt-5-mini',
|
|
@@ -281,6 +286,7 @@ If your Observer model is text-only or its API rejects multimodal input, set `ob
|
|
|
281
286
|
|
|
282
287
|
```typescript
|
|
283
288
|
new Agent({
|
|
289
|
+
id: 'assistant',
|
|
284
290
|
name: 'assistant',
|
|
285
291
|
instructions: 'You are a helpful assistant.',
|
|
286
292
|
model: 'openai/gpt-5-mini',
|
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
|
|
2
|
+
|
|
1
3
|
# Memory
|
|
2
4
|
|
|
3
5
|
Memory enables your agent to remember user messages, agent replies, and tool results across interactions, giving it the context it needs to stay consistent, maintain conversation flow, and produce better answers over time.
|
|
@@ -174,7 +176,9 @@ Each delegation creates a fresh `threadId` and a deterministic `resourceId` for
|
|
|
174
176
|
|
|
175
177
|
- **Thread ID**: Unique per delegation. The subagent starts with a clean message history every time it's called.
|
|
176
178
|
- **Resource ID**: Derived as `{parentResourceId}-{agentName}`. Because the resource ID is stable across delegations, resource-scoped memory persists between calls. A subagent remembers facts from previous delegations by the same user.
|
|
177
|
-
- **Memory instance**: If a subagent has no memory configured, it inherits the supervisor's `Memory` instance. If the subagent defines its own, that takes precedence.
|
|
179
|
+
- **Memory instance**: If a subagent has no memory configured, it inherits the supervisor's `Memory` instance, including all of its options. If the subagent defines its own, that takes precedence.
|
|
180
|
+
|
|
181
|
+
> **Note:** Title generation (`generateTitle`) is a top-level thread concern and is **not** applied to inherited subagent threads. Because each delegation creates an ephemeral thread that no one sees, running title generation for it would waste an LLM call per delegation. To generate titles for a subagent's own threads, give that subagent its own memory configuration.
|
|
178
182
|
|
|
179
183
|
The supervisor forwards its conversation context to the subagent so it has enough background to complete the task. Only the delegation prompt and the subagent's response are saved — the full parent conversation isn't stored. You can control which messages reach the subagent with the [`messageFilter`](https://mastra.ai/docs/agents/supervisor-agents) callback.
|
|
180
184
|
|