@mastra/mcp-docs-server 1.1.9-alpha.0 → 1.1.9-alpha.2

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 (408) hide show
  1. package/.docs/docs/agents/adding-voice.md +4 -4
  2. package/.docs/docs/agents/agent-approval.md +3 -3
  3. package/.docs/docs/agents/agent-memory.md +1 -1
  4. package/.docs/docs/agents/network-approval.md +1 -1
  5. package/.docs/docs/agents/networks.md +1 -1
  6. package/.docs/docs/agents/overview.md +1 -1
  7. package/.docs/docs/agents/processors.md +8 -8
  8. package/.docs/docs/agents/structured-output.md +1 -1
  9. package/.docs/docs/agents/supervisor-agents.md +3 -3
  10. package/.docs/docs/agents/using-tools.md +1 -1
  11. package/.docs/docs/build-with-ai/mcp-docs-server.md +1 -1
  12. package/.docs/docs/build-with-ai/skills.md +1 -1
  13. package/.docs/docs/community/contributing-templates.md +1 -1
  14. package/.docs/docs/community/discord.md +2 -2
  15. package/.docs/docs/community/licensing.md +1 -1
  16. package/.docs/docs/deployment/cloud-providers.md +2 -2
  17. package/.docs/docs/deployment/mastra-server.md +1 -1
  18. package/.docs/docs/deployment/monorepo.md +1 -1
  19. package/.docs/docs/deployment/overview.md +3 -3
  20. package/.docs/docs/deployment/studio.md +1 -1
  21. package/.docs/docs/deployment/web-framework.md +1 -1
  22. package/.docs/docs/deployment/workflow-runners.md +1 -1
  23. package/.docs/docs/evals/built-in-scorers.md +1 -1
  24. package/.docs/docs/evals/custom-scorers.md +6 -6
  25. package/.docs/docs/evals/overview.md +1 -1
  26. package/.docs/docs/evals/running-in-ci.md +6 -6
  27. package/.docs/docs/getting-started/build-with-ai.md +2 -2
  28. package/.docs/docs/getting-started/manual-install.md +1 -1
  29. package/.docs/docs/getting-started/project-structure.md +1 -1
  30. package/.docs/docs/index.md +1 -1
  31. package/.docs/docs/mcp/overview.md +1 -1
  32. package/.docs/docs/mcp/publishing-mcp-server.md +3 -3
  33. package/.docs/docs/memory/memory-processors.md +8 -8
  34. package/.docs/docs/memory/message-history.md +2 -2
  35. package/.docs/docs/memory/observational-memory.md +5 -5
  36. package/.docs/docs/memory/semantic-recall.md +7 -7
  37. package/.docs/docs/memory/working-memory.md +14 -14
  38. package/.docs/docs/observability/datasets/overview.md +1 -1
  39. package/.docs/docs/observability/datasets/running-experiments.md +1 -1
  40. package/.docs/docs/observability/logging.md +1 -1
  41. package/.docs/docs/observability/overview.md +5 -5
  42. package/.docs/docs/observability/tracing/bridges/otel.md +7 -7
  43. package/.docs/docs/observability/tracing/exporters/arize.md +3 -3
  44. package/.docs/docs/observability/tracing/exporters/braintrust.md +1 -1
  45. package/.docs/docs/observability/tracing/exporters/cloud.md +2 -2
  46. package/.docs/docs/observability/tracing/exporters/datadog.md +3 -3
  47. package/.docs/docs/observability/tracing/exporters/default.md +7 -7
  48. package/.docs/docs/observability/tracing/exporters/laminar.md +1 -1
  49. package/.docs/docs/observability/tracing/exporters/langfuse.md +3 -3
  50. package/.docs/docs/observability/tracing/exporters/langsmith.md +4 -4
  51. package/.docs/docs/observability/tracing/exporters/otel.md +8 -8
  52. package/.docs/docs/observability/tracing/exporters/posthog.md +2 -2
  53. package/.docs/docs/observability/tracing/exporters/sentry.md +4 -4
  54. package/.docs/docs/observability/tracing/overview.md +20 -20
  55. package/.docs/docs/observability/tracing/processors/sensitive-data-filter.md +11 -11
  56. package/.docs/docs/rag/chunking-and-embedding.md +4 -4
  57. package/.docs/docs/rag/overview.md +2 -2
  58. package/.docs/docs/rag/retrieval.md +4 -4
  59. package/.docs/docs/rag/vector-databases.md +11 -11
  60. package/.docs/docs/server/auth/auth0.md +1 -1
  61. package/.docs/docs/server/auth/clerk.md +1 -1
  62. package/.docs/docs/server/auth/composite-auth.md +9 -9
  63. package/.docs/docs/server/auth/custom-auth-provider.md +12 -12
  64. package/.docs/docs/server/auth/firebase.md +2 -2
  65. package/.docs/docs/server/auth/jwt.md +1 -1
  66. package/.docs/docs/server/auth/simple-auth.md +8 -8
  67. package/.docs/docs/server/auth/supabase.md +1 -1
  68. package/.docs/docs/server/auth/workos.md +1 -1
  69. package/.docs/docs/server/auth.md +1 -1
  70. package/.docs/docs/server/custom-adapters.md +7 -7
  71. package/.docs/docs/server/custom-api-routes.md +2 -2
  72. package/.docs/docs/server/mastra-client.md +1 -1
  73. package/.docs/docs/server/mastra-server.md +1 -1
  74. package/.docs/docs/server/request-context.md +2 -2
  75. package/.docs/docs/server/server-adapters.md +1 -1
  76. package/.docs/docs/streaming/events.md +1 -1
  77. package/.docs/docs/streaming/overview.md +1 -1
  78. package/.docs/docs/streaming/tool-streaming.md +2 -2
  79. package/.docs/docs/voice/overview.md +3 -3
  80. package/.docs/docs/voice/speech-to-speech.md +1 -1
  81. package/.docs/docs/voice/speech-to-text.md +2 -2
  82. package/.docs/docs/voice/text-to-speech.md +2 -2
  83. package/.docs/docs/workflows/agents-and-tools.md +1 -1
  84. package/.docs/docs/workflows/control-flow.md +1 -1
  85. package/.docs/docs/workflows/error-handling.md +3 -3
  86. package/.docs/docs/workflows/suspend-and-resume.md +1 -1
  87. package/.docs/docs/workflows/time-travel.md +1 -1
  88. package/.docs/docs/workflows/workflow-state.md +1 -1
  89. package/.docs/docs/workspace/filesystem.md +1 -1
  90. package/.docs/docs/workspace/overview.md +1 -1
  91. package/.docs/docs/workspace/search.md +1 -1
  92. package/.docs/docs/workspace/skills.md +2 -2
  93. package/.docs/guides/build-your-ui/ai-sdk-ui.md +2 -2
  94. package/.docs/guides/build-your-ui/assistant-ui.md +1 -1
  95. package/.docs/guides/build-your-ui/copilotkit.md +1 -1
  96. package/.docs/guides/deployment/digital-ocean.md +1 -1
  97. package/.docs/guides/getting-started/astro.md +1 -1
  98. package/.docs/guides/getting-started/electron.md +1 -1
  99. package/.docs/guides/getting-started/next-js.md +1 -1
  100. package/.docs/guides/getting-started/vite-react.md +1 -1
  101. package/.docs/guides/guide/ai-recruiter.md +3 -3
  102. package/.docs/guides/guide/chef-michel.md +4 -4
  103. package/.docs/guides/guide/code-review-bot.md +3 -3
  104. package/.docs/guides/guide/dev-assistant.md +5 -5
  105. package/.docs/guides/guide/docs-manager.md +3 -3
  106. package/.docs/guides/guide/github-actions-pr-description.md +2 -2
  107. package/.docs/guides/guide/notes-mcp-server.md +3 -3
  108. package/.docs/guides/guide/research-assistant.md +4 -4
  109. package/.docs/guides/guide/research-coordinator.md +1 -1
  110. package/.docs/guides/guide/stock-agent.md +4 -4
  111. package/.docs/guides/guide/web-search.md +2 -2
  112. package/.docs/guides/guide/whatsapp-chat-bot.md +1 -1
  113. package/.docs/guides/migrations/ai-sdk-v4-to-v5.md +3 -3
  114. package/.docs/guides/migrations/network-to-supervisor.md +1 -1
  115. package/.docs/guides/migrations/upgrade-to-v1/agent.md +1 -1
  116. package/.docs/guides/migrations/upgrade-to-v1/deployment.md +1 -1
  117. package/.docs/guides/migrations/upgrade-to-v1/evals.md +1 -1
  118. package/.docs/guides/migrations/upgrade-to-v1/mastra.md +1 -1
  119. package/.docs/guides/migrations/upgrade-to-v1/overview.md +3 -3
  120. package/.docs/guides/migrations/upgrade-to-v1/storage.md +3 -3
  121. package/.docs/guides/migrations/upgrade-to-v1/tracing.md +2 -2
  122. package/.docs/guides/migrations/upgrade-to-v1/vectors.md +3 -3
  123. package/.docs/guides/migrations/upgrade-to-v1/voice.md +1 -1
  124. package/.docs/guides/migrations/upgrade-to-v1/workflows.md +1 -1
  125. package/.docs/guides/migrations/vnext-to-standard-apis.md +1 -1
  126. package/.docs/models/embeddings.md +4 -4
  127. package/.docs/models/gateways/custom-gateways.md +4 -4
  128. package/.docs/models/gateways/netlify.md +1 -1
  129. package/.docs/models/gateways/openrouter.md +1 -1
  130. package/.docs/models/gateways/vercel.md +9 -2
  131. package/.docs/models/gateways.md +2 -2
  132. package/.docs/models/index.md +1 -1
  133. package/.docs/models/providers/302ai.md +3 -3
  134. package/.docs/models/providers/abacus.md +3 -3
  135. package/.docs/models/providers/aihubmix.md +3 -3
  136. package/.docs/models/providers/alibaba-cn.md +3 -3
  137. package/.docs/models/providers/alibaba-coding-plan-cn.md +3 -3
  138. package/.docs/models/providers/alibaba-coding-plan.md +3 -3
  139. package/.docs/models/providers/alibaba.md +3 -3
  140. package/.docs/models/providers/anthropic.md +4 -4
  141. package/.docs/models/providers/bailing.md +3 -3
  142. package/.docs/models/providers/baseten.md +3 -3
  143. package/.docs/models/providers/berget.md +3 -3
  144. package/.docs/models/providers/cerebras.md +4 -4
  145. package/.docs/models/providers/chutes.md +6 -5
  146. package/.docs/models/providers/clarifai.md +3 -3
  147. package/.docs/models/providers/cloudferro-sherlock.md +3 -3
  148. package/.docs/models/providers/cloudflare-workers-ai.md +3 -3
  149. package/.docs/models/providers/cortecs.md +3 -3
  150. package/.docs/models/providers/deepinfra.md +4 -4
  151. package/.docs/models/providers/deepseek.md +3 -3
  152. package/.docs/models/providers/drun.md +3 -3
  153. package/.docs/models/providers/evroc.md +3 -3
  154. package/.docs/models/providers/fastrouter.md +3 -3
  155. package/.docs/models/providers/fireworks-ai.md +3 -3
  156. package/.docs/models/providers/firmware.md +3 -3
  157. package/.docs/models/providers/friendli.md +3 -3
  158. package/.docs/models/providers/github-models.md +3 -3
  159. package/.docs/models/providers/google.md +4 -4
  160. package/.docs/models/providers/groq.md +4 -4
  161. package/.docs/models/providers/helicone.md +3 -3
  162. package/.docs/models/providers/huggingface.md +3 -3
  163. package/.docs/models/providers/iflowcn.md +3 -3
  164. package/.docs/models/providers/inception.md +3 -3
  165. package/.docs/models/providers/inference.md +3 -3
  166. package/.docs/models/providers/io-net.md +3 -3
  167. package/.docs/models/providers/jiekou.md +3 -3
  168. package/.docs/models/providers/kilo.md +3 -3
  169. package/.docs/models/providers/kimi-for-coding.md +4 -4
  170. package/.docs/models/providers/kuae-cloud-coding-plan.md +3 -3
  171. package/.docs/models/providers/llama.md +3 -3
  172. package/.docs/models/providers/lmstudio.md +3 -3
  173. package/.docs/models/providers/lucidquery.md +3 -3
  174. package/.docs/models/providers/meganova.md +3 -3
  175. package/.docs/models/providers/minimax-cn-coding-plan.md +4 -4
  176. package/.docs/models/providers/minimax-cn.md +4 -4
  177. package/.docs/models/providers/minimax-coding-plan.md +4 -4
  178. package/.docs/models/providers/minimax.md +4 -4
  179. package/.docs/models/providers/mistral.md +4 -4
  180. package/.docs/models/providers/moark.md +3 -3
  181. package/.docs/models/providers/modelscope.md +3 -3
  182. package/.docs/models/providers/moonshotai-cn.md +3 -3
  183. package/.docs/models/providers/moonshotai.md +3 -3
  184. package/.docs/models/providers/morph.md +3 -3
  185. package/.docs/models/providers/nano-gpt.md +25 -23
  186. package/.docs/models/providers/nebius.md +3 -3
  187. package/.docs/models/providers/nova.md +3 -3
  188. package/.docs/models/providers/novita-ai.md +3 -3
  189. package/.docs/models/providers/nvidia.md +3 -3
  190. package/.docs/models/providers/ollama-cloud.md +3 -3
  191. package/.docs/models/providers/openai.md +4 -4
  192. package/.docs/models/providers/opencode-go.md +3 -3
  193. package/.docs/models/providers/opencode.md +3 -3
  194. package/.docs/models/providers/ovhcloud.md +3 -3
  195. package/.docs/models/providers/perplexity-agent.md +4 -4
  196. package/.docs/models/providers/perplexity.md +4 -4
  197. package/.docs/models/providers/poe.md +3 -3
  198. package/.docs/models/providers/privatemode-ai.md +3 -3
  199. package/.docs/models/providers/qihang-ai.md +3 -3
  200. package/.docs/models/providers/qiniu-ai.md +3 -3
  201. package/.docs/models/providers/requesty.md +3 -3
  202. package/.docs/models/providers/scaleway.md +3 -3
  203. package/.docs/models/providers/siliconflow-cn.md +3 -3
  204. package/.docs/models/providers/siliconflow.md +3 -3
  205. package/.docs/models/providers/stackit.md +3 -3
  206. package/.docs/models/providers/stepfun.md +3 -3
  207. package/.docs/models/providers/submodel.md +3 -3
  208. package/.docs/models/providers/synthetic.md +3 -3
  209. package/.docs/models/providers/togetherai.md +4 -4
  210. package/.docs/models/providers/upstage.md +3 -3
  211. package/.docs/models/providers/vivgrid.md +4 -4
  212. package/.docs/models/providers/vultr.md +3 -3
  213. package/.docs/models/providers/wandb.md +3 -3
  214. package/.docs/models/providers/xai.md +4 -4
  215. package/.docs/models/providers/xiaomi.md +3 -3
  216. package/.docs/models/providers/zai-coding-plan.md +3 -3
  217. package/.docs/models/providers/zai.md +3 -3
  218. package/.docs/models/providers/zenmux.md +4 -4
  219. package/.docs/models/providers/zhipuai-coding-plan.md +3 -3
  220. package/.docs/models/providers/zhipuai.md +3 -3
  221. package/.docs/reference/agents/agent.md +3 -3
  222. package/.docs/reference/agents/generateLegacy.md +1 -1
  223. package/.docs/reference/agents/network.md +2 -2
  224. package/.docs/reference/ai-sdk/to-ai-sdk-stream.md +1 -1
  225. package/.docs/reference/auth/auth0.md +4 -4
  226. package/.docs/reference/auth/better-auth.md +2 -2
  227. package/.docs/reference/auth/clerk.md +1 -1
  228. package/.docs/reference/auth/firebase.md +4 -4
  229. package/.docs/reference/auth/jwt.md +1 -1
  230. package/.docs/reference/auth/supabase.md +1 -1
  231. package/.docs/reference/auth/workos.md +4 -4
  232. package/.docs/reference/cli/mastra.md +1 -1
  233. package/.docs/reference/client-js/agents.md +22 -22
  234. package/.docs/reference/client-js/error-handling.md +2 -2
  235. package/.docs/reference/client-js/logs.md +2 -2
  236. package/.docs/reference/client-js/mastra-client.md +1 -1
  237. package/.docs/reference/client-js/memory.md +6 -6
  238. package/.docs/reference/client-js/observability.md +4 -4
  239. package/.docs/reference/client-js/telemetry.md +1 -1
  240. package/.docs/reference/client-js/tools.md +3 -3
  241. package/.docs/reference/client-js/vectors.md +2 -2
  242. package/.docs/reference/client-js/workflows.md +12 -12
  243. package/.docs/reference/core/getGatewayById.md +1 -1
  244. package/.docs/reference/core/getMCPServer.md +2 -2
  245. package/.docs/reference/core/getMCPServerById.md +2 -2
  246. package/.docs/reference/core/getMemory.md +1 -1
  247. package/.docs/reference/core/getScorer.md +2 -2
  248. package/.docs/reference/core/getScorerById.md +2 -2
  249. package/.docs/reference/core/getStoredAgentById.md +2 -2
  250. package/.docs/reference/core/listMCPServers.md +2 -2
  251. package/.docs/reference/core/listMemory.md +1 -1
  252. package/.docs/reference/core/listScorers.md +1 -1
  253. package/.docs/reference/core/listStoredAgents.md +2 -2
  254. package/.docs/reference/core/mastra-class.md +1 -1
  255. package/.docs/reference/core/mastra-model-gateway.md +11 -11
  256. package/.docs/reference/datasets/dataset.md +1 -1
  257. package/.docs/reference/deployer.md +4 -4
  258. package/.docs/reference/evals/answer-relevancy.md +3 -3
  259. package/.docs/reference/evals/answer-similarity.md +3 -3
  260. package/.docs/reference/evals/bias.md +4 -4
  261. package/.docs/reference/evals/completeness.md +5 -5
  262. package/.docs/reference/evals/content-similarity.md +3 -3
  263. package/.docs/reference/evals/context-precision.md +6 -6
  264. package/.docs/reference/evals/context-relevance.md +6 -6
  265. package/.docs/reference/evals/create-scorer.md +7 -7
  266. package/.docs/reference/evals/faithfulness.md +3 -3
  267. package/.docs/reference/evals/hallucination.md +5 -5
  268. package/.docs/reference/evals/keyword-coverage.md +3 -3
  269. package/.docs/reference/evals/mastra-scorer.md +6 -6
  270. package/.docs/reference/evals/noise-sensitivity.md +9 -9
  271. package/.docs/reference/evals/prompt-alignment.md +5 -5
  272. package/.docs/reference/evals/run-evals.md +5 -5
  273. package/.docs/reference/evals/scorer-utils.md +17 -17
  274. package/.docs/reference/evals/textual-difference.md +3 -3
  275. package/.docs/reference/evals/tone-consistency.md +4 -4
  276. package/.docs/reference/evals/tool-call-accuracy.md +9 -9
  277. package/.docs/reference/evals/toxicity.md +3 -3
  278. package/.docs/reference/harness/harness-class.md +1 -1
  279. package/.docs/reference/memory/clone-utilities.md +7 -7
  280. package/.docs/reference/memory/cloneThread.md +4 -4
  281. package/.docs/reference/memory/createThread.md +1 -1
  282. package/.docs/reference/memory/deleteMessages.md +1 -1
  283. package/.docs/reference/memory/getThreadById.md +1 -1
  284. package/.docs/reference/memory/listThreads.md +3 -3
  285. package/.docs/reference/memory/memory-class.md +1 -1
  286. package/.docs/reference/memory/observational-memory.md +1 -1
  287. package/.docs/reference/memory/recall.md +1 -1
  288. package/.docs/reference/observability/tracing/bridges/otel.md +5 -5
  289. package/.docs/reference/observability/tracing/configuration.md +17 -17
  290. package/.docs/reference/observability/tracing/exporters/arize.md +4 -4
  291. package/.docs/reference/observability/tracing/exporters/braintrust.md +3 -3
  292. package/.docs/reference/observability/tracing/exporters/cloud-exporter.md +6 -6
  293. package/.docs/reference/observability/tracing/exporters/console-exporter.md +4 -4
  294. package/.docs/reference/observability/tracing/exporters/datadog.md +4 -4
  295. package/.docs/reference/observability/tracing/exporters/default-exporter.md +6 -6
  296. package/.docs/reference/observability/tracing/exporters/laminar.md +2 -2
  297. package/.docs/reference/observability/tracing/exporters/langfuse.md +4 -4
  298. package/.docs/reference/observability/tracing/exporters/langsmith.md +6 -6
  299. package/.docs/reference/observability/tracing/exporters/otel.md +12 -12
  300. package/.docs/reference/observability/tracing/exporters/posthog.md +3 -3
  301. package/.docs/reference/observability/tracing/exporters/sentry.md +5 -5
  302. package/.docs/reference/observability/tracing/instances.md +9 -9
  303. package/.docs/reference/observability/tracing/interfaces.md +39 -39
  304. package/.docs/reference/observability/tracing/processors/sensitive-data-filter.md +5 -5
  305. package/.docs/reference/observability/tracing/spans.md +13 -13
  306. package/.docs/reference/processors/processor-interface.md +15 -15
  307. package/.docs/reference/rag/chunk.md +2 -2
  308. package/.docs/reference/rag/database-config.md +8 -8
  309. package/.docs/reference/rag/document.md +11 -11
  310. package/.docs/reference/rag/embeddings.md +5 -5
  311. package/.docs/reference/rag/extract-params.md +8 -8
  312. package/.docs/reference/rag/graph-rag.md +4 -4
  313. package/.docs/reference/rag/metadata-filters.md +5 -5
  314. package/.docs/reference/rag/rerank.md +2 -2
  315. package/.docs/reference/rag/rerankWithScorer.md +2 -2
  316. package/.docs/reference/server/express-adapter.md +1 -1
  317. package/.docs/reference/server/fastify-adapter.md +1 -1
  318. package/.docs/reference/server/hono-adapter.md +1 -1
  319. package/.docs/reference/server/koa-adapter.md +1 -1
  320. package/.docs/reference/server/mastra-server.md +16 -16
  321. package/.docs/reference/server/register-api-route.md +5 -5
  322. package/.docs/reference/server/routes.md +1 -1
  323. package/.docs/reference/storage/cloudflare-d1.md +2 -2
  324. package/.docs/reference/storage/cloudflare.md +2 -2
  325. package/.docs/reference/storage/composite.md +1 -1
  326. package/.docs/reference/storage/convex.md +5 -5
  327. package/.docs/reference/storage/dynamodb.md +5 -5
  328. package/.docs/reference/storage/lance.md +3 -3
  329. package/.docs/reference/storage/libsql.md +1 -1
  330. package/.docs/reference/storage/mongodb.md +5 -5
  331. package/.docs/reference/storage/mssql.md +3 -3
  332. package/.docs/reference/storage/overview.md +2 -2
  333. package/.docs/reference/storage/postgresql.md +5 -5
  334. package/.docs/reference/storage/upstash.md +3 -3
  335. package/.docs/reference/streaming/ChunkType.md +13 -13
  336. package/.docs/reference/streaming/agents/MastraModelOutput.md +6 -6
  337. package/.docs/reference/streaming/agents/stream.md +2 -2
  338. package/.docs/reference/streaming/agents/streamLegacy.md +1 -1
  339. package/.docs/reference/streaming/workflows/observeStream.md +1 -1
  340. package/.docs/reference/streaming/workflows/resumeStream.md +1 -1
  341. package/.docs/reference/streaming/workflows/stream.md +1 -1
  342. package/.docs/reference/templates/overview.md +3 -3
  343. package/.docs/reference/tools/create-tool.md +9 -9
  344. package/.docs/reference/tools/document-chunker-tool.md +4 -4
  345. package/.docs/reference/tools/graph-rag-tool.md +7 -7
  346. package/.docs/reference/tools/mcp-client.md +13 -13
  347. package/.docs/reference/tools/mcp-server.md +23 -23
  348. package/.docs/reference/tools/vector-query-tool.md +12 -12
  349. package/.docs/reference/vectors/astra.md +13 -13
  350. package/.docs/reference/vectors/chroma.md +16 -16
  351. package/.docs/reference/vectors/convex.md +15 -15
  352. package/.docs/reference/vectors/couchbase.md +15 -15
  353. package/.docs/reference/vectors/duckdb.md +17 -17
  354. package/.docs/reference/vectors/elasticsearch.md +14 -14
  355. package/.docs/reference/vectors/lance.md +22 -22
  356. package/.docs/reference/vectors/libsql.md +15 -15
  357. package/.docs/reference/vectors/mongodb.md +18 -18
  358. package/.docs/reference/vectors/opensearch.md +11 -11
  359. package/.docs/reference/vectors/pg.md +21 -21
  360. package/.docs/reference/vectors/pinecone.md +15 -15
  361. package/.docs/reference/vectors/qdrant.md +15 -15
  362. package/.docs/reference/vectors/s3vectors.md +17 -17
  363. package/.docs/reference/vectors/turbopuffer.md +14 -14
  364. package/.docs/reference/vectors/upstash.md +15 -15
  365. package/.docs/reference/vectors/vectorize.md +16 -16
  366. package/.docs/reference/voice/azure.md +8 -8
  367. package/.docs/reference/voice/cloudflare.md +5 -5
  368. package/.docs/reference/voice/composite-voice.md +5 -5
  369. package/.docs/reference/voice/deepgram.md +5 -5
  370. package/.docs/reference/voice/elevenlabs.md +6 -6
  371. package/.docs/reference/voice/google-gemini-live.md +20 -20
  372. package/.docs/reference/voice/google.md +9 -9
  373. package/.docs/reference/voice/mastra-voice.md +17 -17
  374. package/.docs/reference/voice/murf.md +6 -6
  375. package/.docs/reference/voice/openai-realtime.md +16 -16
  376. package/.docs/reference/voice/openai.md +5 -5
  377. package/.docs/reference/voice/playai.md +5 -5
  378. package/.docs/reference/voice/sarvam.md +5 -5
  379. package/.docs/reference/voice/speechify.md +5 -5
  380. package/.docs/reference/voice/voice.addInstructions.md +2 -2
  381. package/.docs/reference/voice/voice.addTools.md +2 -2
  382. package/.docs/reference/voice/voice.answer.md +2 -2
  383. package/.docs/reference/voice/voice.close.md +2 -2
  384. package/.docs/reference/voice/voice.connect.md +5 -5
  385. package/.docs/reference/voice/voice.events.md +2 -2
  386. package/.docs/reference/voice/voice.getSpeakers.md +3 -3
  387. package/.docs/reference/voice/voice.listen.md +6 -6
  388. package/.docs/reference/voice/voice.off.md +2 -2
  389. package/.docs/reference/voice/voice.on.md +3 -3
  390. package/.docs/reference/voice/voice.send.md +2 -2
  391. package/.docs/reference/voice/voice.speak.md +5 -5
  392. package/.docs/reference/voice/voice.updateConfig.md +3 -3
  393. package/.docs/reference/workflows/run-methods/startAsync.md +1 -1
  394. package/.docs/reference/workflows/run.md +3 -3
  395. package/.docs/reference/workflows/step.md +2 -2
  396. package/.docs/reference/workflows/workflow-methods/create-run.md +1 -1
  397. package/.docs/reference/workflows/workflow.md +1 -1
  398. package/.docs/reference/workspace/daytona-sandbox.md +2 -2
  399. package/.docs/reference/workspace/e2b-sandbox.md +2 -2
  400. package/.docs/reference/workspace/filesystem.md +1 -1
  401. package/.docs/reference/workspace/gcs-filesystem.md +1 -1
  402. package/.docs/reference/workspace/local-filesystem.md +1 -1
  403. package/.docs/reference/workspace/local-sandbox.md +4 -4
  404. package/.docs/reference/workspace/process-manager.md +2 -2
  405. package/.docs/reference/workspace/s3-filesystem.md +1 -1
  406. package/.docs/reference/workspace/workspace-class.md +2 -2
  407. package/CHANGELOG.md +14 -0
  408. package/package.json +4 -4
@@ -1,8 +1,8 @@
1
- # SimpleAuth Class
1
+ # SimpleAuth class
2
2
 
3
3
  The `SimpleAuth` class provides token-based authentication using a basic token-to-user mapping. It's included in `@mastra/core/server` and is useful for development, testing, and basic API key authentication scenarios.
4
4
 
5
- ## Use Cases
5
+ ## Use cases
6
6
 
7
7
  - Local development and testing
8
8
  - Simple API key authentication
@@ -17,7 +17,7 @@ SimpleAuth is included in `@mastra/core`, no additional packages required.
17
17
  import { SimpleAuth } from '@mastra/core/server'
18
18
  ```
19
19
 
20
- ## Usage Example
20
+ ## Usage example
21
21
 
22
22
  ```typescript
23
23
  import { Mastra } from '@mastra/core'
@@ -50,7 +50,7 @@ export const mastra = new Mastra({
50
50
  })
51
51
  ```
52
52
 
53
- ## Configuration Options
53
+ ## Configuration options
54
54
 
55
55
  | Option | Type | Required | Description |
56
56
  | --------------- | ---------------------------- | -------- | -------------------------------------- |
@@ -79,7 +79,7 @@ new SimpleAuth({
79
79
  })
80
80
  ```
81
81
 
82
- ## Making Authenticated Requests
82
+ ## Making authenticated requests
83
83
 
84
84
  Include your token in the `Authorization` header:
85
85
 
@@ -99,7 +99,7 @@ curl -X POST http://localhost:4111/api/agents/myAgent/generate \
99
99
  -d '{"messages": "Hello"}'
100
100
  ```
101
101
 
102
- ## Custom Authorization
102
+ ## Custom authorization
103
103
 
104
104
  Add role-based or custom authorization logic:
105
105
 
@@ -119,7 +119,7 @@ new SimpleAuth<User>({
119
119
  })
120
120
  ```
121
121
 
122
- ## Environment Variables
122
+ ## Environment variables
123
123
 
124
124
  For production-like setups, load tokens from environment variables:
125
125
 
@@ -144,7 +144,7 @@ export const mastra = new Mastra({
144
144
  })
145
145
  ```
146
146
 
147
- ## With MastraClient
147
+ ## With `MastraClient`
148
148
 
149
149
  Configure the client with your token:
150
150
 
@@ -1,4 +1,4 @@
1
- # MastraAuthSupabase Class
1
+ # MastraAuthSupabase class
2
2
 
3
3
  The `MastraAuthSupabase` class provides authentication for Mastra using Supabase Auth. It verifies incoming requests using Supabase's authentication system and integrates with the Mastra server using the `auth` option.
4
4
 
@@ -1,4 +1,4 @@
1
- # MastraAuthWorkos Class
1
+ # MastraAuthWorkos class
2
2
 
3
3
  The `MastraAuthWorkos` class provides authentication for Mastra using WorkOS. It verifies incoming requests using WorkOS access tokens and integrates with the Mastra server using the `auth` option.
4
4
 
@@ -1,4 +1,4 @@
1
- # Auth Overview
1
+ # Auth overview
2
2
 
3
3
  Mastra lets you choose how you handle authentication, so you can secure access to your application's endpoints using the identity system that fits your stack.
4
4
 
@@ -1,4 +1,4 @@
1
- # Custom Adapters
1
+ # Custom adapters
2
2
 
3
3
  Create a custom adapter when you need to run Mastra with a framework other than Hono or Express. This might be necessary if you have specific request/response handling requirements that `@mastra/hono` and `@mastra/express` don't support.
4
4
 
@@ -38,7 +38,7 @@ These type parameters ensure type safety throughout your adapter implementation
38
38
 
39
39
  You must implement these six abstract methods. Each handles a specific part of the request lifecycle, from attaching context to sending responses.
40
40
 
41
- ### registerContextMiddleware()
41
+ ### `registerContextMiddleware()`
42
42
 
43
43
  This method runs first and attaches Mastra context to every incoming request. Route handlers need access to the Mastra instance, tools, and other context to function. How you attach this context depends on your framework — Express uses `res.locals`, Hono uses `c.set()`, and other frameworks have their own patterns.
44
44
 
@@ -65,7 +65,7 @@ Context to attach:
65
65
  | `abortSignal` | `AbortSignal` | Request cancellation signal |
66
66
  | `taskStore` | `InMemoryTaskStore` | A2A task storage (if configured) |
67
67
 
68
- ### registerAuthMiddleware()
68
+ ### `registerAuthMiddleware()`
69
69
 
70
70
  Register authentication and authorization middleware. This method should check if authentication is configured on the Mastra instance and skip registration entirely if not. When auth is configured, you'll typically register two middleware functions: one for authentication (validating tokens and setting the user) and one for authorization (checking if the user can access the requested resource).
71
71
 
@@ -101,7 +101,7 @@ registerAuthMiddleware(): void {
101
101
  }
102
102
  ```
103
103
 
104
- ### registerRoute()
104
+ ### `registerRoute()`
105
105
 
106
106
  Register a single route with your framework. This method is called once for each Mastra route during initialization. It receives a `ServerRoute` object containing the path, HTTP method, handler function, and Zod schemas for validation. Your implementation should wire this up to your framework's routing system.
107
107
 
@@ -148,7 +148,7 @@ async registerRoute(
148
148
  }
149
149
  ```
150
150
 
151
- ### getParams()
151
+ ### `getParams()`
152
152
 
153
153
  Extract URL parameters, query parameters, and request body from the incoming request. Different frameworks expose these values in different ways—Express uses `req.params`, `req.query`, and `req.body`, while other frameworks may use different property names or require method calls. This method normalizes the extraction for your framework.
154
154
 
@@ -172,7 +172,7 @@ async getParams(
172
172
  }
173
173
  ```
174
174
 
175
- ### sendResponse()
175
+ ### `sendResponse()`
176
176
 
177
177
  Send the response back to the client based on the route's response type. Mastra routes can return different response types: JSON for most API responses, streams for agent generation, and special types for MCP transports. Your implementation should handle each type appropriately for your framework.
178
178
 
@@ -207,7 +207,7 @@ async sendResponse(
207
207
  }
208
208
  ```
209
209
 
210
- ### stream()
210
+ ### `stream()`
211
211
 
212
212
  Handle streaming responses for agent generation. When an agent generates a response, it produces a stream of chunks that should be sent to the client as they become available. This method reads from the stream, optionally applies redaction to hide sensitive data, and writes chunks to the response in the appropriate format (SSE or newline-delimited JSON).
213
213
 
@@ -1,4 +1,4 @@
1
- # Custom API Routes
1
+ # Custom API routes
2
2
 
3
3
  By default, Mastra automatically exposes registered agents and workflows via its server. For additional behavior you can define your own HTTP routes.
4
4
 
@@ -61,7 +61,7 @@ export const mastra = new Mastra({
61
61
  })
62
62
  ```
63
63
 
64
- ## OpenAPI Documentation
64
+ ## OpenAPI documentation
65
65
 
66
66
  Custom routes can include OpenAPI metadata to appear in the Swagger UI alongside Mastra server routes. Pass an `openapi` option with standard OpenAPI operation fields.
67
67
 
@@ -1,4 +1,4 @@
1
- # Mastra Client SDK
1
+ # Mastra client SDK
2
2
 
3
3
  The Mastra Client SDK provides a concise and type-safe interface for interacting with your [Mastra Server](https://mastra.ai/docs/server/mastra-server) from your client environment.
4
4
 
@@ -1,4 +1,4 @@
1
- # Server Overview
1
+ # Server overview
2
2
 
3
3
  Mastra runs as an HTTP server that exposes your agents, workflows, and other functionality as API endpoints. The server handles request routing, middleware execution, authentication, and streaming responses.
4
4
 
@@ -1,4 +1,4 @@
1
- # Request Context
1
+ # Request context
2
2
 
3
3
  Agents, tools, and workflows can all accept `RequestContext` as a parameter, making request-specific values available to the underlying primitives.
4
4
 
@@ -6,7 +6,7 @@ Agents, tools, and workflows can all accept `RequestContext` as a parameter, mak
6
6
 
7
7
  Use `RequestContext` when a primitive's behavior should change based on runtime conditions. For example, you might switch models or storage backends based on user attributes, or adjust instructions and tool selection based on language.
8
8
 
9
- > **Note:** **Note:** `RequestContext` is primarily used for passing data into specific requests. It's distinct from agent memory, which handles conversation history and state persistence across multiple calls.
9
+ > **Note:** `RequestContext` is primarily used for passing data into specific requests. It's distinct from agent memory, which handles conversation history and state persistence across multiple calls.
10
10
 
11
11
  ## Setting values
12
12
 
@@ -1,4 +1,4 @@
1
- # Server Adapters
1
+ # Server adapters
2
2
 
3
3
  Server adapters let you run Mastra with your own HTTP server instead of the Hono server generated by `mastra build`. They provide more control over the server setup, including custom middleware ordering, authentication, logging, and deployment configuration. You can still integrate Mastra into any Node.js application without changing how agents or workflows execute.
4
4
 
@@ -1,4 +1,4 @@
1
- # Streaming Events
1
+ # Streaming events
2
2
 
3
3
  Streaming from agents or workflows provides real-time visibility into either the LLM’s output or the status of a workflow run. This feedback can be passed directly to the user, or used within applications to handle workflow status more effectively, creating a smoother and more responsive experience.
4
4
 
@@ -1,4 +1,4 @@
1
- # Streaming Overview
1
+ # Streaming overview
2
2
 
3
3
  Mastra supports real-time, incremental responses from agents and workflows, allowing users to see output as it’s generated instead of waiting for completion. This is useful for chat, long-form content, multi-step workflows, or any scenario where immediate feedback matters.
4
4
 
@@ -114,11 +114,11 @@ for await (const chunk of stream) {
114
114
  }
115
115
  ```
116
116
 
117
- ## Tool Lifecycle Hooks
117
+ ## Tool lifecycle hooks
118
118
 
119
119
  Tools support lifecycle hooks that allow you to monitor different stages of tool execution during streaming. These hooks are particularly useful for logging or analytics.
120
120
 
121
- ### Example: Using onInputAvailable and onOutput
121
+ ### Example: Using `onInputAvailable` and `onOutput`
122
122
 
123
123
  ```typescript
124
124
  import { createTool } from '@mastra/core/tools'
@@ -2,7 +2,7 @@
2
2
 
3
3
  Mastra's Voice system provides a unified interface for voice interactions, enabling text-to-speech (TTS), speech-to-text (STT), and real-time speech-to-speech (STS) capabilities in your applications.
4
4
 
5
- ## Adding Voice to Agents
5
+ ## Adding voice to agents
6
6
 
7
7
  To learn how to integrate voice capabilities into your agents, check out the [Adding Voice to Agents](https://mastra.ai/docs/agents/adding-voice) documentation. This section covers how to use both single and multiple voice providers, as well as real-time interactions.
8
8
 
@@ -588,7 +588,7 @@ await voiceAgent.voice.send(micStream)
588
588
 
589
589
  Visit the [Google Gemini Live Reference](https://mastra.ai/reference/voice/google-gemini-live) for more information on the Google Gemini Live voice provider.
590
590
 
591
- ## Voice Configuration
591
+ ## Voice configuration
592
592
 
593
593
  Each voice provider can be configured with different models and options. Below are the detailed configuration options for all supported providers:
594
594
 
@@ -945,7 +945,7 @@ const voice = new CompositeVoice({
945
945
 
946
946
  For more information on the CompositeVoice, refer to the [CompositeVoice Reference](https://mastra.ai/reference/voice/composite-voice).
947
947
 
948
- ## More Resources
948
+ ## More resources
949
949
 
950
950
  - [CompositeVoice](https://mastra.ai/reference/voice/composite-voice)
951
951
  - [MastraVoice](https://mastra.ai/reference/voice/mastra-voice)
@@ -1,4 +1,4 @@
1
- # Speech-to-Speech Capabilities in Mastra
1
+ # Speech-to-Speech capabilities in Mastra
2
2
 
3
3
  ## Introduction
4
4
 
@@ -24,7 +24,7 @@ const voice = new OpenAIVoice({
24
24
  const voice = new OpenAIVoice()
25
25
  ```
26
26
 
27
- ## Available Providers
27
+ ## Available providers
28
28
 
29
29
  Mastra supports several Speech-to-Text providers, each with their own capabilities and strengths:
30
30
 
@@ -42,7 +42,7 @@ Each provider is implemented as a separate package that you can install as neede
42
42
  pnpm add @mastra/voice-openai@latest # Example for OpenAI
43
43
  ```
44
44
 
45
- ## Using the Listen Method
45
+ ## Using the listen method
46
46
 
47
47
  The primary method for STT is the `listen()` method, which converts spoken audio into text. Here's how to use it:
48
48
 
@@ -29,7 +29,7 @@ const voice = new OpenAIVoice({
29
29
  const voice = new OpenAIVoice()
30
30
  ```
31
31
 
32
- ## Available Providers
32
+ ## Available providers
33
33
 
34
34
  Mastra supports a wide range of Text-to-Speech providers, each with their own unique capabilities and voice options. You can choose the provider that best suits your application's needs:
35
35
 
@@ -50,7 +50,7 @@ Each provider is implemented as a separate package that you can install as neede
50
50
  pnpm add @mastra/voice-openai@latest # Example for OpenAI
51
51
  ```
52
52
 
53
- ## Using the Speak Method
53
+ ## Using the speak method
54
54
 
55
55
  The primary method for TTS is the `speak()` method, which converts text to speech. This method can accept options that allows you to specify the speaker and other provider-specific options. Here's how to use it:
56
56
 
@@ -1,4 +1,4 @@
1
- # Agents and Tools
1
+ # Agents and tools
2
2
 
3
3
  Workflow steps can call agents to leverage LLM reasoning or call tools for type-safe logic. You can either invoke them from within a step's `execute` function or compose them directly as steps using `createStep()`.
4
4
 
@@ -1,4 +1,4 @@
1
- # Control Flow
1
+ # Control flow
2
2
 
3
3
  Workflows run a sequence of predefined tasks, and you can control how that flow is executed. Tasks are divided into **steps**, which can be executed in different ways depending on your requirements. They can run sequentially, in parallel, or follow different paths based on conditions.
4
4
 
@@ -1,4 +1,4 @@
1
- # Error Handling
1
+ # Error handling
2
2
 
3
3
  Mastra workflows support error handling through result status checks after execution, retry policies for transient failures, and lifecycle callbacks for centralized error logging or alerting.
4
4
 
@@ -58,7 +58,7 @@ if (result.status === 'failed') {
58
58
 
59
59
  For scenarios where you need to handle workflow completion without awaiting the result—such as background jobs, fire-and-forget workflows, or centralized logging—you can use lifecycle callbacks.
60
60
 
61
- ### onFinish
61
+ ### `onFinish`
62
62
 
63
63
  Called when a workflow completes with any status (success, failed, suspended, or tripwire):
64
64
 
@@ -100,7 +100,7 @@ The `onFinish` callback receives:
100
100
  - `logger` - The workflow's logger instance
101
101
  - `state` - The workflow's current state object
102
102
 
103
- ### onError
103
+ ### `onError`
104
104
 
105
105
  Called only when a workflow fails (status is `'failed'` or `'tripwire'`):
106
106
 
@@ -1,4 +1,4 @@
1
- # Suspend & Resume
1
+ # Suspend and resume
2
2
 
3
3
  Workflows can be paused at any step to collect additional data, wait for API callbacks, throttle costly operations, or request [human-in-the-loop](https://mastra.ai/docs/workflows/human-in-the-loop) input. When a workflow is suspended, its current execution state is saved as a snapshot. You can later resume the workflow from a [specific step ID](https://mastra.ai/docs/workflows/snapshots), restoring the exact state captured in that snapshot. [Snapshots](https://mastra.ai/docs/workflows/snapshots) are stored in your configured storage provider and persist across deployments and application restarts.
4
4
 
@@ -1,4 +1,4 @@
1
- # Time Travel
1
+ # Time travel
2
2
 
3
3
  Time travel allows you to re-execute a workflow starting from any specific step, using either stored snapshot data or custom context you provide. This is useful for debugging failed workflows, testing individual steps with different inputs, or recovering from errors without re-running the entire workflow. You can also use time travel to execute a workflow that hasn't been run yet, starting from any specific step.
4
4
 
@@ -1,4 +1,4 @@
1
- # Workflow State
1
+ # Workflow state
2
2
 
3
3
  Workflow state lets you share values across steps without passing them through every step's inputSchema and outputSchema. This is useful for tracking progress, accumulating results, or sharing configuration across the entire workflow.
4
4
 
@@ -103,7 +103,7 @@ const workspace = new Workspace({
103
103
 
104
104
  When read-only, write tools (`write_file`, `edit_file`, `delete`, `mkdir`) aren't added to the agent's toolset. The agent can still read and list files.
105
105
 
106
- ## Mounts and CompositeFilesystem
106
+ ## Mounts and `CompositeFilesystem`
107
107
 
108
108
  When you use the `mounts` option on a workspace, Mastra creates a `CompositeFilesystem` that routes file operations to the correct provider based on path prefix.
109
109
 
@@ -265,7 +265,7 @@ const workspace = new Workspace({
265
265
  await workspace.init()
266
266
  ```
267
267
 
268
- ### What init() does
268
+ ### What `init()` does
269
269
 
270
270
  Initialization runs setup logic for each configured provider:
271
271
 
@@ -1,4 +1,4 @@
1
- # Search and Indexing
1
+ # Search and indexing
2
2
 
3
3
  **Added in:** `@mastra/core@1.1.0`
4
4
 
@@ -1,4 +1,4 @@
1
- # Workspace Skills
1
+ # Workspace skills
2
2
 
3
3
  **Added in:** `@mastra/core@1.1.0`
4
4
 
@@ -24,7 +24,7 @@ A skill is a folder containing:
24
24
 
25
25
  When skills are configured on a workspace, agents can discover and activate them during conversations.
26
26
 
27
- ## SKILL.md format
27
+ ## `SKILL.md` format
28
28
 
29
29
  Follow the official [skill specification](https://agentskills.io/specification) when creating your skill. Here is an example `SKILL.md` for a code review skill:
30
30
 
@@ -6,7 +6,7 @@
6
6
 
7
7
  > **Tip:** Want to see more examples? Visit Mastra's [**UI Dojo**](https://ui-dojo.mastra.ai/) or the [Next.js quickstart guide](https://mastra.ai/guides/getting-started/next-js).
8
8
 
9
- ## Getting Started
9
+ ## Getting started
10
10
 
11
11
  Use Mastra and AI SDK UI together by installing the `@mastra/ai-sdk` package. `@mastra/ai-sdk` provides custom API routes and utilities for streaming Mastra agents in AI SDK-compatible formats. This includes chat, workflow, and network route handlers, along with utilities and exported types for UI integrations.
12
12
 
@@ -40,7 +40,7 @@ bun add @mastra/ai-sdk@latest @ai-sdk/react ai
40
40
 
41
41
  You're now ready to follow the integration guides and recipes below!
42
42
 
43
- ## Integration Guides
43
+ ## Integration guides
44
44
 
45
45
  Typically, you'll set up API routes that stream Mastra content in AI SDK-compatible format, and then use those routes in AI SDK UI hooks like `useChat()`. Below you'll find two main approaches to achieve this:
46
46
 
@@ -6,7 +6,7 @@
6
6
 
7
7
  > **Tip:** Visit Mastra's [**"UI Dojo"**](https://ui-dojo.mastra.ai/) to see real-world examples of Assistant UI integrated with Mastra.
8
8
 
9
- ## Integration Guide
9
+ ## Integration guide
10
10
 
11
11
  Run Mastra as a standalone server and connect your Next.js frontend (with Assistant UI) to its API endpoints.
12
12
 
@@ -8,7 +8,7 @@ Visit the [CopilotKit documentation](https://docs.copilotkit.ai/) to learn more
8
8
 
9
9
  > **Tip:** Visit Mastra's [**"UI Dojo"**](https://ui-dojo.mastra.ai/) to see real-world examples of CopilotKit integrated with Mastra.
10
10
 
11
- ## Integration Guide
11
+ ## Integration guide
12
12
 
13
13
  Run Mastra as a standalone server and connect your Next.js frontend (with CopilotKit) to its API endpoints.
14
14
 
@@ -10,7 +10,7 @@ You'll need a [Mastra application](https://mastra.ai/guides/getting-started/quic
10
10
 
11
11
  The **App Platform** uses an ephemeral filesystem, so any storage you configure (including observability storage) must be hosted externally. If you're using [LibSQLStore](https://mastra.ai/reference/storage/libsql) with a file URL, switch to a remotely hosted database.
12
12
 
13
- ## App Platform
13
+ ## App platform
14
14
 
15
15
  After setting up your project, push it to your remote Git provider of choice (e.g. GitHub).
16
16
 
@@ -123,7 +123,7 @@ This creates a `src/mastra` folder with an example weather agent and the followi
123
123
 
124
124
  You'll call `weather-agent.ts` from your Astro routes in the next steps.
125
125
 
126
- ## Install AI SDK UI & AI Elements
126
+ ## Install AI SDK UI & AI elements
127
127
 
128
128
  Install AI SDK UI along with the Mastra adapter:
129
129
 
@@ -109,7 +109,7 @@ This creates a `src/mastra` folder with an example weather agent and the followi
109
109
 
110
110
  You'll call `weather-agent.ts` from your chat UI in the next steps.
111
111
 
112
- ## Install AI SDK UI & AI Elements
112
+ ## Install AI SDK UI & AI elements
113
113
 
114
114
  Install AI SDK UI along with the Mastra adapter:
115
115
 
@@ -95,7 +95,7 @@ You'll call `weather-agent.ts` from your Next.js routes in the next steps.
95
95
  >
96
96
  > Relative paths resolve based on each process's working directory, which differs between `next dev` and `mastra dev`.
97
97
 
98
- ## Install AI SDK UI & AI Elements
98
+ ## Install AI SDK UI & AI elements
99
99
 
100
100
  Install AI SDK UI along with the Mastra adapter:
101
101
 
@@ -166,7 +166,7 @@ This creates a `src/mastra` folder with an example weather agent and the followi
166
166
 
167
167
  You'll call `weather-agent.ts` from your chat UI in the next steps.
168
168
 
169
- ## Install AI SDK UI & AI Elements
169
+ ## Install AI SDK UI & AI elements
170
170
 
171
171
  Install AI SDK UI along with the Mastra adapter:
172
172
 
@@ -1,4 +1,4 @@
1
- # Building an AI Recruiter
1
+ # Building an AI recruiter
2
2
 
3
3
  In this guide, you'll learn how Mastra helps you build workflows with LLMs.
4
4
 
@@ -10,7 +10,7 @@ You'll create a workflow that gathers information from a candidate's resume, the
10
10
  - An API key from a supported [Model Provider](https://mastra.ai/models)
11
11
  - An existing Mastra project (Follow the [installation guide](https://mastra.ai/guides/getting-started/quickstart) to set up a new project)
12
12
 
13
- ## Building the Workflow
13
+ ## Building the workflow
14
14
 
15
15
  Set up the Workflow, define steps to extract and classify candidate data, and then ask suitable follow-up questions.
16
16
 
@@ -176,7 +176,7 @@ Set up the Workflow, define steps to extract and classify candidate data, and th
176
176
  })
177
177
  ```
178
178
 
179
- ## Testing the Workflow
179
+ ## Testing the workflow
180
180
 
181
181
  You can test your workflow inside [Studio](https://mastra.ai/docs/getting-started/studio) by starting the development server:
182
182
 
@@ -1,4 +1,4 @@
1
- # Building an AI Chef Assistant
1
+ # How to build an AI chef assistant
2
2
 
3
3
  In this guide, you'll create a "Chef Assistant" agent that helps users cook meals with available ingredients.
4
4
 
@@ -12,7 +12,7 @@ You'll learn how to create the agent and register it with Mastra. Next, you'll i
12
12
  - An API key from a supported [Model Provider](https://mastra.ai/models)
13
13
  - An existing Mastra project (Follow the [installation guide](https://mastra.ai/guides/getting-started/quickstart) to set up a new project)
14
14
 
15
- ## Creating the Agent
15
+ ## Create the agent
16
16
 
17
17
  To create an agent in Mastra use the `Agent` class to define it and then register it with Mastra.
18
18
 
@@ -42,7 +42,7 @@ To create an agent in Mastra use the `Agent` class to define it and then registe
42
42
  })
43
43
  ```
44
44
 
45
- ## Interacting with the Agent
45
+ ## Interact with the agent
46
46
 
47
47
  Depending on your requirements you can interact and get responses from the agent in different formats. In the following steps you'll learn how to generate, stream, and get structured output.
48
48
 
@@ -169,7 +169,7 @@ Depending on your requirements you can interact and get responses from the agent
169
169
  }
170
170
  ```
171
171
 
172
- ## Running the Agent Server
172
+ ## Run the agent server
173
173
 
174
174
  Learn how to interact with your agent through Mastra's API.
175
175
 
@@ -1,4 +1,4 @@
1
- # Building a Code Review Bot
1
+ # Building a code review bot
2
2
 
3
3
  In this guide, you'll build a code review bot that automatically reviews pull requests using workspace skills. The bot loads coding standards from skill files and provides structured feedback. You'll learn how to create a workspace with a skills directory, define an [Agent Skill](https://agentskills.io) with review instructions and reference files, and connect it to an agent that performs automated reviews.
4
4
 
@@ -75,7 +75,7 @@ Inside `workspace/skills/code-standards`, create a `references` folder to hold r
75
75
  - Files: `kebab-case.ts`
76
76
  - Booleans: Start with `is`, `has`, `should`
77
77
 
78
- ## Code Organization
78
+ ## Code organization
79
79
 
80
80
  ```typescript
81
81
  // 1. Imports
@@ -96,7 +96,7 @@ function doSomething() {}
96
96
  export { doSomething }
97
97
  ```
98
98
 
99
- ## Error Handling
99
+ ## Error handling
100
100
 
101
101
  Always handle errors explicitly - never silently catch.
102
102
 
@@ -1,4 +1,4 @@
1
- # Building a Dev Assistant
1
+ # Building a dev assistant
2
2
 
3
3
  In this guide, you'll build a complete development assistant that combines all workspace features:
4
4
 
@@ -123,7 +123,7 @@ description: Project coding standards and testing guidelines
123
123
 
124
124
  # Coding Standards
125
125
 
126
- ## Code Quality
126
+ ## Code quality
127
127
 
128
128
  - Functions under 50 lines
129
129
  - Use descriptive variable names
@@ -135,7 +135,7 @@ description: Project coding standards and testing guidelines
135
135
  - Use AAA pattern: Arrange, Act, Assert
136
136
  - Cover happy paths and edge cases
137
137
 
138
- ## Before Committing
138
+ ## Before committing
139
139
 
140
140
  1. Write implementation
141
141
  2. Write comprehensive tests
@@ -148,7 +148,7 @@ Create a reference file at `workspace/skills/coding-standards/references/testing
148
148
  ````markdown
149
149
  # Testing Guide
150
150
 
151
- ## AAA Pattern
151
+ ## AAA pattern
152
152
 
153
153
  ```typescript
154
154
  it('descriptive test name', () => {
@@ -163,7 +163,7 @@ it('descriptive test name', () => {
163
163
  })
164
164
  ```
165
165
 
166
- ## What to Test
166
+ ## What to test
167
167
 
168
168
  - Happy paths (normal inputs)
169
169
  - Edge cases (empty, null, boundary values)
@@ -1,4 +1,4 @@
1
- # Building a Docs Manager
1
+ # Building a docs manager
2
2
 
3
3
  In this guide, you'll build a documentation manager that maintains your project's docs. It creates well-structured markdown files, keeps documentation organized, and prevents accidental overwrites. You'll learn how to set up a workspace filesystem, create an agent with document management instructions, and use it to generate and update documentation through conversational prompts.
4
4
 
@@ -65,7 +65,7 @@ Quick start guide for the project.
65
65
  npm install example-package
66
66
  ```
67
67
 
68
- ## Quick Example
68
+ ## Quick example
69
69
 
70
70
  ```typescript
71
71
  import { Example } from 'example-package'
@@ -193,7 +193,7 @@ export const authConfig = {
193
193
  }
194
194
  ```
195
195
 
196
- ## Basic Example
196
+ ## Basic example
197
197
 
198
198
  ```typescript
199
199
  import { createAuth } from '@example/auth'