@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
|
# OpenAI Responses API
|
|
2
4
|
|
|
3
5
|
This OpenAI-compatible, agent-backed interface lets you use Mastra Agents as a Responses API. It provides methods to create, retrieve, stream, and delete responses through Mastra agents.
|
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
|
|
2
|
+
|
|
1
3
|
# Telemetry API
|
|
2
4
|
|
|
3
5
|
The Telemetry API provides methods to retrieve and analyze traces from your Mastra application. This helps you monitor and debug your application's behavior and performance.
|
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
|
|
2
|
+
|
|
1
3
|
# buildBasePrompt()
|
|
2
4
|
|
|
3
5
|
`buildBasePrompt()` builds the shared base system prompt for a coding agent — the behavioral instructions that make the agent a good coding assistant. It takes a `PromptContext` describing the current environment (project, platform, git branch, mode, model) and returns the prompt as a string.
|
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
|
|
2
|
+
|
|
1
3
|
# createCodingAgent()
|
|
2
4
|
|
|
3
5
|
`createCodingAgent()` builds a coding [`Agent`](https://mastra.ai/reference/agents/agent) with portable defaults for the pieces a coding agent always needs: a local workspace, the task-list signal provider, network-retry error processors, and the goal judge prompt. Supply only `model`, `instructions`, and `tools` to get a working agent, or override any default.
|
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
|
|
2
|
+
|
|
1
3
|
# Configuration
|
|
2
4
|
|
|
3
5
|
The following reference covers all supported options in Mastra. You initialize and configure Mastra by instantiating the [`Mastra` class](https://mastra.ai/reference/core/mastra-class).
|
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
|
|
2
|
+
|
|
1
3
|
# Mastra.getEditor()
|
|
2
4
|
|
|
3
5
|
The `.getEditor()` method is used to retrieve the editor instance that has been configured on the Mastra instance. The editor exposes CRUD namespaces for managing stored agents, prompt blocks, MCP clients, scorers, skills, and workspaces programmatically.
|
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
|
|
2
|
+
|
|
1
3
|
# Mastra.getGatewayById()
|
|
2
4
|
|
|
3
5
|
Retrieves a gateway by its unique ID (the `id` property of the gateway instance). This is useful when you need to find a gateway by its intrinsic identifier rather than its registration key.
|
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
|
|
2
|
+
|
|
1
3
|
# Mastra.getMCPServer()
|
|
2
4
|
|
|
3
5
|
The `.getMCPServer()` method retrieves an MCP server instance by its registry key (the key used when registering the server in the `mcpServers` configuration). For retrieving by the server's intrinsic `id` property, use `.getMCPServerById()` instead.
|
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
|
|
2
|
+
|
|
1
3
|
# Mastra.getMCPServerById()
|
|
2
4
|
|
|
3
5
|
The `.getMCPServerById()` method retrieves an MCP server instance by its intrinsic `id` property. For retrieving by registry key (the key used in configuration), use `.getMCPServer()` instead.
|
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
|
|
2
|
+
|
|
1
3
|
# Mastra.getMemory()
|
|
2
4
|
|
|
3
5
|
The `.getMemory()` method retrieves a memory instance from the Mastra registry by its key. Memory instances are registered in the Mastra constructor and can be referenced by stored agents.
|
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
|
|
2
|
+
|
|
1
3
|
# getScorer()
|
|
2
4
|
|
|
3
5
|
The `getScorer()` method retrieves a specific scorer that was registered with the Mastra instance using its registration key. This method provides type-safe access to scorers and throws an error if the requested scorer isn't found.
|
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
|
|
2
|
+
|
|
1
3
|
# getScorerById()
|
|
2
4
|
|
|
3
5
|
The `getScorerById()` method retrieves a scorer by searching for its `id` property (or `name` property as a fallback) rather than the registration key. This is useful when you know the scorer's id but not necessarily how it was registered in the Mastra instance.
|
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
|
|
2
|
+
|
|
1
3
|
# Mastra.getWorkflow()
|
|
2
4
|
|
|
3
5
|
The `.getWorkflow()` method is used to retrieve a workflow by its registration key. This method provides full TypeScript type inference for workflow input and output schemas.
|
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
|
|
2
|
+
|
|
1
3
|
# Mastra.listLogs()
|
|
2
4
|
|
|
3
5
|
The `.listLogs()` method is used to retrieve all logs for a specific transport ID. This method requires a configured logger that supports the `listLogs` operation.
|
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
|
|
2
|
+
|
|
1
3
|
# Mastra.listLogsByRunId()
|
|
2
4
|
|
|
3
5
|
The `.listLogsByRunId()` method is used to retrieve logs for a specific run ID and transport ID. This method requires a configured logger that supports the `listLogsByRunId` operation.
|
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
|
|
2
|
+
|
|
1
3
|
# Mastra.listMCPServers()
|
|
2
4
|
|
|
3
5
|
The `.listMCPServers()` method is used to retrieve all MCP server instances that have been registered in the Mastra instance. The returned record uses registry keys (the keys from the `mcpServers` configuration) as keys.
|
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
|
|
2
|
+
|
|
1
3
|
# listScorers()
|
|
2
4
|
|
|
3
5
|
The `listScorers()` method returns all scorers that have been registered with the Mastra instance. Scorers are used for evaluating AI outputs and can override default scorers during agent generation or workflow execution.
|
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
|
|
2
|
+
|
|
1
3
|
# Mastra.listWorkflows()
|
|
2
4
|
|
|
3
5
|
The `.listWorkflows()` method is used to retrieve all workflows that have been configured in the Mastra instance. The method accepts an optional options object.
|
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
|
|
2
|
+
|
|
1
3
|
# Mastra class
|
|
2
4
|
|
|
3
5
|
The `Mastra` class is the central orchestrator in any Mastra application, managing agents, workflows, storage, logging, observability, and more. Typically, you create a single instance of `Mastra` to coordinate your application.
|
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
|
|
2
|
+
|
|
1
3
|
# MastraModelGateway
|
|
2
4
|
|
|
3
5
|
Abstract base class for implementing custom model gateways. Gateways handle provider-specific logic for accessing language models, including provider configuration, authentication, URL construction, and model instantiation.
|
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
|
|
2
|
+
|
|
1
3
|
# Mastra.removeWorkspace()
|
|
2
4
|
|
|
3
5
|
The `.removeWorkspace()` method removes a workspace from the Mastra runtime registry. Pass `{ destroy: true }` to destroy the workspace before it's removed.
|
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
|
|
2
|
+
|
|
1
3
|
# Mastra.setLogger()
|
|
2
4
|
|
|
3
5
|
The `.setLogger()` method is used to set the logger for all components (agents, workflows, etc.) in the Mastra instance. This method accepts a single object parameter with a logger property.
|
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
|
|
2
|
+
|
|
1
3
|
# CloudflareDeployer
|
|
2
4
|
|
|
3
5
|
The `CloudflareDeployer` bundles your Mastra server and generates a `wrangler.jsonc` file conforming to Cloudflare's [wrangler configuration](https://developers.cloudflare.com/workers/wrangler/configuration/). Cloudflare deploys this as a Cloudflare Worker.
|
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
|
|
2
|
+
|
|
1
3
|
# NetlifyDeployer
|
|
2
4
|
|
|
3
5
|
The `NetlifyDeployer` class handles packaging, configuration, and deployment by adapting Mastra's output to create an optimized version of your server. It extends the base [`Deployer`](https://mastra.ai/reference/deployer) class with Netlify-specific functionality. It enables you to run Mastra within Netlify serverless functions or edge functions.
|
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
|
|
2
|
+
|
|
1
3
|
# VercelDeployer
|
|
2
4
|
|
|
3
5
|
The `VercelDeployer` bundles your Mastra server and generates output conforming to Vercel's [Build Output API](https://vercel.com/docs/build-output-api/v3). Vercel deploys this output directly as serverless functions.
|
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
|
|
2
|
+
|
|
1
3
|
# Deployer
|
|
2
4
|
|
|
3
5
|
The Deployer handles the deployment of standalone Mastra applications by packaging code, managing environment files, and serving applications using the Hono framework. Concrete implementations must define the deploy method for specific deployment targets.
|
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
|
|
2
|
+
|
|
1
3
|
# AgentBuilderOptions
|
|
2
4
|
|
|
3
5
|
`AgentBuilderOptions` configures the Agent Builder. Pass it as `MastraEditor.builder` to enable the Builder UI, toggle visible surfaces, pin admin defaults, and opt into skill registries.
|
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
|
|
2
|
+
|
|
1
3
|
# BuilderAgentDefaults
|
|
2
4
|
|
|
3
5
|
`BuilderAgentDefaults` describes the admin-pinned defaults applied to every agent the Agent Builder produces. Pass it as `builder.configuration.agent`. End users can't override these values from the Builder UI.
|
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
|
|
2
|
+
|
|
1
3
|
# builder.configuration.agent.models
|
|
2
4
|
|
|
3
5
|
`builder.configuration.agent.models` is the admin-facing model policy input on `AgentBuilderOptions`. It controls which providers and models the Agent Builder exposes, and which model is pre-selected on new-agent create.
|
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
|
|
2
|
+
|
|
1
3
|
# BlobStoreProvider
|
|
2
4
|
|
|
3
5
|
`BlobStoreProvider` is the interface a package implements to register a blob store with [`MastraEditor`](https://mastra.ai/reference/editor/mastra-editor). Blob stores hold content-addressable skill blobs and other large artifacts produced by the editor.
|
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
|
|
2
|
+
|
|
1
3
|
# BrowserProvider
|
|
2
4
|
|
|
3
5
|
`BrowserProvider` is the interface a package implements to register a browser with [`MastraEditor`](https://mastra.ai/reference/editor/mastra-editor). The editor calls `createBrowser(config)` at agent hydration time, using the `provider` id from the stored [`StorageBrowserRef`](https://mastra.ai/reference/editor/storage-browser-ref) as the lookup key.
|
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
|
|
2
|
+
|
|
1
3
|
# FilesystemProvider
|
|
2
4
|
|
|
3
5
|
`FilesystemProvider` is the interface a package implements to register a filesystem with [`MastraEditor`](https://mastra.ai/reference/editor/mastra-editor). The editor calls `createFilesystem(config)` at workspace hydration time, using the `provider` id from the stored [`StorageWorkspaceRef`](https://mastra.ai/reference/editor/storage-workspace-ref) filesystem config as the lookup key.
|
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
|
|
2
|
+
|
|
1
3
|
# MastraEditor class
|
|
2
4
|
|
|
3
5
|
The `MastraEditor` class sets up the editor system. Pass it to the `Mastra` constructor to turn on editor features like prompt blocks, agent code override, versioning, and tool providers.
|
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
|
|
2
|
+
|
|
1
3
|
# ProcessorProvider
|
|
2
4
|
|
|
3
5
|
`ProcessorProvider` is the interface a package implements to register a configurable processor with [`MastraEditor`](https://mastra.ai/reference/editor/mastra-editor). Processor providers serve two purposes:
|
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
|
|
2
|
+
|
|
1
3
|
# SandboxProvider
|
|
2
4
|
|
|
3
5
|
`SandboxProvider` is the interface a package implements to register a sandbox with [`MastraEditor`](https://mastra.ai/reference/editor/mastra-editor). The editor calls `createSandbox(config)` at workspace hydration time, using the `provider` id from the stored [`StorageWorkspaceRef`](https://mastra.ai/reference/editor/storage-workspace-ref) sandbox config as the lookup key.
|
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
|
|
2
|
+
|
|
1
3
|
# StorageBrowserRef
|
|
2
4
|
|
|
3
5
|
`StorageBrowserRef` is the inline browser configuration attached to a stored agent. The `provider` id is resolved at hydration time against the [`BrowserProvider`](https://mastra.ai/reference/editor/browser-provider) registered on [`MastraEditor.browsers`](https://mastra.ai/reference/editor/mastra-editor).
|
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
|
|
2
|
+
|
|
1
3
|
# StorageWorkspaceRef
|
|
2
4
|
|
|
3
5
|
`StorageWorkspaceRef` is the discriminated union used to attach a workspace to a stored agent. It either points at a workspace registered on the Mastra runtime by ID, or embeds a workspace snapshot inline.
|
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
|
|
2
|
+
|
|
1
3
|
# ToolProvider
|
|
2
4
|
|
|
3
5
|
The `ToolProvider` interface defines how the editor discovers and resolves integration tools from external platforms. Mastra ships with two built-in implementations: `ComposioToolProvider` and `ArcadeToolProvider`.
|
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
|
|
2
|
+
|
|
1
3
|
# Answer similarity scorer
|
|
2
4
|
|
|
3
5
|
The `createAnswerSimilarityScorer()` function creates a scorer that evaluates how similar an agent's output is to a ground truth answer. This scorer is specifically designed for CI/CD testing scenarios where you have expected answers and want to ensure consistency over time.
|
|
@@ -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 zero-LLM, composable micro-scorers for common assertions. They plug into the existing `scorers: [...]` array anywhere scorers are used — in `runEvals`, live scoring, experiments, and Studio.
|