@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
|
# Requesty
|
|
2
4
|
|
|
3
5
|
Access 38 Requesty models through Mastra's model router. Authentication is handled automatically using the `REQUESTY_API_KEY` environment variable.
|
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
|
|
2
|
+
|
|
1
3
|
# routing.run
|
|
2
4
|
|
|
3
5
|
Access 26 routing.run models through Mastra's model router. Authentication is handled automatically using the `ROUTING_RUN_API_KEY` environment variable.
|
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
|
|
2
|
+
|
|
1
3
|
# Sakana AI
|
|
2
4
|
|
|
3
5
|
Access 3 Sakana AI models through Mastra's model router. Authentication is handled automatically using the `SAKANA_API_KEY` environment variable.
|
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
|
|
2
|
+
|
|
1
3
|
# Sarvam AI
|
|
2
4
|
|
|
3
5
|
Access 2 Sarvam AI models through Mastra's model router. Authentication is handled automatically using the `SARVAM_API_KEY` environment variable.
|
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
|
|
2
|
+
|
|
1
3
|
# Scaleway
|
|
2
4
|
|
|
3
5
|
Access 16 Scaleway models through Mastra's model router. Authentication is handled automatically using the `SCALEWAY_API_KEY` environment variable.
|
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
|
|
2
|
+
|
|
1
3
|
# SiliconFlow (China)
|
|
2
4
|
|
|
3
5
|
Access 47 SiliconFlow (China) models through Mastra's model router. Authentication is handled automatically using the `SILICONFLOW_CN_API_KEY` environment variable.
|
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
|
|
2
|
+
|
|
1
3
|
# SiliconFlow
|
|
2
4
|
|
|
3
5
|
Access 49 SiliconFlow models through Mastra's model router. Authentication is handled automatically using the `SILICONFLOW_API_KEY` environment variable.
|
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
|
|
2
|
+
|
|
1
3
|
# Snowflake Cortex
|
|
2
4
|
|
|
3
5
|
Access 18 Snowflake Cortex models through Mastra's model router. Authentication is handled automatically using the `SNOWFLAKE_CORTEX_PAT` environment variable. Configure `SNOWFLAKE_ACCOUNT` as well.
|
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
|
|
2
|
+
|
|
1
3
|
# STACKIT
|
|
2
4
|
|
|
3
5
|
Access 8 STACKIT models through Mastra's model router. Authentication is handled automatically using the `STACKIT_API_KEY` environment variable.
|
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
|
|
2
|
+
|
|
1
3
|
# StepFun AI
|
|
2
4
|
|
|
3
5
|
Access 2 StepFun AI models through Mastra's model router. Authentication is handled automatically using the `STEPFUN_API_KEY` environment variable.
|
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
|
|
2
|
+
|
|
1
3
|
# StepFun
|
|
2
4
|
|
|
3
5
|
Access 5 StepFun models through Mastra's model router. Authentication is handled automatically using the `STEPFUN_API_KEY` environment variable.
|
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
|
|
2
|
+
|
|
1
3
|
# Subconscious
|
|
2
4
|
|
|
3
5
|
Access 1 Subconscious model through Mastra's model router. Authentication is handled automatically using the `SUBCONSCIOUS_API_KEY` environment variable.
|
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
|
|
2
|
+
|
|
1
3
|
# submodel
|
|
2
4
|
|
|
3
5
|
Access 9 submodel models through Mastra's model router. Authentication is handled automatically using the `SUBMODEL_INSTAGEN_ACCESS_KEY` environment variable.
|
|
@@ -1,6 +1,8 @@
|
|
|
1
|
+
> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
|
|
2
|
+
|
|
1
3
|
# Synthetic
|
|
2
4
|
|
|
3
|
-
Access
|
|
5
|
+
Access 7 Synthetic models through Mastra's model router. Authentication is handled automatically using the `SYNTHETIC_API_KEY` environment variable.
|
|
4
6
|
|
|
5
7
|
Learn more in the [Synthetic documentation](https://synthetic.new/pricing).
|
|
6
8
|
|
|
@@ -35,14 +37,11 @@ for await (const chunk of stream) {
|
|
|
35
37
|
| Model | Context | Tools | Reasoning | Image | Audio | Video | Input $/1M | Output $/1M |
|
|
36
38
|
| ------------------------------------------------------------- | ------- | ----- | --------- | ----- | ----- | ----- | ---------- | ----------- |
|
|
37
39
|
| `synthetic/hf:MiniMaxAI/MiniMax-M3` | 524K | | | | | | $0.60 | $1 |
|
|
38
|
-
| `synthetic/hf:moonshotai/Kimi-K2.
|
|
40
|
+
| `synthetic/hf:moonshotai/Kimi-K2.7-Code` | 262K | | | | | | $0.95 | $4 |
|
|
39
41
|
| `synthetic/hf:nvidia/NVIDIA-Nemotron-3-Super-120B-A12B-NVFP4` | 262K | | | | | | $0.30 | $1 |
|
|
40
42
|
| `synthetic/hf:openai/gpt-oss-120b` | 131K | | | | | | $0.10 | $0.10 |
|
|
41
|
-
| `synthetic/hf:Qwen/Qwen3.5-397B-A17B` | 262K | | | | | | $0.60 | $4 |
|
|
42
43
|
| `synthetic/hf:Qwen/Qwen3.6-27B` | 262K | | | | | | $0.45 | $4 |
|
|
43
|
-
| `synthetic/hf:zai-org/GLM-4.7` | 203K | | | | | | $0.45 | $2 |
|
|
44
44
|
| `synthetic/hf:zai-org/GLM-4.7-Flash` | 197K | | | | | | $0.10 | $0.50 |
|
|
45
|
-
| `synthetic/hf:zai-org/GLM-5.1` | 197K | | | | | | $1 | $3 |
|
|
46
45
|
| `synthetic/hf:zai-org/GLM-5.2` | 524K | | | | | | $1 | $4 |
|
|
47
46
|
|
|
48
47
|
## Advanced configuration
|
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
|
|
2
|
+
|
|
1
3
|
# Tencent Coding Plan (China)
|
|
2
4
|
|
|
3
5
|
Access 8 Tencent Coding Plan (China) models through Mastra's model router. Authentication is handled automatically using the `TENCENT_CODING_PLAN_API_KEY` environment variable.
|
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
|
|
2
|
+
|
|
1
3
|
# Tencent Token Plan
|
|
2
4
|
|
|
3
5
|
Access 1 Tencent Token Plan model through Mastra's model router. Authentication is handled automatically using the `TENCENT_TOKEN_PLAN_API_KEY` environment variable.
|
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
|
|
2
|
+
|
|
1
3
|
# Tencent TokenHub
|
|
2
4
|
|
|
3
5
|
Access 1 Tencent TokenHub model through Mastra's model router. Authentication is handled automatically using the `TENCENT_TOKENHUB_API_KEY` environment variable.
|
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
|
|
2
|
+
|
|
1
3
|
# The Grid AI
|
|
2
4
|
|
|
3
5
|
Access 9 The Grid AI models through Mastra's model router. Authentication is handled automatically using the `THEGRIDAI_API_KEY` environment variable.
|
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
|
|
2
|
+
|
|
1
3
|
# Tinfoil
|
|
2
4
|
|
|
3
5
|
Access 7 Tinfoil models through Mastra's model router. Authentication is handled automatically using the `TINFOIL_API_KEY` environment variable.
|
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
|
|
2
|
+
|
|
1
3
|
# Together AI
|
|
2
4
|
|
|
3
5
|
Access 25 Together AI models through Mastra's model router. Authentication is handled automatically using the `TOGETHER_API_KEY` environment variable.
|
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
|
|
2
|
+
|
|
1
3
|
# Umans AI Coding Plan
|
|
2
4
|
|
|
3
5
|
Access 6 Umans AI Coding Plan models through Mastra's model router. Authentication is handled automatically using the `UMANS_AI_CODING_PLAN_API_KEY` environment variable.
|
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
|
|
2
|
+
|
|
1
3
|
# Umans AI
|
|
2
4
|
|
|
3
5
|
Access 5 Umans AI models through Mastra's model router. Authentication is handled automatically using the `UMANS_AI_API_KEY` environment variable.
|
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
|
|
2
|
+
|
|
1
3
|
# Upstage
|
|
2
4
|
|
|
3
5
|
Access 3 Upstage models through Mastra's model router. Authentication is handled automatically using the `UPSTAGE_API_KEY` environment variable.
|
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
|
|
2
|
+
|
|
1
3
|
# Venice AI
|
|
2
4
|
|
|
3
5
|
Access 25 Venice AI models through Mastra's model router. Authentication is handled automatically using the `VENICE_API_KEY` environment variable.
|
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
|
|
2
|
+
|
|
1
3
|
# Vivgrid
|
|
2
4
|
|
|
3
5
|
Access 13 Vivgrid models through Mastra's model router. Authentication is handled automatically using the `VIVGRID_API_KEY` environment variable.
|
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
|
|
2
|
+
|
|
1
3
|
# Vultr
|
|
2
4
|
|
|
3
5
|
Access 7 Vultr models through Mastra's model router. Authentication is handled automatically using the `VULTR_API_KEY` environment variable.
|
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
|
|
2
|
+
|
|
1
3
|
# Wafer
|
|
2
4
|
|
|
3
5
|
Access 8 Wafer models through Mastra's model router. Authentication is handled automatically using the `WAFER_API_KEY` environment variable.
|
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
|
|
2
|
+
|
|
1
3
|
# Weights & Biases
|
|
2
4
|
|
|
3
5
|
Access 18 Weights & Biases models through Mastra's model router. Authentication is handled automatically using the `WANDB_API_KEY` environment variable.
|
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
|
|
2
|
+
|
|
1
3
|
# xAI
|
|
2
4
|
|
|
3
5
|
Access 8 xAI models through Mastra's model router. Authentication is handled automatically using the `XAI_API_KEY` environment variable.
|
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
|
|
2
|
+
|
|
1
3
|
# Xiaomi Token Plan (Europe)
|
|
2
4
|
|
|
3
5
|
Access 6 Xiaomi Token Plan (Europe) models through Mastra's model router. Authentication is handled automatically using the `XIAOMI_API_KEY` environment variable.
|
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
|
|
2
|
+
|
|
1
3
|
# Xiaomi Token Plan (China)
|
|
2
4
|
|
|
3
5
|
Access 6 Xiaomi Token Plan (China) models through Mastra's model router. Authentication is handled automatically using the `XIAOMI_API_KEY` environment variable.
|
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
|
|
2
|
+
|
|
1
3
|
# Xiaomi Token Plan (Singapore)
|
|
2
4
|
|
|
3
5
|
Access 6 Xiaomi Token Plan (Singapore) models through Mastra's model router. Authentication is handled automatically using the `XIAOMI_API_KEY` environment variable.
|
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
|
|
2
|
+
|
|
1
3
|
# Xiaomi
|
|
2
4
|
|
|
3
5
|
Access 3 Xiaomi models through Mastra's model router. Authentication is handled automatically using the `XIAOMI_API_KEY` environment variable.
|
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
|
|
2
|
+
|
|
1
3
|
# Xpersona
|
|
2
4
|
|
|
3
5
|
Access 2 Xpersona models through Mastra's model router. Authentication is handled automatically using the `XPERSONA_API_KEY` environment variable.
|
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
|
|
2
|
+
|
|
1
3
|
# Z.AI Coding Plan
|
|
2
4
|
|
|
3
5
|
Access 6 Z.AI Coding Plan models through Mastra's model router. Authentication is handled automatically using the `ZHIPU_API_KEY` environment variable.
|
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
|
|
2
|
+
|
|
1
3
|
# Z.AI
|
|
2
4
|
|
|
3
5
|
Access 14 Z.AI models through Mastra's model router. Authentication is handled automatically using the `ZHIPU_API_KEY` environment variable.
|
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
|
|
2
|
+
|
|
1
3
|
# Zeldoc
|
|
2
4
|
|
|
3
5
|
Access 1 Zeldoc model through Mastra's model router. Authentication is handled automatically using the `ZELDOC_API_KEY` environment variable.
|
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
|
|
2
|
+
|
|
1
3
|
# ZenMux
|
|
2
4
|
|
|
3
5
|
Access 112 ZenMux models through Mastra's model router. Authentication is handled automatically using the `ZENMUX_API_KEY` environment variable.
|
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
|
|
2
|
+
|
|
1
3
|
# Zhipu AI Coding Plan
|
|
2
4
|
|
|
3
5
|
Access 7 Zhipu AI Coding Plan models through Mastra's model router. Authentication is handled automatically using the `ZHIPU_API_KEY` environment variable.
|
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
|
|
2
|
+
|
|
1
3
|
# Zhipu AI
|
|
2
4
|
|
|
3
5
|
Access 13 Zhipu AI models through Mastra's model router. Authentication is handled automatically using the `ZHIPU_API_KEY` environment variable.
|
|
@@ -44,7 +46,7 @@ for await (const chunk of stream) {
|
|
|
44
46
|
| `zhipuai/glm-4.7-flash` | 200K | | | | | | — | — |
|
|
45
47
|
| `zhipuai/glm-4.7-flashx` | 200K | | | | | | $0.07 | $0.40 |
|
|
46
48
|
| `zhipuai/glm-5` | 205K | | | | | | $1 | $3 |
|
|
47
|
-
| `zhipuai/glm-5.1` | 200K | | | | | | $
|
|
49
|
+
| `zhipuai/glm-5.1` | 200K | | | | | | $1 | $4 |
|
|
48
50
|
| `zhipuai/glm-5.2` | 1.0M | | | | | | $1 | $4 |
|
|
49
51
|
| `zhipuai/glm-5v-turbo` | 200K | | | | | | $5 | $22 |
|
|
50
52
|
|
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
|
|
2
|
+
|
|
1
3
|
# AcpAgent class
|
|
2
4
|
|
|
3
5
|
The `AcpAgent` class wraps an Agent Client Protocol (ACP)-compatible coding agent as a Mastra subagent. Use it when a parent Mastra agent should delegate repository inspection, code edits, or other ACP-backed tasks to a named subagent.
|
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
|
|
2
|
+
|
|
1
3
|
# createACPTool()
|
|
2
4
|
|
|
3
5
|
The `createACPTool()` function creates a Mastra tool that sends a `task` string to an Agent Client Protocol (ACP)-compatible coding agent and returns the final ACP response as `output`. Use it when a parent agent should decide when to call the ACP agent as a tool.
|
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
|
|
2
|
+
|
|
1
3
|
# Agent class
|
|
2
4
|
|
|
3
5
|
The `Agent` class is the foundation for creating AI agents in Mastra. It provides methods for generating responses, streaming interactions, and handling voice capabilities.
|
|
@@ -215,7 +217,7 @@ agent.sendMessage('Continue with the next step.', {
|
|
|
215
217
|
})
|
|
216
218
|
```
|
|
217
219
|
|
|
218
|
-
Returns `{ accepted: Promise<SendAgentSignalAccepted>, signal: CreatedAgentSignal, persisted?: Promise<void> }`. `accepted` resolves at decision-time, once Mastra decides what to do with the message: `{ action: 'wake', runId, output }` when this process runs the agent (it started or won the lease to start the run), `{ action: 'deliver', runId }` when the message is forwarded onto an existing run (including when this process loses a cross-process wake race), or `{ action: 'persist' }` / `{ action: 'discard' }` when nothing ran. `runId` is the authoritative id of the run that handled the message and is present only on `wake` and `deliver`; for `persist`/`discard` use `result.signal.id` to correlate the stored message. `accepted` resolves for routing — a generation error on a `wake` run surfaces through `output.consumeStream()` — and rejects only when the message
|
|
220
|
+
Returns `{ accepted: Promise<SendAgentSignalAccepted>, signal: CreatedAgentSignal, persisted?: Promise<void> }`. `accepted` resolves at decision-time, once Mastra decides what to do with the message: `{ action: 'wake', runId, output }` when this process runs the agent (it started or won the lease to start the run), `{ action: 'deliver', runId }` when the message is forwarded onto an existing run (including when this process loses a cross-process wake race), or `{ action: 'persist' }` / `{ action: 'discard' }` when nothing ran. `runId` is the authoritative id of the run that handled the message and is present only on `wake` and `deliver`; for `persist`/`discard` use `result.signal.id` to correlate the stored message. `accepted` resolves for routing — a generation error on a `wake` run surfaces through `output.consumeStream()` — and rejects only when the message couldn't be routed or started at all (e.g. a misconfigured agent). `persisted` is only present for `persist` behavior and resolves when Mastra finishes writing the message to memory. On the `wake` action, `output` is the agent stream for in-process consumption.
|
|
219
221
|
|
|
220
222
|
### `queueMessage(message, options)`
|
|
221
223
|
|
|
@@ -258,7 +260,7 @@ Sends a signal to an active run or memory thread.
|
|
|
258
260
|
|
|
259
261
|
**options.ifIdle.attributes** (`Record<string, string | number | boolean>`): Attributes merged into the signal when Mastra accepts it while the target thread is idle.
|
|
260
262
|
|
|
261
|
-
Returns `{ accepted: Promise<SendAgentSignalAccepted>, signal: CreatedAgentSignal, persisted?: Promise<void> }`. `accepted` resolves at decision-time, once Mastra decides what to do with the signal: `{ action: 'wake', runId, output }` when this process runs the agent (it started or won the lease to start the run), `{ action: 'deliver', runId }` when the signal is forwarded onto an existing run (including when this process loses a cross-process wake race), or `{ action: 'persist' }` / `{ action: 'discard' }` when nothing ran. `action` mirrors the winning `behavior` from `ifActive`/`ifIdle`. `runId` is the authoritative id of the run that handled the signal and is present only on `wake` and `deliver`; for `persist`/`discard` use `result.signal.id` to correlate the stored signal. `accepted` resolves for routing — a generation error on a `wake` run surfaces through `output.consumeStream()` — and rejects only when the signal
|
|
263
|
+
Returns `{ accepted: Promise<SendAgentSignalAccepted>, signal: CreatedAgentSignal, persisted?: Promise<void> }`. `accepted` resolves at decision-time, once Mastra decides what to do with the signal: `{ action: 'wake', runId, output }` when this process runs the agent (it started or won the lease to start the run), `{ action: 'deliver', runId }` when the signal is forwarded onto an existing run (including when this process loses a cross-process wake race), or `{ action: 'persist' }` / `{ action: 'discard' }` when nothing ran. `action` mirrors the winning `behavior` from `ifActive`/`ifIdle`. `runId` is the authoritative id of the run that handled the signal and is present only on `wake` and `deliver`; for `persist`/`discard` use `result.signal.id` to correlate the stored signal. `accepted` resolves for routing — a generation error on a `wake` run surfaces through `output.consumeStream()` — and rejects only when the signal couldn't be routed or started at all (e.g. a misconfigured agent). `persisted` is only present for `persist` behavior and resolves when Mastra finishes writing the signal to memory. On the `wake` action, `output` is the agent stream for in-process consumption.
|
|
262
264
|
|
|
263
265
|
In serverless handlers, await `accepted` and pass the `wake` output to your platform's `waitUntil` equivalent so the winning process can drain the stream after the HTTP response returns.
|
|
264
266
|
|
|
@@ -423,9 +425,9 @@ Returns an `AgentThreadSubscription` object with these members:
|
|
|
423
425
|
|
|
424
426
|
## Constructor parameters
|
|
425
427
|
|
|
426
|
-
**id** (`string`): Unique identifier for the agent.
|
|
428
|
+
**id** (`string`): Unique identifier for the agent.
|
|
427
429
|
|
|
428
|
-
**name** (`string`): Display name for the agent.
|
|
430
|
+
**name** (`string`): Display name for the agent.
|
|
429
431
|
|
|
430
432
|
**description** (`string`): Optional description of the agent's purpose and capabilities.
|
|
431
433
|
|
|
@@ -477,6 +479,34 @@ Returns an `AgentThreadSubscription` object with these members:
|
|
|
477
479
|
|
|
478
480
|
**editor** (`false | { instructions?: boolean; tools?: boolean | { description?: boolean } }`): Controls which fields the editor can override for this code-defined agent. Omit to allow editing instructions and tools. See Editor overrides below.
|
|
479
481
|
|
|
482
|
+
## `generate()` memory options
|
|
483
|
+
|
|
484
|
+
Pass `memory` when you call `agent.generate()` to choose which conversation thread the run should read from and write to. The common shape is `memory: { resource: string, thread: string }`, where `resource` identifies the owner and `thread` identifies the conversation. See [Threads and resources](https://mastra.ai/docs/memory/storage) for the concept model.
|
|
485
|
+
|
|
486
|
+
```typescript
|
|
487
|
+
const response = await agent.generate('What did we decide about retries?', {
|
|
488
|
+
memory: {
|
|
489
|
+
resource: 'user-123',
|
|
490
|
+
thread: 'support-thread-456',
|
|
491
|
+
},
|
|
492
|
+
})
|
|
493
|
+
```
|
|
494
|
+
|
|
495
|
+
Use a thread object when you need to create or update thread metadata during the call:
|
|
496
|
+
|
|
497
|
+
```typescript
|
|
498
|
+
const response = await agent.generate('Continue the support conversation.', {
|
|
499
|
+
memory: {
|
|
500
|
+
resource: 'user-123',
|
|
501
|
+
thread: {
|
|
502
|
+
id: 'support-thread-456',
|
|
503
|
+
title: 'Billing support',
|
|
504
|
+
metadata: { category: 'billing' },
|
|
505
|
+
},
|
|
506
|
+
},
|
|
507
|
+
})
|
|
508
|
+
```
|
|
509
|
+
|
|
480
510
|
## Tool hooks
|
|
481
511
|
|
|
482
512
|
Use `hooks` to run logic around every tool call the agent makes, including assigned tools, memory tools, toolsets, client tools, and workspace tools.
|
|
@@ -485,6 +515,7 @@ Use `hooks` to run logic around every tool call the agent makes, including assig
|
|
|
485
515
|
import { Agent } from '@mastra/core/agent'
|
|
486
516
|
|
|
487
517
|
export const agent = new Agent({
|
|
518
|
+
id: 'support-agent',
|
|
488
519
|
name: 'support-agent',
|
|
489
520
|
instructions: 'Help users with their questions.',
|
|
490
521
|
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
|
# Channels
|
|
2
4
|
|
|
3
5
|
**Added in:** `@mastra/core@1.22.0`
|
|
@@ -63,6 +65,7 @@ import { createDiscordAdapter } from '@chat-adapter/discord'
|
|
|
63
65
|
import { createSlackAdapter } from '@chat-adapter/slack'
|
|
64
66
|
|
|
65
67
|
const agent = new Agent({
|
|
68
|
+
id: 'example',
|
|
66
69
|
name: 'Example',
|
|
67
70
|
instructions: '...',
|
|
68
71
|
model: 'openai/gpt-5.5',
|
|
@@ -118,6 +121,7 @@ import { Agent } from '@mastra/core/agent'
|
|
|
118
121
|
import { createSlackAdapter } from '@chat-adapter/slack'
|
|
119
122
|
|
|
120
123
|
const agent = new Agent({
|
|
124
|
+
id: 'streaming-agent',
|
|
121
125
|
name: 'Streaming Agent',
|
|
122
126
|
instructions: '...',
|
|
123
127
|
model: 'openai/gpt-5.5',
|
|
@@ -145,6 +149,7 @@ import { defaultTypingStatus } from '@mastra/core/channels'
|
|
|
145
149
|
import { createDiscordAdapter } from '@chat-adapter/discord'
|
|
146
150
|
|
|
147
151
|
const agent = new Agent({
|
|
152
|
+
id: 'custom-typing-agent',
|
|
148
153
|
name: 'Custom Typing Agent',
|
|
149
154
|
instructions: '...',
|
|
150
155
|
model: 'openai/gpt-5.5',
|
|
@@ -177,6 +182,7 @@ import { Agent } from '@mastra/core/agent'
|
|
|
177
182
|
import { createSlackAdapter } from '@chat-adapter/slack'
|
|
178
183
|
|
|
179
184
|
const agent = new Agent({
|
|
185
|
+
id: 'custom-handler-agent',
|
|
180
186
|
name: 'Custom Handler Agent',
|
|
181
187
|
instructions: '...',
|
|
182
188
|
model: 'openai/gpt-5.5',
|
|
@@ -222,6 +228,7 @@ import { Agent } from '@mastra/core/agent'
|
|
|
222
228
|
import { createSlackAdapter } from '@chat-adapter/slack'
|
|
223
229
|
|
|
224
230
|
const agent = new Agent({
|
|
231
|
+
id: 'sso-agent',
|
|
225
232
|
name: 'SSO Agent',
|
|
226
233
|
instructions: '...',
|
|
227
234
|
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
|
# DurableAgent
|
|
2
4
|
|
|
3
5
|
`DurableAgent` wraps an existing [`Agent`](https://mastra.ai/reference/agents/agent) with durable execution and resumable streams. It runs the agentic loop so that a client can disconnect and reconnect without missing events, and it streams those events over [PubSub](https://mastra.ai/docs/server/pubsub). Use it when a run must outlive a single request or survive a dropped connection.
|