@mastra/mcp-docs-server 1.2.4-alpha.5 → 1.2.4-alpha.8

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.
Files changed (773) hide show
  1. package/.docs/docs/agent-builder/access-control.md +2 -0
  2. package/.docs/docs/agent-builder/browser.md +2 -0
  3. package/.docs/docs/agent-builder/channels.md +2 -0
  4. package/.docs/docs/agent-builder/configuration.md +2 -0
  5. package/.docs/docs/agent-builder/deploying.md +2 -0
  6. package/.docs/docs/agent-builder/integrations.md +2 -0
  7. package/.docs/docs/agent-builder/memory.md +2 -0
  8. package/.docs/docs/agent-builder/model-policy.md +2 -0
  9. package/.docs/docs/agent-builder/overview.md +2 -0
  10. package/.docs/docs/agent-builder/skill-registries.md +2 -0
  11. package/.docs/docs/agent-builder/workspace.md +2 -0
  12. package/.docs/docs/agent-controller/modes.md +2 -0
  13. package/.docs/docs/agent-controller/overview.md +2 -0
  14. package/.docs/docs/agent-controller/session.md +2 -0
  15. package/.docs/docs/agent-controller/subagents.md +2 -0
  16. package/.docs/docs/agent-controller/threads-and-state.md +2 -0
  17. package/.docs/docs/agent-controller/tool-approvals.md +2 -0
  18. package/.docs/docs/agents/a2a.md +2 -0
  19. package/.docs/docs/agents/acp.md +2 -0
  20. package/.docs/docs/agents/adding-voice.md +2 -0
  21. package/.docs/docs/agents/agent-approval.md +2 -0
  22. package/.docs/docs/agents/background-tasks.md +2 -0
  23. package/.docs/docs/agents/channels.md +2 -0
  24. package/.docs/docs/agents/code-mode.md +2 -0
  25. package/.docs/docs/agents/durable-agents.md +2 -0
  26. package/.docs/docs/agents/file-based-agents.md +12 -1
  27. package/.docs/docs/agents/goals.md +2 -0
  28. package/.docs/docs/agents/guardrails.md +2 -0
  29. package/.docs/docs/agents/heartbeats.md +2 -0
  30. package/.docs/docs/agents/networks.md +2 -0
  31. package/.docs/docs/agents/overview.md +14 -6
  32. package/.docs/docs/agents/processors.md +2 -0
  33. package/.docs/docs/agents/sdk-agents.md +2 -0
  34. package/.docs/docs/agents/signal-providers.md +2 -0
  35. package/.docs/docs/agents/signals.md +2 -0
  36. package/.docs/docs/agents/skills.md +2 -0
  37. package/.docs/docs/agents/structured-output.md +2 -0
  38. package/.docs/docs/agents/supervisor-agents.md +2 -0
  39. package/.docs/docs/agents/using-tools.md +2 -0
  40. package/.docs/docs/browser/agent-browser.md +2 -0
  41. package/.docs/docs/browser/browser-viewer.md +2 -0
  42. package/.docs/docs/browser/overview.md +2 -0
  43. package/.docs/docs/browser/recording.md +6 -2
  44. package/.docs/docs/browser/stagehand.md +2 -0
  45. package/.docs/docs/community/contributing-templates.md +2 -0
  46. package/.docs/docs/community/discord.md +2 -0
  47. package/.docs/docs/community/licensing.md +2 -0
  48. package/.docs/docs/deployment/cloud-providers.md +2 -0
  49. package/.docs/docs/deployment/mastra-server.md +2 -0
  50. package/.docs/docs/deployment/monorepo.md +2 -0
  51. package/.docs/docs/deployment/overview.md +2 -0
  52. package/.docs/docs/deployment/web-framework.md +2 -0
  53. package/.docs/docs/deployment/workflow-runners.md +2 -0
  54. package/.docs/docs/editor/overview.md +2 -0
  55. package/.docs/docs/editor/prompts.md +2 -0
  56. package/.docs/docs/editor/tools.md +2 -0
  57. package/.docs/docs/evals/built-in-scorers.md +2 -0
  58. package/.docs/docs/evals/custom-scorers.md +2 -0
  59. package/.docs/docs/evals/datasets/overview.md +2 -0
  60. package/.docs/docs/evals/datasets/running-experiments.md +2 -0
  61. package/.docs/docs/evals/evals-with-memory.md +2 -0
  62. package/.docs/docs/evals/gates-and-verdicts.md +2 -0
  63. package/.docs/docs/evals/overview.md +2 -0
  64. package/.docs/docs/evals/quick-checks.md +2 -0
  65. package/.docs/docs/evals/running-in-ci.md +2 -0
  66. package/.docs/docs/getting-started/build-with-ai.md +2 -0
  67. package/.docs/docs/getting-started/manual-install.md +2 -0
  68. package/.docs/docs/getting-started/project-structure.md +2 -0
  69. package/.docs/docs/index.md +14 -6
  70. package/.docs/docs/mastra-platform/configuration.md +2 -0
  71. package/.docs/docs/mastra-platform/database.md +2 -0
  72. package/.docs/docs/mastra-platform/github.md +2 -0
  73. package/.docs/docs/mastra-platform/observability.md +2 -0
  74. package/.docs/docs/mastra-platform/overview.md +2 -0
  75. package/.docs/docs/mastra-platform/server.md +2 -0
  76. package/.docs/docs/mastra-platform/studio.md +2 -0
  77. package/.docs/docs/mcp/mcp-apps.md +2 -0
  78. package/.docs/docs/mcp/overview.md +2 -0
  79. package/.docs/docs/memory/memory-processors.md +2 -0
  80. package/.docs/docs/memory/message-history.md +2 -0
  81. package/.docs/docs/memory/multi-user-threads.md +2 -0
  82. package/.docs/docs/memory/observational-memory.md +2 -0
  83. package/.docs/docs/memory/overview.md +2 -0
  84. package/.docs/docs/memory/semantic-recall.md +2 -0
  85. package/.docs/docs/memory/storage.md +6 -0
  86. package/.docs/docs/memory/working-memory.md +2 -0
  87. package/.docs/docs/observability/config.md +2 -0
  88. package/.docs/docs/observability/integrations/bridges/datadog.md +2 -0
  89. package/.docs/docs/observability/integrations/bridges/otel.md +2 -0
  90. package/.docs/docs/observability/integrations/exporters/arize.md +2 -0
  91. package/.docs/docs/observability/integrations/exporters/arthur.md +2 -0
  92. package/.docs/docs/observability/integrations/exporters/braintrust.md +2 -0
  93. package/.docs/docs/observability/integrations/exporters/datadog.md +2 -0
  94. package/.docs/docs/observability/integrations/exporters/laminar.md +2 -0
  95. package/.docs/docs/observability/integrations/exporters/langfuse.md +2 -0
  96. package/.docs/docs/observability/integrations/exporters/langsmith.md +2 -0
  97. package/.docs/docs/observability/integrations/exporters/mastra-platform.md +2 -0
  98. package/.docs/docs/observability/integrations/exporters/mastra-storage.md +2 -0
  99. package/.docs/docs/observability/integrations/exporters/otel.md +2 -0
  100. package/.docs/docs/observability/integrations/exporters/posthog.md +2 -0
  101. package/.docs/docs/observability/integrations/exporters/sentry.md +2 -0
  102. package/.docs/docs/observability/integrations/overview.md +2 -0
  103. package/.docs/docs/observability/integrations/processors/sensitive-data-filter.md +2 -0
  104. package/.docs/docs/observability/logging.md +2 -0
  105. package/.docs/docs/observability/metrics/overview.md +2 -0
  106. package/.docs/docs/observability/metrics/querying.md +2 -0
  107. package/.docs/docs/observability/overview.md +2 -0
  108. package/.docs/docs/observability/storage.md +2 -0
  109. package/.docs/docs/observability/tracing/overview.md +2 -0
  110. package/.docs/docs/rag/chunking-and-embedding.md +2 -0
  111. package/.docs/docs/rag/graph-rag.md +2 -0
  112. package/.docs/docs/rag/overview.md +2 -0
  113. package/.docs/docs/rag/retrieval.md +2 -0
  114. package/.docs/docs/rag/vector-databases.md +2 -0
  115. package/.docs/docs/server/auth/auth0.md +2 -0
  116. package/.docs/docs/server/auth/better-auth.md +2 -0
  117. package/.docs/docs/server/auth/clerk.md +2 -0
  118. package/.docs/docs/server/auth/composite-auth.md +2 -0
  119. package/.docs/docs/server/auth/custom-auth-provider.md +2 -0
  120. package/.docs/docs/server/auth/fga.md +2 -0
  121. package/.docs/docs/server/auth/firebase.md +2 -0
  122. package/.docs/docs/server/auth/google.md +2 -0
  123. package/.docs/docs/server/auth/jwt.md +2 -0
  124. package/.docs/docs/server/auth/okta.md +2 -0
  125. package/.docs/docs/server/auth/simple-auth.md +2 -0
  126. package/.docs/docs/server/auth/supabase.md +2 -0
  127. package/.docs/docs/server/auth/workos.md +2 -0
  128. package/.docs/docs/server/auth.md +2 -0
  129. package/.docs/docs/server/custom-adapters.md +2 -0
  130. package/.docs/docs/server/custom-api-routes.md +2 -0
  131. package/.docs/docs/server/mastra-client.md +2 -0
  132. package/.docs/docs/server/mastra-server.md +2 -0
  133. package/.docs/docs/server/middleware.md +2 -0
  134. package/.docs/docs/server/pubsub.md +2 -0
  135. package/.docs/docs/server/request-context.md +2 -0
  136. package/.docs/docs/server/server-adapters.md +2 -0
  137. package/.docs/docs/studio/auth.md +2 -0
  138. package/.docs/docs/studio/deployment.md +2 -0
  139. package/.docs/docs/studio/observability.md +2 -0
  140. package/.docs/docs/studio/overview.md +2 -0
  141. package/.docs/docs/voice/overview.md +2 -0
  142. package/.docs/docs/voice/speech-to-speech.md +2 -0
  143. package/.docs/docs/voice/speech-to-text.md +2 -0
  144. package/.docs/docs/voice/text-to-speech.md +2 -0
  145. package/.docs/docs/workflows/agents-and-tools.md +2 -0
  146. package/.docs/docs/workflows/control-flow.md +2 -0
  147. package/.docs/docs/workflows/error-handling.md +2 -0
  148. package/.docs/docs/workflows/human-in-the-loop.md +2 -0
  149. package/.docs/docs/workflows/overview.md +2 -0
  150. package/.docs/docs/workflows/scheduled-workflows.md +2 -0
  151. package/.docs/docs/workflows/snapshots.md +2 -0
  152. package/.docs/docs/workflows/suspend-and-resume.md +2 -0
  153. package/.docs/docs/workflows/time-travel.md +2 -0
  154. package/.docs/docs/workflows/workflow-state.md +2 -0
  155. package/.docs/docs/workspace/filesystem.md +2 -0
  156. package/.docs/docs/workspace/lsp.md +2 -0
  157. package/.docs/docs/workspace/overview.md +2 -0
  158. package/.docs/docs/workspace/sandbox.md +2 -0
  159. package/.docs/docs/workspace/search.md +2 -0
  160. package/.docs/docs/workspace/skills.md +2 -0
  161. package/.docs/guides/agent-frameworks/ai-sdk.md +2 -0
  162. package/.docs/guides/build-your-ui/ai-sdk-ui.md +2 -0
  163. package/.docs/guides/build-your-ui/assistant-ui.md +2 -0
  164. package/.docs/guides/build-your-ui/copilotkit.md +2 -0
  165. package/.docs/guides/build-your-ui/openui.md +2 -0
  166. package/.docs/guides/concepts/multi-agent-systems.md +2 -0
  167. package/.docs/guides/concepts/streaming.md +2 -0
  168. package/.docs/guides/deployment/amazon-ec2.md +2 -0
  169. package/.docs/guides/deployment/aws-bedrock-agentcore.md +2 -0
  170. package/.docs/guides/deployment/aws-lambda.md +2 -0
  171. package/.docs/guides/deployment/azure-app-services.md +2 -0
  172. package/.docs/guides/deployment/cloudflare.md +2 -0
  173. package/.docs/guides/deployment/digital-ocean.md +2 -0
  174. package/.docs/guides/deployment/inngest.md +2 -0
  175. package/.docs/guides/deployment/netlify.md +2 -0
  176. package/.docs/guides/deployment/temporal.md +2 -0
  177. package/.docs/guides/deployment/vercel.md +2 -0
  178. package/.docs/guides/getting-started/astro.md +2 -0
  179. package/.docs/guides/getting-started/electron.md +2 -0
  180. package/.docs/guides/getting-started/express.md +2 -0
  181. package/.docs/guides/getting-started/hono.md +2 -0
  182. package/.docs/guides/getting-started/nestjs.md +2 -0
  183. package/.docs/guides/getting-started/next-js.md +2 -0
  184. package/.docs/guides/getting-started/nuxt.md +2 -0
  185. package/.docs/guides/getting-started/quickstart.md +2 -0
  186. package/.docs/guides/getting-started/sveltekit.md +2 -0
  187. package/.docs/guides/getting-started/vite-react.md +2 -0
  188. package/.docs/guides/guide/ai-recruiter.md +2 -0
  189. package/.docs/guides/guide/chef-michel.md +2 -0
  190. package/.docs/guides/guide/code-review-bot.md +2 -0
  191. package/.docs/guides/guide/dev-assistant.md +2 -0
  192. package/.docs/guides/guide/docs-manager.md +2 -0
  193. package/.docs/guides/guide/firecrawl.md +2 -0
  194. package/.docs/guides/guide/github-actions-pr-description.md +2 -0
  195. package/.docs/guides/guide/notes-mcp-server.md +2 -0
  196. package/.docs/guides/guide/publishing-mcp-server.md +2 -0
  197. package/.docs/guides/guide/research-assistant.md +2 -0
  198. package/.docs/guides/guide/research-coordinator.md +2 -0
  199. package/.docs/guides/guide/signal-provider.md +2 -0
  200. package/.docs/guides/guide/slack-assistant.md +2 -0
  201. package/.docs/guides/guide/stock-agent.md +2 -0
  202. package/.docs/guides/guide/web-search.md +2 -0
  203. package/.docs/guides/guide/whatsapp-chat-bot.md +2 -0
  204. package/.docs/guides/index.md +2 -0
  205. package/.docs/guides/migrations/agentnetwork.md +2 -0
  206. package/.docs/guides/migrations/ai-sdk-v4-to-v5.md +2 -0
  207. package/.docs/guides/migrations/mastra-cloud.md +2 -0
  208. package/.docs/guides/migrations/network-to-supervisor.md +2 -0
  209. package/.docs/guides/migrations/upgrade-to-v1/agent.md +2 -0
  210. package/.docs/guides/migrations/upgrade-to-v1/cli.md +2 -0
  211. package/.docs/guides/migrations/upgrade-to-v1/client.md +2 -0
  212. package/.docs/guides/migrations/upgrade-to-v1/deployment.md +2 -0
  213. package/.docs/guides/migrations/upgrade-to-v1/evals.md +2 -0
  214. package/.docs/guides/migrations/upgrade-to-v1/mastra.md +2 -0
  215. package/.docs/guides/migrations/upgrade-to-v1/mcp.md +2 -0
  216. package/.docs/guides/migrations/upgrade-to-v1/memory.md +2 -0
  217. package/.docs/guides/migrations/upgrade-to-v1/overview.md +2 -0
  218. package/.docs/guides/migrations/upgrade-to-v1/processors.md +2 -0
  219. package/.docs/guides/migrations/upgrade-to-v1/rag.md +2 -0
  220. package/.docs/guides/migrations/upgrade-to-v1/storage.md +2 -0
  221. package/.docs/guides/migrations/upgrade-to-v1/tools.md +2 -0
  222. package/.docs/guides/migrations/upgrade-to-v1/tracing.md +2 -0
  223. package/.docs/guides/migrations/upgrade-to-v1/vectors.md +2 -0
  224. package/.docs/guides/migrations/upgrade-to-v1/voice.md +2 -0
  225. package/.docs/guides/migrations/upgrade-to-v1/workflows.md +2 -0
  226. package/.docs/guides/migrations/vnext-to-standard-apis.md +2 -0
  227. package/.docs/models/embeddings.md +2 -0
  228. package/.docs/models/environment-variables.md +2 -0
  229. package/.docs/models/gateways/azure-openai.md +2 -0
  230. package/.docs/models/gateways/custom-gateways.md +2 -0
  231. package/.docs/models/gateways/mastra.md +2 -0
  232. package/.docs/models/gateways/netlify.md +2 -0
  233. package/.docs/models/gateways/openrouter.md +2 -0
  234. package/.docs/models/gateways/vercel.md +2 -0
  235. package/.docs/models/gateways.md +2 -0
  236. package/.docs/models/index.md +2 -0
  237. package/.docs/models/providers/302ai.md +2 -0
  238. package/.docs/models/providers/abacus.md +2 -0
  239. package/.docs/models/providers/abliteration-ai.md +2 -0
  240. package/.docs/models/providers/agentrouter.md +2 -0
  241. package/.docs/models/providers/aihubmix.md +2 -0
  242. package/.docs/models/providers/alibaba-cn.md +2 -0
  243. package/.docs/models/providers/alibaba-coding-plan-cn.md +2 -0
  244. package/.docs/models/providers/alibaba-coding-plan.md +2 -0
  245. package/.docs/models/providers/alibaba-token-plan-cn.md +2 -0
  246. package/.docs/models/providers/alibaba-token-plan.md +2 -0
  247. package/.docs/models/providers/alibaba.md +2 -0
  248. package/.docs/models/providers/amazon-bedrock.md +2 -0
  249. package/.docs/models/providers/ambient.md +2 -0
  250. package/.docs/models/providers/anthropic.md +2 -0
  251. package/.docs/models/providers/anyapi.md +2 -0
  252. package/.docs/models/providers/atomic-chat.md +2 -0
  253. package/.docs/models/providers/auriko.md +2 -0
  254. package/.docs/models/providers/azure.md +2 -0
  255. package/.docs/models/providers/bailing.md +2 -0
  256. package/.docs/models/providers/baseten.md +2 -0
  257. package/.docs/models/providers/berget.md +2 -0
  258. package/.docs/models/providers/cerebras.md +2 -0
  259. package/.docs/models/providers/chutes.md +2 -0
  260. package/.docs/models/providers/clarifai.md +2 -0
  261. package/.docs/models/providers/claudinio.md +2 -0
  262. package/.docs/models/providers/cloudferro-sherlock.md +2 -0
  263. package/.docs/models/providers/cloudflare-ai-gateway.md +2 -0
  264. package/.docs/models/providers/cloudflare-workers-ai.md +2 -0
  265. package/.docs/models/providers/cohere.md +2 -0
  266. package/.docs/models/providers/cortecs.md +2 -0
  267. package/.docs/models/providers/crof.md +2 -0
  268. package/.docs/models/providers/databricks.md +2 -0
  269. package/.docs/models/providers/deepinfra.md +2 -0
  270. package/.docs/models/providers/deepseek.md +2 -0
  271. package/.docs/models/providers/digitalocean.md +2 -0
  272. package/.docs/models/providers/dinference.md +2 -0
  273. package/.docs/models/providers/drun.md +2 -0
  274. package/.docs/models/providers/evroc.md +2 -0
  275. package/.docs/models/providers/fastrouter.md +2 -0
  276. package/.docs/models/providers/firepass.md +2 -0
  277. package/.docs/models/providers/fireworks-ai.md +2 -0
  278. package/.docs/models/providers/firmware.md +2 -0
  279. package/.docs/models/providers/freemodel.md +2 -0
  280. package/.docs/models/providers/friendli.md +2 -0
  281. package/.docs/models/providers/frogbot.md +2 -0
  282. package/.docs/models/providers/github-models.md +2 -0
  283. package/.docs/models/providers/gmicloud.md +5 -1
  284. package/.docs/models/providers/google-vertex.md +2 -0
  285. package/.docs/models/providers/google.md +2 -0
  286. package/.docs/models/providers/groq.md +2 -0
  287. package/.docs/models/providers/helicone.md +2 -0
  288. package/.docs/models/providers/hpc-ai.md +2 -0
  289. package/.docs/models/providers/huggingface.md +2 -0
  290. package/.docs/models/providers/iflowcn.md +2 -0
  291. package/.docs/models/providers/inception.md +2 -0
  292. package/.docs/models/providers/inceptron.md +2 -0
  293. package/.docs/models/providers/inference.md +2 -0
  294. package/.docs/models/providers/io-intelligence.md +2 -0
  295. package/.docs/models/providers/io-net.md +2 -0
  296. package/.docs/models/providers/jiekou.md +2 -0
  297. package/.docs/models/providers/kilo.md +2 -0
  298. package/.docs/models/providers/kimi-for-coding.md +2 -0
  299. package/.docs/models/providers/kiro.md +2 -0
  300. package/.docs/models/providers/kuae-cloud-coding-plan.md +2 -0
  301. package/.docs/models/providers/lilac.md +2 -0
  302. package/.docs/models/providers/llama.md +2 -0
  303. package/.docs/models/providers/llmgateway.md +4 -1
  304. package/.docs/models/providers/llmtr.md +2 -0
  305. package/.docs/models/providers/lmstudio.md +2 -0
  306. package/.docs/models/providers/lucidquery.md +2 -0
  307. package/.docs/models/providers/meganova.md +2 -0
  308. package/.docs/models/providers/minimax-cn-coding-plan.md +2 -0
  309. package/.docs/models/providers/minimax-cn.md +2 -0
  310. package/.docs/models/providers/minimax-coding-plan.md +2 -0
  311. package/.docs/models/providers/minimax.md +2 -0
  312. package/.docs/models/providers/mistral.md +2 -0
  313. package/.docs/models/providers/mixlayer.md +2 -0
  314. package/.docs/models/providers/moark.md +2 -0
  315. package/.docs/models/providers/modelscope.md +2 -0
  316. package/.docs/models/providers/moonshotai-cn.md +2 -0
  317. package/.docs/models/providers/moonshotai.md +2 -0
  318. package/.docs/models/providers/morph.md +2 -0
  319. package/.docs/models/providers/nano-gpt.md +2 -0
  320. package/.docs/models/providers/nearai.md +2 -0
  321. package/.docs/models/providers/nebius.md +2 -0
  322. package/.docs/models/providers/neon.md +2 -0
  323. package/.docs/models/providers/neuralwatt.md +2 -0
  324. package/.docs/models/providers/nova.md +2 -0
  325. package/.docs/models/providers/novita-ai.md +2 -0
  326. package/.docs/models/providers/nvidia.md +2 -0
  327. package/.docs/models/providers/ollama-cloud.md +2 -0
  328. package/.docs/models/providers/ollama.md +2 -0
  329. package/.docs/models/providers/openai.md +2 -0
  330. package/.docs/models/providers/opencode-go.md +2 -0
  331. package/.docs/models/providers/opencode.md +2 -0
  332. package/.docs/models/providers/orcarouter.md +2 -0
  333. package/.docs/models/providers/ovhcloud.md +2 -0
  334. package/.docs/models/providers/perplexity-agent.md +2 -0
  335. package/.docs/models/providers/perplexity.md +2 -0
  336. package/.docs/models/providers/poe.md +2 -0
  337. package/.docs/models/providers/poolside.md +2 -0
  338. package/.docs/models/providers/privatemode-ai.md +2 -0
  339. package/.docs/models/providers/qihang-ai.md +2 -0
  340. package/.docs/models/providers/qiniu-ai.md +2 -0
  341. package/.docs/models/providers/regolo-ai.md +2 -0
  342. package/.docs/models/providers/requesty.md +2 -0
  343. package/.docs/models/providers/routing-run.md +2 -0
  344. package/.docs/models/providers/sakana.md +2 -0
  345. package/.docs/models/providers/sarvam.md +2 -0
  346. package/.docs/models/providers/scaleway.md +2 -0
  347. package/.docs/models/providers/siliconflow-cn.md +2 -0
  348. package/.docs/models/providers/siliconflow.md +2 -0
  349. package/.docs/models/providers/snowflake-cortex.md +2 -0
  350. package/.docs/models/providers/stackit.md +2 -0
  351. package/.docs/models/providers/stepfun-ai.md +2 -0
  352. package/.docs/models/providers/stepfun.md +2 -0
  353. package/.docs/models/providers/subconscious.md +2 -0
  354. package/.docs/models/providers/submodel.md +2 -0
  355. package/.docs/models/providers/synthetic.md +4 -5
  356. package/.docs/models/providers/tencent-coding-plan.md +2 -0
  357. package/.docs/models/providers/tencent-token-plan.md +2 -0
  358. package/.docs/models/providers/tencent-tokenhub.md +2 -0
  359. package/.docs/models/providers/the-grid-ai.md +2 -0
  360. package/.docs/models/providers/tinfoil.md +2 -0
  361. package/.docs/models/providers/togetherai.md +2 -0
  362. package/.docs/models/providers/umans-ai-coding-plan.md +2 -0
  363. package/.docs/models/providers/umans-ai.md +2 -0
  364. package/.docs/models/providers/upstage.md +2 -0
  365. package/.docs/models/providers/venice.md +2 -0
  366. package/.docs/models/providers/vivgrid.md +2 -0
  367. package/.docs/models/providers/vultr.md +2 -0
  368. package/.docs/models/providers/wafer.ai.md +2 -0
  369. package/.docs/models/providers/wandb.md +2 -0
  370. package/.docs/models/providers/xai.md +2 -0
  371. package/.docs/models/providers/xiaomi-token-plan-ams.md +2 -0
  372. package/.docs/models/providers/xiaomi-token-plan-cn.md +2 -0
  373. package/.docs/models/providers/xiaomi-token-plan-sgp.md +2 -0
  374. package/.docs/models/providers/xiaomi.md +2 -0
  375. package/.docs/models/providers/xpersona.md +2 -0
  376. package/.docs/models/providers/zai-coding-plan.md +2 -0
  377. package/.docs/models/providers/zai.md +2 -0
  378. package/.docs/models/providers/zeldoc.md +2 -0
  379. package/.docs/models/providers/zenmux.md +2 -0
  380. package/.docs/models/providers/zhipuai-coding-plan.md +2 -0
  381. package/.docs/models/providers/zhipuai.md +2 -0
  382. package/.docs/models/providers.md +2 -0
  383. package/.docs/reference/acp/acp-agent.md +2 -0
  384. package/.docs/reference/acp/create-acp-tool.md +2 -0
  385. package/.docs/reference/agent-controller/agent-controller-class.md +2 -0
  386. package/.docs/reference/agent-controller/session.md +2 -0
  387. package/.docs/reference/agents/agent.md +32 -2
  388. package/.docs/reference/agents/channels.md +2 -0
  389. package/.docs/reference/agents/createSkill.md +2 -0
  390. package/.docs/reference/agents/durable-agent.md +2 -0
  391. package/.docs/reference/agents/generate.md +94 -92
  392. package/.docs/reference/agents/generateLegacy.md +2 -0
  393. package/.docs/reference/agents/getDefaultGenerateOptions.md +2 -0
  394. package/.docs/reference/agents/getDefaultOptions.md +2 -0
  395. package/.docs/reference/agents/getDefaultStreamOptions.md +2 -0
  396. package/.docs/reference/agents/getDescription.md +2 -0
  397. package/.docs/reference/agents/getInstructions.md +2 -0
  398. package/.docs/reference/agents/getLLM.md +2 -0
  399. package/.docs/reference/agents/getMemory.md +2 -0
  400. package/.docs/reference/agents/getMetadata.md +2 -0
  401. package/.docs/reference/agents/getModel.md +2 -0
  402. package/.docs/reference/agents/getSkill.md +2 -0
  403. package/.docs/reference/agents/getTools.md +2 -0
  404. package/.docs/reference/agents/getVoice.md +2 -0
  405. package/.docs/reference/agents/inngest-agent.md +2 -0
  406. package/.docs/reference/agents/listAgents.md +2 -0
  407. package/.docs/reference/agents/listScorers.md +2 -0
  408. package/.docs/reference/agents/listSkills.md +2 -0
  409. package/.docs/reference/agents/listSuspendedRuns.md +2 -0
  410. package/.docs/reference/agents/listTools.md +2 -0
  411. package/.docs/reference/agents/listWorkflows.md +2 -0
  412. package/.docs/reference/agents/network.md +2 -0
  413. package/.docs/reference/ai-sdk/chat-route.md +2 -0
  414. package/.docs/reference/ai-sdk/handle-chat-stream.md +2 -0
  415. package/.docs/reference/ai-sdk/handle-network-stream.md +2 -0
  416. package/.docs/reference/ai-sdk/handle-workflow-stream.md +2 -0
  417. package/.docs/reference/ai-sdk/network-route.md +2 -0
  418. package/.docs/reference/ai-sdk/to-ai-sdk-messages.md +2 -0
  419. package/.docs/reference/ai-sdk/to-ai-sdk-stream.md +2 -0
  420. package/.docs/reference/ai-sdk/to-ai-sdk-v4-messages.md +2 -0
  421. package/.docs/reference/ai-sdk/to-ai-sdk-v5-messages.md +2 -0
  422. package/.docs/reference/ai-sdk/with-mastra.md +2 -0
  423. package/.docs/reference/ai-sdk/workflow-route.md +2 -0
  424. package/.docs/reference/ai-sdk/workflow-snapshot-to-stream.md +2 -0
  425. package/.docs/reference/auth/auth0.md +2 -0
  426. package/.docs/reference/auth/better-auth.md +2 -0
  427. package/.docs/reference/auth/clerk.md +2 -0
  428. package/.docs/reference/auth/firebase.md +2 -0
  429. package/.docs/reference/auth/google.md +2 -0
  430. package/.docs/reference/auth/jwt.md +2 -0
  431. package/.docs/reference/auth/okta.md +2 -0
  432. package/.docs/reference/auth/supabase.md +2 -0
  433. package/.docs/reference/auth/workos.md +2 -0
  434. package/.docs/reference/browser/agent-browser.md +2 -0
  435. package/.docs/reference/browser/browser-viewer.md +2 -0
  436. package/.docs/reference/browser/mastra-browser.md +2 -0
  437. package/.docs/reference/browser/stagehand-browser.md +2 -0
  438. package/.docs/reference/channels/channel-provider.md +2 -0
  439. package/.docs/reference/channels/slack-provider.md +2 -0
  440. package/.docs/reference/cli/create-mastra.md +2 -0
  441. package/.docs/reference/cli/mastra.md +2 -0
  442. package/.docs/reference/client-js/agent-builder.md +2 -0
  443. package/.docs/reference/client-js/agents.md +2 -0
  444. package/.docs/reference/client-js/conversations.md +2 -0
  445. package/.docs/reference/client-js/error-handling.md +2 -0
  446. package/.docs/reference/client-js/logs.md +2 -0
  447. package/.docs/reference/client-js/mastra-client.md +2 -0
  448. package/.docs/reference/client-js/memory.md +2 -0
  449. package/.docs/reference/client-js/observability.md +2 -0
  450. package/.docs/reference/client-js/responses.md +2 -0
  451. package/.docs/reference/client-js/telemetry.md +2 -0
  452. package/.docs/reference/client-js/tools.md +2 -0
  453. package/.docs/reference/client-js/vectors.md +2 -0
  454. package/.docs/reference/client-js/workflows.md +2 -0
  455. package/.docs/reference/coding-agent/build-base-prompt.md +2 -0
  456. package/.docs/reference/coding-agent/create-coding-agent.md +2 -0
  457. package/.docs/reference/configuration.md +2 -0
  458. package/.docs/reference/core/addGateway.md +2 -0
  459. package/.docs/reference/core/getAgent.md +2 -0
  460. package/.docs/reference/core/getAgentById.md +39 -4
  461. package/.docs/reference/core/getDeployer.md +2 -0
  462. package/.docs/reference/core/getEditor.md +2 -0
  463. package/.docs/reference/core/getGateway.md +2 -0
  464. package/.docs/reference/core/getGatewayById.md +2 -0
  465. package/.docs/reference/core/getLogger.md +2 -0
  466. package/.docs/reference/core/getMCPServer.md +2 -0
  467. package/.docs/reference/core/getMCPServerById.md +2 -0
  468. package/.docs/reference/core/getMemory.md +2 -0
  469. package/.docs/reference/core/getScorer.md +2 -0
  470. package/.docs/reference/core/getScorerById.md +2 -0
  471. package/.docs/reference/core/getServer.md +2 -0
  472. package/.docs/reference/core/getStorage.md +2 -0
  473. package/.docs/reference/core/getTelemetry.md +2 -0
  474. package/.docs/reference/core/getVector.md +2 -0
  475. package/.docs/reference/core/getWorkflow.md +2 -0
  476. package/.docs/reference/core/listAgents.md +2 -0
  477. package/.docs/reference/core/listGateways.md +2 -0
  478. package/.docs/reference/core/listLogs.md +2 -0
  479. package/.docs/reference/core/listLogsByRunId.md +2 -0
  480. package/.docs/reference/core/listMCPServers.md +2 -0
  481. package/.docs/reference/core/listMemory.md +2 -0
  482. package/.docs/reference/core/listScorers.md +2 -0
  483. package/.docs/reference/core/listVectors.md +2 -0
  484. package/.docs/reference/core/listWorkflows.md +2 -0
  485. package/.docs/reference/core/mastra-class.md +2 -0
  486. package/.docs/reference/core/mastra-model-gateway.md +2 -0
  487. package/.docs/reference/core/removeWorkspace.md +2 -0
  488. package/.docs/reference/core/setLogger.md +2 -0
  489. package/.docs/reference/core/setStorage.md +2 -0
  490. package/.docs/reference/datasets/addItem.md +2 -0
  491. package/.docs/reference/datasets/addItems.md +2 -0
  492. package/.docs/reference/datasets/compareExperiments.md +2 -0
  493. package/.docs/reference/datasets/create.md +2 -0
  494. package/.docs/reference/datasets/dataset.md +2 -0
  495. package/.docs/reference/datasets/datasets-manager.md +2 -0
  496. package/.docs/reference/datasets/delete.md +2 -0
  497. package/.docs/reference/datasets/deleteExperiment.md +2 -0
  498. package/.docs/reference/datasets/deleteItem.md +2 -0
  499. package/.docs/reference/datasets/deleteItems.md +2 -0
  500. package/.docs/reference/datasets/get.md +2 -0
  501. package/.docs/reference/datasets/getDetails.md +2 -0
  502. package/.docs/reference/datasets/getExperiment.md +2 -0
  503. package/.docs/reference/datasets/getItem.md +2 -0
  504. package/.docs/reference/datasets/getItemHistory.md +2 -0
  505. package/.docs/reference/datasets/list.md +2 -0
  506. package/.docs/reference/datasets/listExperimentResults.md +21 -1
  507. package/.docs/reference/datasets/listExperiments.md +22 -1
  508. package/.docs/reference/datasets/listItems.md +2 -0
  509. package/.docs/reference/datasets/listVersions.md +2 -0
  510. package/.docs/reference/datasets/startExperiment.md +2 -0
  511. package/.docs/reference/datasets/startExperimentAsync.md +2 -0
  512. package/.docs/reference/datasets/update.md +2 -0
  513. package/.docs/reference/datasets/updateItem.md +2 -0
  514. package/.docs/reference/deployer/cloudflare.md +2 -0
  515. package/.docs/reference/deployer/netlify.md +2 -0
  516. package/.docs/reference/deployer/vercel.md +2 -0
  517. package/.docs/reference/deployer.md +2 -0
  518. package/.docs/reference/editor/agent-builder/agent-builder-options.md +2 -0
  519. package/.docs/reference/editor/agent-builder/builder-agent-defaults.md +2 -0
  520. package/.docs/reference/editor/agent-builder/builder-models.md +2 -0
  521. package/.docs/reference/editor/blob-store-provider.md +2 -0
  522. package/.docs/reference/editor/browser-provider.md +2 -0
  523. package/.docs/reference/editor/filesystem-provider.md +2 -0
  524. package/.docs/reference/editor/mastra-editor.md +2 -0
  525. package/.docs/reference/editor/processor-provider.md +2 -0
  526. package/.docs/reference/editor/sandbox-provider.md +2 -0
  527. package/.docs/reference/editor/storage-browser-ref.md +2 -0
  528. package/.docs/reference/editor/storage-workspace-ref.md +2 -0
  529. package/.docs/reference/editor/tool-provider.md +2 -0
  530. package/.docs/reference/evals/answer-relevancy.md +2 -0
  531. package/.docs/reference/evals/answer-similarity.md +2 -0
  532. package/.docs/reference/evals/bias.md +2 -0
  533. package/.docs/reference/evals/checks.md +2 -0
  534. package/.docs/reference/evals/completeness.md +2 -0
  535. package/.docs/reference/evals/content-similarity.md +2 -0
  536. package/.docs/reference/evals/context-precision.md +2 -0
  537. package/.docs/reference/evals/context-relevance.md +2 -0
  538. package/.docs/reference/evals/create-scorer.md +2 -0
  539. package/.docs/reference/evals/faithfulness.md +2 -0
  540. package/.docs/reference/evals/filter-run.md +2 -0
  541. package/.docs/reference/evals/hallucination.md +2 -0
  542. package/.docs/reference/evals/keyword-coverage.md +2 -0
  543. package/.docs/reference/evals/mastra-scorer.md +2 -0
  544. package/.docs/reference/evals/noise-sensitivity.md +2 -0
  545. package/.docs/reference/evals/prompt-alignment.md +2 -0
  546. package/.docs/reference/evals/rubric.md +2 -0
  547. package/.docs/reference/evals/run-evals.md +2 -0
  548. package/.docs/reference/evals/scorer-utils.md +2 -0
  549. package/.docs/reference/evals/textual-difference.md +2 -0
  550. package/.docs/reference/evals/tone-consistency.md +2 -0
  551. package/.docs/reference/evals/tool-call-accuracy.md +2 -0
  552. package/.docs/reference/evals/toxicity.md +2 -0
  553. package/.docs/reference/evals/trajectory-accuracy.md +2 -0
  554. package/.docs/reference/index.md +3 -0
  555. package/.docs/reference/logging/pino-logger.md +2 -0
  556. package/.docs/reference/mastra-platform/api.md +2 -0
  557. package/.docs/reference/memory/clone-utilities.md +2 -0
  558. package/.docs/reference/memory/cloneThread.md +2 -0
  559. package/.docs/reference/memory/createThread.md +2 -0
  560. package/.docs/reference/memory/deleteMessages.md +2 -0
  561. package/.docs/reference/memory/getThreadById.md +2 -0
  562. package/.docs/reference/memory/listThreads.md +2 -0
  563. package/.docs/reference/memory/memory-class.md +2 -0
  564. package/.docs/reference/memory/observational-memory.md +2 -0
  565. package/.docs/reference/memory/recall.md +2 -0
  566. package/.docs/reference/memory/serialized-memory-config.md +2 -0
  567. package/.docs/reference/observability/metrics/automatic-metrics.md +2 -0
  568. package/.docs/reference/observability/tracing/bridges/datadog.md +2 -0
  569. package/.docs/reference/observability/tracing/bridges/otel.md +2 -0
  570. package/.docs/reference/observability/tracing/configuration.md +2 -0
  571. package/.docs/reference/observability/tracing/exporters/arize.md +2 -0
  572. package/.docs/reference/observability/tracing/exporters/arthur.md +2 -0
  573. package/.docs/reference/observability/tracing/exporters/braintrust.md +2 -0
  574. package/.docs/reference/observability/tracing/exporters/cloud-exporter.md +2 -0
  575. package/.docs/reference/observability/tracing/exporters/console-exporter.md +2 -0
  576. package/.docs/reference/observability/tracing/exporters/datadog.md +2 -0
  577. package/.docs/reference/observability/tracing/exporters/default-exporter.md +2 -0
  578. package/.docs/reference/observability/tracing/exporters/laminar.md +2 -0
  579. package/.docs/reference/observability/tracing/exporters/langfuse.md +2 -0
  580. package/.docs/reference/observability/tracing/exporters/langsmith.md +2 -0
  581. package/.docs/reference/observability/tracing/exporters/mastra-platform-exporter.md +2 -0
  582. package/.docs/reference/observability/tracing/exporters/mastra-storage-exporter.md +2 -0
  583. package/.docs/reference/observability/tracing/exporters/otel.md +2 -0
  584. package/.docs/reference/observability/tracing/exporters/posthog.md +2 -0
  585. package/.docs/reference/observability/tracing/exporters/sentry.md +2 -0
  586. package/.docs/reference/observability/tracing/instances.md +2 -0
  587. package/.docs/reference/observability/tracing/interfaces.md +2 -0
  588. package/.docs/reference/observability/tracing/processors/sensitive-data-filter.md +2 -0
  589. package/.docs/reference/observability/tracing/span-filtering.md +2 -0
  590. package/.docs/reference/observability/tracing/spans.md +2 -0
  591. package/.docs/reference/processors/batch-parts-processor.md +2 -0
  592. package/.docs/reference/processors/cost-guard-processor.md +2 -0
  593. package/.docs/reference/processors/language-detector.md +2 -0
  594. package/.docs/reference/processors/message-history-processor.md +2 -0
  595. package/.docs/reference/processors/moderation-processor.md +2 -0
  596. package/.docs/reference/processors/pii-detector.md +2 -0
  597. package/.docs/reference/processors/prefill-error-handler.md +2 -0
  598. package/.docs/reference/processors/processor-interface.md +2 -0
  599. package/.docs/reference/processors/prompt-injection-detector.md +2 -0
  600. package/.docs/reference/processors/provider-history-compat.md +2 -0
  601. package/.docs/reference/processors/regex-filter-processor.md +2 -0
  602. package/.docs/reference/processors/response-cache.md +2 -0
  603. package/.docs/reference/processors/semantic-recall-processor.md +2 -0
  604. package/.docs/reference/processors/skill-search-processor.md +2 -0
  605. package/.docs/reference/processors/stream-error-retry-processor.md +2 -0
  606. package/.docs/reference/processors/system-prompt-scrubber.md +2 -0
  607. package/.docs/reference/processors/token-limiter-processor.md +2 -0
  608. package/.docs/reference/processors/tool-call-filter.md +2 -0
  609. package/.docs/reference/processors/tool-search-processor.md +2 -0
  610. package/.docs/reference/processors/unicode-normalizer.md +2 -0
  611. package/.docs/reference/processors/working-memory-processor.md +2 -0
  612. package/.docs/reference/pubsub/base.md +2 -0
  613. package/.docs/reference/pubsub/caching-pubsub.md +2 -0
  614. package/.docs/reference/pubsub/event-emitter.md +2 -0
  615. package/.docs/reference/pubsub/google-cloud-pubsub.md +2 -0
  616. package/.docs/reference/pubsub/lease-provider.md +2 -0
  617. package/.docs/reference/pubsub/redis-streams.md +2 -0
  618. package/.docs/reference/pubsub/unix-socket-pubsub.md +2 -0
  619. package/.docs/reference/rag/chunk.md +2 -0
  620. package/.docs/reference/rag/database-config.md +2 -0
  621. package/.docs/reference/rag/document.md +2 -0
  622. package/.docs/reference/rag/embeddings.md +2 -0
  623. package/.docs/reference/rag/extract-params.md +2 -0
  624. package/.docs/reference/rag/graph-rag.md +2 -0
  625. package/.docs/reference/rag/metadata-filters.md +2 -0
  626. package/.docs/reference/rag/rerank.md +2 -0
  627. package/.docs/reference/rag/rerankWithScorer.md +2 -0
  628. package/.docs/reference/server/create-route.md +2 -0
  629. package/.docs/reference/server/express-adapter.md +2 -0
  630. package/.docs/reference/server/fastify-adapter.md +2 -0
  631. package/.docs/reference/server/hono-adapter.md +2 -0
  632. package/.docs/reference/server/koa-adapter.md +2 -0
  633. package/.docs/reference/server/mastra-server.md +2 -0
  634. package/.docs/reference/server/nestjs-adapter.md +2 -0
  635. package/.docs/reference/server/register-api-route.md +2 -0
  636. package/.docs/reference/server/routes.md +2 -0
  637. package/.docs/reference/signals/create-notification-inbox-tool.md +2 -0
  638. package/.docs/reference/signals/signal-provider.md +2 -0
  639. package/.docs/reference/signals/task-signal-provider.md +2 -0
  640. package/.docs/reference/signals/webhook-signal-provider.md +2 -0
  641. package/.docs/reference/storage/clickhouse.md +2 -0
  642. package/.docs/reference/storage/cloudflare-d1.md +2 -0
  643. package/.docs/reference/storage/cloudflare.md +2 -0
  644. package/.docs/reference/storage/composite.md +2 -0
  645. package/.docs/reference/storage/convex.md +2 -0
  646. package/.docs/reference/storage/dsql.md +2 -0
  647. package/.docs/reference/storage/duckdb.md +2 -0
  648. package/.docs/reference/storage/dynamodb.md +2 -0
  649. package/.docs/reference/storage/lance.md +2 -0
  650. package/.docs/reference/storage/libsql.md +2 -0
  651. package/.docs/reference/storage/mongodb.md +2 -0
  652. package/.docs/reference/storage/mssql.md +2 -0
  653. package/.docs/reference/storage/overview.md +2 -0
  654. package/.docs/reference/storage/postgresql.md +2 -0
  655. package/.docs/reference/storage/redis.md +2 -0
  656. package/.docs/reference/storage/retention.md +180 -0
  657. package/.docs/reference/storage/spanner.md +2 -0
  658. package/.docs/reference/storage/upstash.md +2 -0
  659. package/.docs/reference/streaming/ChunkType.md +2 -0
  660. package/.docs/reference/streaming/agents/MastraModelOutput.md +2 -0
  661. package/.docs/reference/streaming/agents/stream.md +2 -0
  662. package/.docs/reference/streaming/agents/streamLegacy.md +2 -0
  663. package/.docs/reference/streaming/agents/streamUntilIdle.md +2 -0
  664. package/.docs/reference/streaming/workflows/observeStream.md +2 -0
  665. package/.docs/reference/streaming/workflows/resumeStream.md +2 -0
  666. package/.docs/reference/streaming/workflows/stream.md +2 -0
  667. package/.docs/reference/streaming/workflows/timeTravelStream.md +2 -0
  668. package/.docs/reference/templates/overview.md +2 -0
  669. package/.docs/reference/tools/brightdata.md +2 -0
  670. package/.docs/reference/tools/create-code-mode.md +2 -0
  671. package/.docs/reference/tools/create-tool.md +116 -75
  672. package/.docs/reference/tools/document-chunker-tool.md +2 -0
  673. package/.docs/reference/tools/graph-rag-tool.md +2 -0
  674. package/.docs/reference/tools/mcp-client.md +2 -0
  675. package/.docs/reference/tools/mcp-server.md +2 -0
  676. package/.docs/reference/tools/perplexity.md +2 -0
  677. package/.docs/reference/tools/tavily.md +2 -0
  678. package/.docs/reference/tools/vector-query-tool.md +2 -0
  679. package/.docs/reference/vectors/astra.md +2 -0
  680. package/.docs/reference/vectors/chroma.md +2 -0
  681. package/.docs/reference/vectors/convex.md +2 -0
  682. package/.docs/reference/vectors/couchbase.md +2 -0
  683. package/.docs/reference/vectors/duckdb.md +2 -0
  684. package/.docs/reference/vectors/elasticsearch.md +2 -0
  685. package/.docs/reference/vectors/lance.md +2 -0
  686. package/.docs/reference/vectors/libsql.md +2 -0
  687. package/.docs/reference/vectors/mongodb.md +2 -0
  688. package/.docs/reference/vectors/opensearch.md +2 -0
  689. package/.docs/reference/vectors/pg.md +2 -0
  690. package/.docs/reference/vectors/pinecone.md +2 -0
  691. package/.docs/reference/vectors/qdrant.md +2 -0
  692. package/.docs/reference/vectors/s3vectors.md +2 -0
  693. package/.docs/reference/vectors/turbopuffer.md +2 -0
  694. package/.docs/reference/vectors/upstash.md +2 -0
  695. package/.docs/reference/vectors/vectorize.md +2 -0
  696. package/.docs/reference/voice/aws-nova-sonic.md +2 -0
  697. package/.docs/reference/voice/azure.md +2 -0
  698. package/.docs/reference/voice/cloudflare.md +2 -0
  699. package/.docs/reference/voice/composite-voice.md +2 -0
  700. package/.docs/reference/voice/deepgram.md +2 -0
  701. package/.docs/reference/voice/elevenlabs.md +2 -0
  702. package/.docs/reference/voice/google-gemini-live.md +2 -0
  703. package/.docs/reference/voice/google.md +2 -0
  704. package/.docs/reference/voice/inworld-realtime.md +2 -0
  705. package/.docs/reference/voice/inworld.md +2 -0
  706. package/.docs/reference/voice/mastra-voice.md +2 -0
  707. package/.docs/reference/voice/murf.md +2 -0
  708. package/.docs/reference/voice/openai-realtime.md +2 -0
  709. package/.docs/reference/voice/openai.md +2 -0
  710. package/.docs/reference/voice/playai.md +2 -0
  711. package/.docs/reference/voice/sarvam.md +2 -0
  712. package/.docs/reference/voice/speechify.md +2 -0
  713. package/.docs/reference/voice/voice.addInstructions.md +2 -0
  714. package/.docs/reference/voice/voice.addTools.md +2 -0
  715. package/.docs/reference/voice/voice.answer.md +2 -0
  716. package/.docs/reference/voice/voice.close.md +2 -0
  717. package/.docs/reference/voice/voice.connect.md +2 -0
  718. package/.docs/reference/voice/voice.events.md +2 -0
  719. package/.docs/reference/voice/voice.getSpeakers.md +2 -0
  720. package/.docs/reference/voice/voice.listen.md +2 -0
  721. package/.docs/reference/voice/voice.off.md +2 -0
  722. package/.docs/reference/voice/voice.on.md +2 -0
  723. package/.docs/reference/voice/voice.send.md +2 -0
  724. package/.docs/reference/voice/voice.speak.md +2 -0
  725. package/.docs/reference/voice/voice.updateConfig.md +2 -0
  726. package/.docs/reference/voice/xai-realtime.md +2 -0
  727. package/.docs/reference/workflows/run-methods/cancel.md +2 -0
  728. package/.docs/reference/workflows/run-methods/restart.md +2 -0
  729. package/.docs/reference/workflows/run-methods/resume.md +2 -0
  730. package/.docs/reference/workflows/run-methods/start.md +2 -0
  731. package/.docs/reference/workflows/run-methods/startAsync.md +2 -0
  732. package/.docs/reference/workflows/run-methods/timeTravel.md +2 -0
  733. package/.docs/reference/workflows/run.md +2 -0
  734. package/.docs/reference/workflows/step.md +2 -0
  735. package/.docs/reference/workflows/workflow-methods/branch.md +2 -0
  736. package/.docs/reference/workflows/workflow-methods/commit.md +2 -0
  737. package/.docs/reference/workflows/workflow-methods/create-run.md +2 -0
  738. package/.docs/reference/workflows/workflow-methods/dountil.md +2 -0
  739. package/.docs/reference/workflows/workflow-methods/dowhile.md +2 -0
  740. package/.docs/reference/workflows/workflow-methods/foreach.md +2 -0
  741. package/.docs/reference/workflows/workflow-methods/map.md +2 -0
  742. package/.docs/reference/workflows/workflow-methods/parallel.md +2 -0
  743. package/.docs/reference/workflows/workflow-methods/sleep.md +2 -0
  744. package/.docs/reference/workflows/workflow-methods/sleepUntil.md +2 -0
  745. package/.docs/reference/workflows/workflow-methods/then.md +2 -0
  746. package/.docs/reference/workflows/workflow-state-reader.md +2 -0
  747. package/.docs/reference/workflows/workflow.md +2 -0
  748. package/.docs/reference/workspace/agentcore-runtime-sandbox.md +2 -0
  749. package/.docs/reference/workspace/agentfs-filesystem.md +2 -0
  750. package/.docs/reference/workspace/apple-container-sandbox.md +2 -0
  751. package/.docs/reference/workspace/archil-filesystem.md +2 -0
  752. package/.docs/reference/workspace/azure-blob-filesystem.md +2 -0
  753. package/.docs/reference/workspace/blaxel-sandbox.md +2 -0
  754. package/.docs/reference/workspace/daytona-sandbox.md +2 -0
  755. package/.docs/reference/workspace/docker-sandbox.md +2 -0
  756. package/.docs/reference/workspace/e2b-sandbox.md +2 -0
  757. package/.docs/reference/workspace/files-sdk-filesystem.md +2 -0
  758. package/.docs/reference/workspace/filesystem.md +2 -0
  759. package/.docs/reference/workspace/gcs-filesystem.md +2 -0
  760. package/.docs/reference/workspace/google-drive-filesystem.md +2 -0
  761. package/.docs/reference/workspace/local-filesystem.md +2 -0
  762. package/.docs/reference/workspace/local-sandbox.md +2 -0
  763. package/.docs/reference/workspace/mesa-filesystem.md +2 -0
  764. package/.docs/reference/workspace/modal-sandbox.md +2 -0
  765. package/.docs/reference/workspace/process-manager.md +2 -0
  766. package/.docs/reference/workspace/railway-sandbox.md +2 -0
  767. package/.docs/reference/workspace/s3-filesystem.md +2 -0
  768. package/.docs/reference/workspace/sandbox.md +2 -0
  769. package/.docs/reference/workspace/vercel-microvm-sandbox.md +2 -0
  770. package/.docs/reference/workspace/vercel.md +2 -0
  771. package/.docs/reference/workspace/workspace-class.md +2 -0
  772. package/CHANGELOG.md +15 -0
  773. package/package.json +4 -4
@@ -1,8 +1,10 @@
1
+ > Discover all available pages from the documentation index: https://mastra.ai/llms.txt
2
+
1
3
  # dataset.listExperimentResults()
2
4
 
3
5
  **Added in:** `@mastra/core@1.4.0`
4
6
 
5
- Lists individual item results for a specific experiment with pagination.
7
+ Lists individual item results for a specific experiment with optional filters and pagination. Filters are applied at the storage layer.
6
8
 
7
9
  ## Usage example
8
10
 
@@ -21,6 +23,18 @@ const { results, pagination } = await dataset.listExperimentResults({
21
23
  perPage: 50,
22
24
  })
23
25
 
26
+ // Restrict to results that still need review
27
+ const { results: pending } = await dataset.listExperimentResults({
28
+ experimentId: 'exp-id',
29
+ status: 'needs-review',
30
+ })
31
+
32
+ // Restrict to results tied to a specific trace
33
+ const { results: byTrace } = await dataset.listExperimentResults({
34
+ experimentId: 'exp-id',
35
+ traceId: 'trace-abc',
36
+ })
37
+
24
38
  for (const result of results) {
25
39
  console.log(`Item ${result.itemId}: ${result.error ? 'FAILED' : 'OK'}`)
26
40
  }
@@ -30,6 +44,12 @@ for (const result of results) {
30
44
 
31
45
  **experimentId** (`string`): ID of the experiment to list results for.
32
46
 
47
+ **traceId** (`string`): Restrict results to those linked to this trace ID.
48
+
49
+ **status** (`'needs-review' | 'reviewed' | 'complete'`): Restrict results to this per-result review status.
50
+
51
+ **filters** (`ExperimentTenancyFilters`): Multi-tenant scoping filters (\`organizationId\`, \`projectId\`). Forwarded to the storage layer.
52
+
33
53
  **page** (`number`): Page number. Defaults to \`0\`.
34
54
 
35
55
  **perPage** (`number`): Number of results per page. Defaults to \`20\`.
@@ -1,8 +1,10 @@
1
+ > Discover all available pages from the documentation index: https://mastra.ai/llms.txt
2
+
1
3
  # dataset.listExperiments()
2
4
 
3
5
  **Added in:** `@mastra/core@1.4.0`
4
6
 
5
- Lists all experiments (runs) for this dataset with pagination.
7
+ Lists experiments (runs) for this dataset with optional filters and pagination. Filters are applied at the storage layer, so results are always scoped to the current dataset.
6
8
 
7
9
  ## Usage example
8
10
 
@@ -15,8 +17,17 @@ const mastra = new Mastra({
15
17
 
16
18
  const dataset = await mastra.datasets.get({ id: 'dataset-id' })
17
19
 
20
+ // Basic pagination
18
21
  const { experiments, pagination } = await dataset.listExperiments({ page: 0, perPage: 10 })
19
22
 
23
+ // Filter to a specific agent version — useful for baseline vs variant comparisons
24
+ const { experiments: v2Runs } = await dataset.listExperiments({
25
+ targetType: 'agent',
26
+ targetId: 'my-agent',
27
+ agentVersion: 'v2',
28
+ status: 'completed',
29
+ })
30
+
20
31
  for (const exp of experiments) {
21
32
  console.log(`${exp.id}: ${exp.status} (${exp.succeededCount}/${exp.totalItems})`)
22
33
  }
@@ -24,6 +35,16 @@ for (const exp of experiments) {
24
35
 
25
36
  ## Parameters
26
37
 
38
+ **targetType** (`'agent' | 'workflow' | 'scorer' | 'processor'`): Restrict results to experiments run against this target type.
39
+
40
+ **targetId** (`string`): Restrict results to experiments run against this target ID.
41
+
42
+ **agentVersion** (`string`): Restrict results to experiments recorded against this agent version. Useful for distinguishing baseline from variant runs.
43
+
44
+ **status** (`'pending' | 'running' | 'completed' | 'failed'`): Restrict results to experiments in this status.
45
+
46
+ **filters** (`ExperimentTenancyFilters`): Multi-tenant scoping filters (\`organizationId\`, \`projectId\`). Forwarded to the storage layer.
47
+
27
48
  **page** (`number`): Page number. Defaults to \`0\`.
28
49
 
29
50
  **perPage** (`number`): Number of experiments per page. Defaults to \`20\`.
@@ -1,3 +1,5 @@
1
+ > Discover all available pages from the documentation index: https://mastra.ai/llms.txt
2
+
1
3
  # dataset.listItems()
2
4
 
3
5
  **Added in:** `@mastra/core@1.4.0`
@@ -1,3 +1,5 @@
1
+ > Discover all available pages from the documentation index: https://mastra.ai/llms.txt
2
+
1
3
  # dataset.listVersions()
2
4
 
3
5
  **Added in:** `@mastra/core@1.4.0`
@@ -1,3 +1,5 @@
1
+ > Discover all available pages from the documentation index: https://mastra.ai/llms.txt
2
+
1
3
  # dataset.startExperiment()
2
4
 
3
5
  **Added in:** `@mastra/core@1.4.0`
@@ -1,3 +1,5 @@
1
+ > Discover all available pages from the documentation index: https://mastra.ai/llms.txt
2
+
1
3
  # dataset.startExperimentAsync()
2
4
 
3
5
  **Added in:** `@mastra/core@1.4.0`
@@ -1,3 +1,5 @@
1
+ > Discover all available pages from the documentation index: https://mastra.ai/llms.txt
2
+
1
3
  # dataset.update()
2
4
 
3
5
  **Added in:** `@mastra/core@1.4.0`
@@ -1,3 +1,5 @@
1
+ > Discover all available pages from the documentation index: https://mastra.ai/llms.txt
2
+
1
3
  # dataset.updateItem()
2
4
 
3
5
  **Added in:** `@mastra/core@1.4.0`
@@ -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 relevancy scorer
2
4
 
3
5
  The `createAnswerRelevancyScorer()` function accepts a single options object with the following properties:
@@ -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
  # Bias scorer
2
4
 
3
5
  The `createBiasScorer()` function accepts a single options object with the following properties:
@@ -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.
@@ -1,3 +1,5 @@
1
+ > Discover all available pages from the documentation index: https://mastra.ai/llms.txt
2
+
1
3
  # Completeness scorer
2
4
 
3
5
  The `createCompletenessScorer()` function evaluates how thoroughly an LLM's output covers the key elements present in the input. It analyzes nouns, verbs, topics, and terms to determine coverage and provides a detailed completeness score.
@@ -1,3 +1,5 @@
1
+ > Discover all available pages from the documentation index: https://mastra.ai/llms.txt
2
+
1
3
  # Content similarity scorer
2
4
 
3
5
  The `createContentSimilarityScorer()` function measures the textual similarity between two strings, providing a score that indicates how closely they match. It supports configurable options for case sensitivity and whitespace handling.
@@ -1,3 +1,5 @@
1
+ > Discover all available pages from the documentation index: https://mastra.ai/llms.txt
2
+
1
3
  # Context precision scorer
2
4
 
3
5
  The `createContextPrecisionScorer()` function creates a scorer that evaluates how relevant and well-positioned retrieved context pieces are for generating expected outputs. It uses **Mean Average Precision (MAP)** to reward systems that place relevant context earlier in the sequence.
@@ -1,3 +1,5 @@
1
+ > Discover all available pages from the documentation index: https://mastra.ai/llms.txt
2
+
1
3
  # Context relevance scorer
2
4
 
3
5
  The `createContextRelevanceScorerLLM()` function creates a scorer that evaluates how relevant and useful provided context was for generating agent responses. It uses weighted relevance levels and applies penalties for unused high-relevance context and missing information.
@@ -1,3 +1,5 @@
1
+ > Discover all available pages from the documentation index: https://mastra.ai/llms.txt
2
+
1
3
  # createScorer
2
4
 
3
5
  Mastra provides a unified `createScorer` factory that allows you to define custom scorers for evaluating input/output pairs. You can use either native JavaScript functions or LLM-based prompt objects for each evaluation step. Custom scorers can be added to Agents and Workflow steps.
@@ -1,3 +1,5 @@
1
+ > Discover all available pages from the documentation index: https://mastra.ai/llms.txt
2
+
1
3
  # Faithfulness scorer
2
4
 
3
5
  The `createFaithfulnessScorer()` function evaluates how factually accurate an LLM's output is compared to the provided context. It extracts claims from the output and verifies them against the context, making it essential to measure RAG pipeline responses' reliability.
@@ -1,3 +1,5 @@
1
+ > Discover all available pages from the documentation index: https://mastra.ai/llms.txt
2
+
1
3
  # filterRun()
2
4
 
3
5
  Creates a `prepareRun` function from declarative options. Pass the result to `createScorer()` to filter messages, limit context size, and drop unnecessary fields before the scorer pipeline runs.
@@ -1,3 +1,5 @@
1
+ > Discover all available pages from the documentation index: https://mastra.ai/llms.txt
2
+
1
3
  # Hallucination scorer
2
4
 
3
5
  The `createHallucinationScorer()` function evaluates whether an LLM generates factually correct information by comparing its output against the provided context. This scorer measures hallucination by identifying direct contradictions between the context and the output.
@@ -1,3 +1,5 @@
1
+ > Discover all available pages from the documentation index: https://mastra.ai/llms.txt
2
+
1
3
  # Keyword coverage scorer
2
4
 
3
5
  The `createKeywordCoverageScorer()` function evaluates how well an LLM's output covers the important keywords from the input. It analyzes keyword presence and matches while ignoring common words and stop words.
@@ -1,3 +1,5 @@
1
+ > Discover all available pages from the documentation index: https://mastra.ai/llms.txt
2
+
1
3
  # MastraScorer
2
4
 
3
5
  The `MastraScorer` class is the base class for all scorers in Mastra. It provides a standard `.run()` method for evaluating input/output pairs and supports multi-step scoring workflows with preprocess → analyze → generateScore → generateReason execution flow.
@@ -1,3 +1,5 @@
1
+ > Discover all available pages from the documentation index: https://mastra.ai/llms.txt
2
+
1
3
  # Noise sensitivity scorer
2
4
 
3
5
  The `createNoiseSensitivityScorerLLM()` function creates a **CI/testing scorer** that evaluates how robust an agent is when exposed to irrelevant, distracting, or misleading information. Unlike live scorers that evaluate single production runs, this scorer requires predetermined test data including both baseline responses and noisy variations.
@@ -1,3 +1,5 @@
1
+ > Discover all available pages from the documentation index: https://mastra.ai/llms.txt
2
+
1
3
  # Prompt alignment scorer
2
4
 
3
5
  The `createPromptAlignmentScorerLLM()` function creates a scorer that evaluates how well agent responses align with user prompts across multiple dimensions: intent understanding, requirement fulfillment, response completeness, and format appropriateness.
@@ -1,3 +1,5 @@
1
+ > Discover all available pages from the documentation index: https://mastra.ai/llms.txt
2
+
1
3
  # Rubric scorer
2
4
 
3
5
  **Added in:** `@mastra/evals@1.3.0`
@@ -1,3 +1,5 @@
1
+ > Discover all available pages from the documentation index: https://mastra.ai/llms.txt
2
+
1
3
  # runEvals
2
4
 
3
5
  The `runEvals` function enables batch evaluation of agents and workflows by running multiple test cases against scorers concurrently. This is essential for systematic testing, performance analysis, and validation of AI systems.
@@ -1,3 +1,5 @@
1
+ > Discover all available pages from the documentation index: https://mastra.ai/llms.txt
2
+
1
3
  # Scorer utils
2
4
 
3
5
  Mastra provides utility functions to help extract and process data from scorer run inputs and outputs. These utilities are particularly useful in the `preprocess` step of custom scorers.
@@ -1,3 +1,5 @@
1
+ > Discover all available pages from the documentation index: https://mastra.ai/llms.txt
2
+
1
3
  # Textual difference scorer
2
4
 
3
5
  The `createTextualDifferenceScorer()` function uses sequence matching to measure the textual differences between two strings. It provides detailed information about changes, including the number of operations needed to transform one text into another.
@@ -1,3 +1,5 @@
1
+ > Discover all available pages from the documentation index: https://mastra.ai/llms.txt
2
+
1
3
  # Tone consistency scorer
2
4
 
3
5
  The `createToneScorer()` function evaluates the text's emotional tone and sentiment consistency. It can operate in two modes: comparing tone between input/output pairs or analyzing tone stability within a single text.
@@ -1,3 +1,5 @@
1
+ > Discover all available pages from the documentation index: https://mastra.ai/llms.txt
2
+
1
3
  # Tool call accuracy scorers
2
4
 
3
5
  Mastra provides two tool call accuracy scorers for evaluating whether an LLM selects the correct tools from available options:
@@ -1,3 +1,5 @@
1
+ > Discover all available pages from the documentation index: https://mastra.ai/llms.txt
2
+
1
3
  # Toxicity scorer
2
4
 
3
5
  The `createToxicityScorer()` function evaluates whether an LLM's output contains racist, biased, or toxic elements. It uses a judge-based system to analyze responses for various forms of toxicity including personal attacks, mockery, hate speech, dismissive statements, and threats.
@@ -1,3 +1,5 @@
1
+ > Discover all available pages from the documentation index: https://mastra.ai/llms.txt
2
+
1
3
  # Trajectory accuracy scorers
2
4
 
3
5
  Mastra provides two trajectory accuracy scorers for evaluating whether an agent or workflow follows an expected sequence of actions:
@@ -1,3 +1,5 @@
1
+ > Discover all available pages from the documentation index: https://mastra.ai/llms.txt
2
+
1
3
  # Reference
2
4
 
3
5
  The Reference section provides documentation of Mastra's API, including parameters, types and usage examples.
@@ -256,6 +258,7 @@ The Reference section provides documentation of Mastra's API, including paramete
256
258
  - [MSSQL Storage](https://mastra.ai/reference/storage/mssql)
257
259
  - [PostgreSQL Storage](https://mastra.ai/reference/storage/postgresql)
258
260
  - [Redis Storage](https://mastra.ai/reference/storage/redis)
261
+ - [Retention (prune)](https://mastra.ai/reference/storage/retention)
259
262
  - [Upstash Storage](https://mastra.ai/reference/storage/upstash)
260
263
  - [ChunkType](https://mastra.ai/reference/streaming/ChunkType)
261
264
  - [MastraModelOutput](https://mastra.ai/reference/streaming/agents/MastraModelOutput)
@@ -1,3 +1,5 @@
1
+ > Discover all available pages from the documentation index: https://mastra.ai/llms.txt
2
+
1
3
  # PinoLogger
2
4
 
3
5
  A Logger instance is created using `new PinoLogger()` and provides methods to record events at various severity levels.
@@ -1,3 +1,5 @@
1
+ > Discover all available pages from the documentation index: https://mastra.ai/llms.txt
2
+
1
3
  # API reference
2
4
 
3
5
  ## Members API
@@ -1,3 +1,5 @@
1
+ > Discover all available pages from the documentation index: https://mastra.ai/llms.txt
2
+
1
3
  # Cloned thread utilities
2
4
 
3
5
  The Memory class provides utility methods for working with cloned threads. These methods help you check clone status, retrieve clone metadata, navigate clone relationships, and track clone history.
@@ -1,3 +1,5 @@
1
+ > Discover all available pages from the documentation index: https://mastra.ai/llms.txt
2
+
1
3
  # Memory.cloneThread()
2
4
 
3
5
  The `.cloneThread()` method creates a copy of an existing conversation thread, including all its messages. This enables creating divergent conversation paths from a specific point in a conversation. When semantic recall is enabled, the method also creates vector embeddings for the cloned messages.
@@ -1,3 +1,5 @@
1
+ > Discover all available pages from the documentation index: https://mastra.ai/llms.txt
2
+
1
3
  # Memory.createThread()
2
4
 
3
5
  The `.createThread()` method creates a new conversation thread in the memory system. Each thread represents a distinct conversation or context and can contain multiple messages.
@@ -1,3 +1,5 @@
1
+ > Discover all available pages from the documentation index: https://mastra.ai/llms.txt
2
+
1
3
  # Memory.deleteMessages()
2
4
 
3
5
  The `.deleteMessages()` method deletes multiple messages by their IDs.
@@ -1,3 +1,5 @@
1
+ > Discover all available pages from the documentation index: https://mastra.ai/llms.txt
2
+
1
3
  # Memory.getThreadById()
2
4
 
3
5
  The `.getThreadById()` method retrieves a specific thread by its ID.
@@ -1,3 +1,5 @@
1
+ > Discover all available pages from the documentation index: https://mastra.ai/llms.txt
2
+
1
3
  # Memory.listThreads()
2
4
 
3
5
  The `listThreads()` method retrieves threads with pagination support and optional filtering by `resourceId`, `metadata`, or both.
@@ -1,3 +1,5 @@
1
+ > Discover all available pages from the documentation index: https://mastra.ai/llms.txt
2
+
1
3
  # Memory class
2
4
 
3
5
  The `Memory` class provides a robust system for managing conversation history and thread-based message storage in Mastra. It enables persistent storage of conversations, semantic search capabilities, and efficient message retrieval. You must configure a storage provider for conversation history, and if you enable semantic recall you will also need to provide a vector store and embedder.
@@ -1,3 +1,5 @@
1
+ > Discover all available pages from the documentation index: https://mastra.ai/llms.txt
2
+
1
3
  # Observational Memory
2
4
 
3
5
  **Added in:** `@mastra/memory@1.1.0`
@@ -1,3 +1,5 @@
1
+ > Discover all available pages from the documentation index: https://mastra.ai/llms.txt
2
+
1
3
  # Memory.recall()
2
4
 
3
5
  the `.recall()` method retrieves messages from a specific thread, with support for pagination, filtering options, and semantic search.
@@ -1,3 +1,5 @@
1
+ > Discover all available pages from the documentation index: https://mastra.ai/llms.txt
2
+
1
3
  # SerializedMemoryConfig
2
4
 
3
5
  `SerializedMemoryConfig` is the JSON-serializable subset of [`Memory`](https://mastra.ai/reference/memory/memory-class) configuration that lives on a stored agent record. The runtime hydrates it back into a `Memory` instance by resolving the vector and embedder IDs against the configured `Mastra` instance.
@@ -1,3 +1,5 @@
1
+ > Discover all available pages from the documentation index: https://mastra.ai/llms.txt
2
+
1
3
  # Automatic metrics reference
2
4
 
3
5
  Mastra automatically extracts performance and usage metrics from traced execution. This page is the complete reference for every metric name, label, and context field that Mastra emits.
@@ -1,3 +1,5 @@
1
+ > Discover all available pages from the documentation index: https://mastra.ai/llms.txt
2
+
1
3
  # DatadogBridge
2
4
 
3
5
  > **Warning:** The Datadog Bridge is currently **experimental**. APIs and configuration options may change in future releases.
@@ -1,3 +1,5 @@
1
+ > Discover all available pages from the documentation index: https://mastra.ai/llms.txt
2
+
1
3
  # OtelBridge
2
4
 
3
5
  > **Warning:** The OpenTelemetry Bridge is currently **experimental**. APIs and configuration options may change in future releases.
@@ -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
  ## `ObservabilityRegistryConfig`
@@ -1,3 +1,5 @@
1
+ > Discover all available pages from the documentation index: https://mastra.ai/llms.txt
2
+
1
3
  # ArizeExporter
2
4
 
3
5
  Sends Tracing data to Arize Phoenix, Arize AX, or any OpenTelemetry-compatible observability platform that supports OpenInference semantic conventions.
@@ -1,3 +1,5 @@
1
+ > Discover all available pages from the documentation index: https://mastra.ai/llms.txt
2
+
1
3
  # ArthurExporter
2
4
 
3
5
  Sends Tracing data to [Arthur Engine](https://github.com/arthur-ai/arthur-engine) using OpenTelemetry and OpenInference semantic conventions.
@@ -1,3 +1,5 @@
1
+ > Discover all available pages from the documentation index: https://mastra.ai/llms.txt
2
+
1
3
  # BraintrustExporter
2
4
 
3
5
  Sends Tracing data to Braintrust for eval and observability.
@@ -1,3 +1,5 @@
1
+ > Discover all available pages from the documentation index: https://mastra.ai/llms.txt
2
+
1
3
  # CloudExporter
2
4
 
3
5
  **Added in:** `@mastra/observability@1.8.0`. **Deprecated in `1.12.0`** in favor of [`MastraPlatformExporter`](https://mastra.ai/reference/observability/tracing/exporters/mastra-platform-exporter).
@@ -1,3 +1,5 @@
1
+ > Discover all available pages from the documentation index: https://mastra.ai/llms.txt
2
+
1
3
  # ConsoleExporter
2
4
 
3
5
  Outputs trace events to the console for debugging and development.
@@ -1,3 +1,5 @@
1
+ > Discover all available pages from the documentation index: https://mastra.ai/llms.txt
2
+
1
3
  # DatadogExporter
2
4
 
3
5
  Sends Tracing data to Datadog's LLM Observability product for monitoring and analytics.
@@ -1,3 +1,5 @@
1
+ > Discover all available pages from the documentation index: https://mastra.ai/llms.txt
2
+
1
3
  # DefaultExporter
2
4
 
3
5
  **Deprecated in `@mastra/observability@1.12.0`** in favor of [`MastraStorageExporter`](https://mastra.ai/reference/observability/tracing/exporters/mastra-storage-exporter).
@@ -1,3 +1,5 @@
1
+ > Discover all available pages from the documentation index: https://mastra.ai/llms.txt
2
+
1
3
  # LaminarExporter
2
4
 
3
5
  Sends Tracing data to Laminar via OTLP/HTTP (protobuf).