@mastra/mcp-docs-server 1.2.15-alpha.13 → 1.2.15-alpha.19

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 (271) hide show
  1. package/.docs/docs/agents/agent-approval.md +14 -0
  2. package/.docs/docs/agents/code-mode.md +16 -1
  3. package/.docs/docs/agents/processors.md +3 -3
  4. package/.docs/docs/browser/recording.md +2 -2
  5. package/.docs/docs/capabilities/subagents.md +4 -1
  6. package/.docs/docs/datasets/running-experiments.md +49 -0
  7. package/.docs/docs/deployment/workers.md +1 -1
  8. package/.docs/docs/getting-started/develop.md +1 -1
  9. package/.docs/docs/harness/agent-controller.md +43 -2
  10. package/.docs/docs/harness/overview.md +2 -4
  11. package/.docs/docs/long-running-agents/durable-agents.md +1 -1
  12. package/.docs/docs/long-running-agents/goals.md +1 -1
  13. package/.docs/docs/long-running-agents/schedules.md +1 -1
  14. package/.docs/docs/long-running-agents/signal-providers.md +1 -1
  15. package/.docs/docs/long-running-agents/signals.md +1 -1
  16. package/.docs/docs/memory/message-history.md +2 -2
  17. package/.docs/docs/observability/integrations/exporters/mastra-platform.md +1 -1
  18. package/.docs/docs/observability/integrations/exporters/otel.md +2 -2
  19. package/.docs/docs/server/auth/auth0.md +1 -1
  20. package/.docs/docs/server/auth/clerk.md +2 -2
  21. package/.docs/docs/server/auth/firebase.md +1 -1
  22. package/.docs/docs/server/auth/okta.md +24 -4
  23. package/.docs/docs/server/auth/supabase.md +2 -2
  24. package/.docs/docs/server/auth/workers.md +2 -0
  25. package/.docs/docs/server/auth/workos.md +1 -1
  26. package/.docs/docs/server/custom-adapters.md +1 -1
  27. package/.docs/docs/server/mastra-client.md +2 -2
  28. package/.docs/docs/server/mastra-server.md +1 -1
  29. package/.docs/docs/workflows/dynamic-workflows.md +1 -1
  30. package/.docs/docs/workflows/overview.md +1 -1
  31. package/.docs/guides/build-your-ui/ai-sdk-ui.md +3 -3
  32. package/.docs/guides/build-your-ui/assistant-ui.md +1 -1
  33. package/.docs/guides/build-your-ui/copilotkit/channels.md +1 -1
  34. package/.docs/guides/build-your-ui/copilotkit/overview.md +1 -1
  35. package/.docs/guides/deployment/amazon-ec2.md +1 -1
  36. package/.docs/guides/deployment/aws-bedrock-agentcore.md +1 -1
  37. package/.docs/guides/deployment/aws-lambda.md +1 -1
  38. package/.docs/guides/deployment/azure-app-services.md +1 -1
  39. package/.docs/guides/deployment/cloudflare.md +1 -1
  40. package/.docs/guides/deployment/digital-ocean.md +2 -2
  41. package/.docs/guides/deployment/kubernetes.md +2 -2
  42. package/.docs/guides/deployment/mastra-workers.md +3 -1
  43. package/.docs/guides/deployment/netlify.md +2 -2
  44. package/.docs/guides/deployment/vercel.md +1 -1
  45. package/.docs/guides/getting-started/electron.md +2 -2
  46. package/.docs/guides/getting-started/manual-install.md +2 -2
  47. package/.docs/guides/guide/signal-provider.md +1 -1
  48. package/.docs/guides/migrations/mastra-cloud.md +1 -1
  49. package/.docs/models/embeddings.md +1 -1
  50. package/.docs/models/gateways/neon.md +1 -1
  51. package/.docs/models/gateways/netlify.md +1 -1
  52. package/.docs/models/gateways/openrouter.md +1 -1
  53. package/.docs/models/gateways/vercel.md +3 -4
  54. package/.docs/models/index.md +3 -3
  55. package/.docs/models/providers/302ai.md +1 -1
  56. package/.docs/models/providers/abacus.md +1 -1
  57. package/.docs/models/providers/abliteration-ai.md +1 -1
  58. package/.docs/models/providers/agentrouter.md +1 -1
  59. package/.docs/models/providers/ai-router.md +1 -1
  60. package/.docs/models/providers/aiand.md +1 -1
  61. package/.docs/models/providers/aki-io.md +1 -1
  62. package/.docs/models/providers/alibaba-cn.md +1 -1
  63. package/.docs/models/providers/alibaba-coding-plan-cn.md +1 -1
  64. package/.docs/models/providers/alibaba-coding-plan.md +1 -1
  65. package/.docs/models/providers/alibaba-token-plan-cn.md +1 -1
  66. package/.docs/models/providers/alibaba-token-plan.md +1 -1
  67. package/.docs/models/providers/alibaba.md +7 -5
  68. package/.docs/models/providers/ambient.md +1 -1
  69. package/.docs/models/providers/anyapi.md +1 -1
  70. package/.docs/models/providers/atomic-chat.md +1 -1
  71. package/.docs/models/providers/auriko.md +1 -1
  72. package/.docs/models/providers/bailing.md +1 -1
  73. package/.docs/models/providers/baseten.md +1 -1
  74. package/.docs/models/providers/berget.md +1 -1
  75. package/.docs/models/providers/blueclaw.md +1 -1
  76. package/.docs/models/providers/chutes.md +1 -1
  77. package/.docs/models/providers/clarifai.md +1 -1
  78. package/.docs/models/providers/claudinio.md +1 -1
  79. package/.docs/models/providers/cline-pass.md +1 -1
  80. package/.docs/models/providers/cloudferro-sherlock.md +1 -1
  81. package/.docs/models/providers/cloudflare-workers-ai.md +1 -1
  82. package/.docs/models/providers/cortecs.md +2 -3
  83. package/.docs/models/providers/crof.md +1 -1
  84. package/.docs/models/providers/crossmodel.md +2 -3
  85. package/.docs/models/providers/daoxe.md +1 -1
  86. package/.docs/models/providers/databricks.md +1 -1
  87. package/.docs/models/providers/deepinfra.md +1 -1
  88. package/.docs/models/providers/digitalocean.md +3 -3
  89. package/.docs/models/providers/dinference.md +1 -1
  90. package/.docs/models/providers/drun.md +1 -1
  91. package/.docs/models/providers/ebcloud.md +1 -1
  92. package/.docs/models/providers/empiriolabs.md +1 -1
  93. package/.docs/models/providers/evroc.md +1 -1
  94. package/.docs/models/providers/fastrouter.md +1 -1
  95. package/.docs/models/providers/firepass.md +1 -1
  96. package/.docs/models/providers/fireworks-ai.md +1 -1
  97. package/.docs/models/providers/firmware.md +1 -1
  98. package/.docs/models/providers/freemodel.md +1 -1
  99. package/.docs/models/providers/friendli.md +1 -1
  100. package/.docs/models/providers/frogbot.md +1 -1
  101. package/.docs/models/providers/github-models.md +1 -1
  102. package/.docs/models/providers/gmicloud.md +1 -1
  103. package/.docs/models/providers/google.md +1 -1
  104. package/.docs/models/providers/greenpt.md +1 -1
  105. package/.docs/models/providers/helicone.md +1 -1
  106. package/.docs/models/providers/hetzner.md +1 -1
  107. package/.docs/models/providers/hpc-ai.md +1 -1
  108. package/.docs/models/providers/huggingface.md +1 -1
  109. package/.docs/models/providers/hyper.md +1 -1
  110. package/.docs/models/providers/iflowcn.md +1 -1
  111. package/.docs/models/providers/impossibl.md +1 -1
  112. package/.docs/models/providers/inception.md +1 -1
  113. package/.docs/models/providers/inceptron.md +1 -1
  114. package/.docs/models/providers/inference.md +1 -1
  115. package/.docs/models/providers/inferx.md +1 -1
  116. package/.docs/models/providers/infomaniak.md +1 -1
  117. package/.docs/models/providers/io-intelligence.md +1 -1
  118. package/.docs/models/providers/io-net.md +1 -1
  119. package/.docs/models/providers/jiekou.md +1 -1
  120. package/.docs/models/providers/kenari.md +1 -1
  121. package/.docs/models/providers/kilo.md +6 -6
  122. package/.docs/models/providers/kimi-for-coding.md +1 -1
  123. package/.docs/models/providers/kiro.md +1 -1
  124. package/.docs/models/providers/kuae-cloud-coding-plan.md +1 -1
  125. package/.docs/models/providers/lilac.md +1 -1
  126. package/.docs/models/providers/llama.md +1 -1
  127. package/.docs/models/providers/llmgateway.md +2 -4
  128. package/.docs/models/providers/llmtr.md +1 -1
  129. package/.docs/models/providers/lmstudio.md +1 -1
  130. package/.docs/models/providers/longcat.md +1 -1
  131. package/.docs/models/providers/lucidquery.md +1 -1
  132. package/.docs/models/providers/lynkr.md +1 -1
  133. package/.docs/models/providers/meganova.md +1 -1
  134. package/.docs/models/providers/meta.md +1 -1
  135. package/.docs/models/providers/minimax-cn-coding-plan.md +1 -1
  136. package/.docs/models/providers/minimax-cn.md +1 -1
  137. package/.docs/models/providers/minimax-coding-plan.md +1 -1
  138. package/.docs/models/providers/minimax.md +1 -1
  139. package/.docs/models/providers/mixlayer.md +1 -1
  140. package/.docs/models/providers/moark.md +1 -1
  141. package/.docs/models/providers/modal.md +1 -1
  142. package/.docs/models/providers/model-oracle-ai.md +1 -1
  143. package/.docs/models/providers/modelis.md +1 -1
  144. package/.docs/models/providers/modelscope.md +1 -1
  145. package/.docs/models/providers/moonshotai-cn.md +1 -1
  146. package/.docs/models/providers/moonshotai.md +1 -1
  147. package/.docs/models/providers/morph.md +1 -1
  148. package/.docs/models/providers/nano-gpt.md +4 -2
  149. package/.docs/models/providers/nearai.md +1 -1
  150. package/.docs/models/providers/nebius.md +3 -2
  151. package/.docs/models/providers/neuralwatt.md +1 -1
  152. package/.docs/models/providers/nova.md +1 -1
  153. package/.docs/models/providers/novita-ai.md +1 -1
  154. package/.docs/models/providers/nvidia.md +1 -1
  155. package/.docs/models/providers/ofox.md +4 -3
  156. package/.docs/models/providers/ollama-cloud.md +1 -1
  157. package/.docs/models/providers/opencode-go.md +1 -1
  158. package/.docs/models/providers/opencode.md +1 -1
  159. package/.docs/models/providers/orcarouter.md +1 -1
  160. package/.docs/models/providers/ovhcloud.md +1 -1
  161. package/.docs/models/providers/perplexity-agent.md +1 -1
  162. package/.docs/models/providers/pioneer.md +1 -1
  163. package/.docs/models/providers/poe.md +1 -1
  164. package/.docs/models/providers/poolside.md +1 -1
  165. package/.docs/models/providers/privatemode-ai.md +1 -1
  166. package/.docs/models/providers/qihang-ai.md +1 -1
  167. package/.docs/models/providers/qiniu-ai.md +1 -1
  168. package/.docs/models/providers/regolo-ai.md +1 -1
  169. package/.docs/models/providers/requesty.md +3 -3
  170. package/.docs/models/providers/routing-run.md +1 -1
  171. package/.docs/models/providers/sakana.md +1 -1
  172. package/.docs/models/providers/sarvam.md +1 -1
  173. package/.docs/models/providers/scaleway.md +1 -1
  174. package/.docs/models/providers/scx.md +1 -1
  175. package/.docs/models/providers/siliconflow-cn.md +1 -1
  176. package/.docs/models/providers/siliconflow.md +1 -1
  177. package/.docs/models/providers/snowflake-cortex.md +1 -1
  178. package/.docs/models/providers/stackit.md +1 -1
  179. package/.docs/models/providers/stepfun-ai-step-plan.md +1 -1
  180. package/.docs/models/providers/stepfun-ai.md +1 -1
  181. package/.docs/models/providers/stepfun-step-plan.md +1 -1
  182. package/.docs/models/providers/stepfun.md +1 -1
  183. package/.docs/models/providers/subconscious.md +1 -1
  184. package/.docs/models/providers/submodel.md +1 -1
  185. package/.docs/models/providers/synthetic.md +1 -1
  186. package/.docs/models/providers/tencent-coding-plan.md +1 -1
  187. package/.docs/models/providers/tencent-token-plan.md +1 -1
  188. package/.docs/models/providers/tencent-tokenhub.md +1 -1
  189. package/.docs/models/providers/tensorx.md +1 -1
  190. package/.docs/models/providers/the-grid-ai.md +1 -1
  191. package/.docs/models/providers/thinkingmachines.md +1 -1
  192. package/.docs/models/providers/tinfoil.md +2 -2
  193. package/.docs/models/providers/togetherai.md +1 -1
  194. package/.docs/models/providers/trustedrouter.md +1 -1
  195. package/.docs/models/providers/umans-ai-coding-plan.md +1 -1
  196. package/.docs/models/providers/umans-ai.md +1 -1
  197. package/.docs/models/providers/unorouter.md +1 -1
  198. package/.docs/models/providers/upstage.md +1 -1
  199. package/.docs/models/providers/venice.md +1 -1
  200. package/.docs/models/providers/vivgrid.md +1 -1
  201. package/.docs/models/providers/vultr.md +1 -1
  202. package/.docs/models/providers/wafer.ai.md +1 -1
  203. package/.docs/models/providers/wandb.md +1 -1
  204. package/.docs/models/providers/xiaomi-token-plan-ams.md +1 -1
  205. package/.docs/models/providers/xiaomi-token-plan-cn.md +1 -1
  206. package/.docs/models/providers/xiaomi-token-plan-sgp.md +1 -1
  207. package/.docs/models/providers/xiaomi.md +1 -1
  208. package/.docs/models/providers/xpersona.md +1 -1
  209. package/.docs/models/providers/zai-coding-plan.md +1 -1
  210. package/.docs/models/providers/zai.md +1 -1
  211. package/.docs/models/providers/zeldoc.md +8 -8
  212. package/.docs/models/providers/zenifra.md +1 -1
  213. package/.docs/models/providers/zenmux.md +1 -1
  214. package/.docs/models/providers/zhipuai-coding-plan.md +1 -1
  215. package/.docs/models/providers/zhipuai.md +1 -1
  216. package/.docs/reference/agent-controller/agent-controller-class.md +3 -3
  217. package/.docs/reference/agent-controller/session.md +5 -3
  218. package/.docs/reference/agents/durable-agent.md +2 -0
  219. package/.docs/reference/agents/generateLegacy.md +1 -1
  220. package/.docs/reference/agents/inngest-agent.md +2 -0
  221. package/.docs/reference/auth/okta.md +5 -1
  222. package/.docs/reference/cli/mastra.md +4 -4
  223. package/.docs/reference/client-js/agents.md +2 -1
  224. package/.docs/reference/client-js/workflows.md +3 -3
  225. package/.docs/reference/code-sdk/mount-agent-controller.md +1 -1
  226. package/.docs/reference/configuration.md +1 -1
  227. package/.docs/reference/core/addDynamicWorkflow.md +1 -1
  228. package/.docs/reference/core/addDynamicWorkflows.md +1 -1
  229. package/.docs/reference/datasets/startExperiment.md +8 -0
  230. package/.docs/reference/file-based-agents/config.md +2 -0
  231. package/.docs/reference/file-based-agents/instructions.md +2 -0
  232. package/.docs/reference/file-based-agents/logger.md +2 -0
  233. package/.docs/reference/file-based-agents/memory.md +2 -0
  234. package/.docs/reference/file-based-agents/observability.md +2 -0
  235. package/.docs/reference/file-based-agents/processors.md +2 -0
  236. package/.docs/reference/file-based-agents/schedules.md +2 -0
  237. package/.docs/reference/file-based-agents/scorers.md +2 -0
  238. package/.docs/reference/file-based-agents/server.md +2 -0
  239. package/.docs/reference/file-based-agents/skills.md +2 -0
  240. package/.docs/reference/file-based-agents/storage.md +2 -0
  241. package/.docs/reference/file-based-agents/studio.md +2 -0
  242. package/.docs/reference/file-based-agents/subagents.md +2 -0
  243. package/.docs/reference/file-based-agents/tools.md +2 -0
  244. package/.docs/reference/file-based-agents/workflows.md +2 -0
  245. package/.docs/reference/file-based-agents/workspace.md +2 -0
  246. package/.docs/reference/index.md +1 -0
  247. package/.docs/reference/observability/tracing/exporters/datadog.md +1 -1
  248. package/.docs/reference/processors/pii-detector.md +2 -0
  249. package/.docs/reference/processors/prompt-injection-detector.md +2 -0
  250. package/.docs/reference/processors/response-cache.md +2 -0
  251. package/.docs/reference/schedules/overview.md +2 -0
  252. package/.docs/reference/signals/create-notification-inbox-tool.md +2 -0
  253. package/.docs/reference/signals/signal-provider.md +2 -0
  254. package/.docs/reference/signals/task-signal-provider.md +2 -0
  255. package/.docs/reference/signals/webhook-signal-provider.md +2 -0
  256. package/.docs/reference/storage/composite.md +1 -1
  257. package/.docs/reference/streaming/agents/stream.md +1 -1
  258. package/.docs/reference/streaming/agents/streamLegacy.md +1 -1
  259. package/.docs/reference/streaming/agents/streamUntilIdle.md +1 -1
  260. package/.docs/reference/tools/create-code-mode.md +3 -1
  261. package/.docs/reference/tools/isolated-vm-transport.md +1 -1
  262. package/.docs/reference/tools/mcp-client.md +51 -0
  263. package/.docs/reference/tools/quickjs-transport.md +92 -0
  264. package/.docs/reference/vectors/chroma.md +1 -1
  265. package/.docs/reference/workers/overview.md +2 -0
  266. package/.docs/reference/workflows/dynamic-workflow-definition.md +1 -1
  267. package/.docs/reference/workspace/mesa-filesystem.md +1 -1
  268. package/.docs/reference/workspace/platform-filesystem.md +1 -1
  269. package/.docs/reference/workspace/platform-sandbox.md +1 -1
  270. package/CHANGELOG.md +29 -0
  271. package/package.json +6 -6
@@ -31,7 +31,7 @@ for await (const chunk of stream) {
31
31
  }
32
32
  ```
33
33
 
34
- > **Info:** Mastra uses the OpenAI-compatible `/chat/completions` endpoint. Some provider-specific features may not be available. Check the [Snowflake Cortex documentation](https://docs.snowflake.com/en/user-guide/snowflake-cortex/cortex-rest-api) for details.
34
+ > **Note:** Mastra uses the OpenAI-compatible `/chat/completions` endpoint. Some provider-specific features may not be available. Check the [Snowflake Cortex documentation](https://docs.snowflake.com/en/user-guide/snowflake-cortex/cortex-rest-api) for details.
35
35
 
36
36
  ## Models
37
37
 
@@ -30,7 +30,7 @@ for await (const chunk of stream) {
30
30
  }
31
31
  ```
32
32
 
33
- > **Info:** Mastra uses the OpenAI-compatible `/chat/completions` endpoint. Some provider-specific features may not be available. Check the [STACKIT documentation](https://docs.stackit.cloud/products/data-and-ai/ai-model-serving/basics/available-shared-models) for details.
33
+ > **Note:** Mastra uses the OpenAI-compatible `/chat/completions` endpoint. Some provider-specific features may not be available. Check the [STACKIT documentation](https://docs.stackit.cloud/products/data-and-ai/ai-model-serving/basics/available-shared-models) for details.
34
34
 
35
35
  ## Models
36
36
 
@@ -30,7 +30,7 @@ for await (const chunk of stream) {
30
30
  }
31
31
  ```
32
32
 
33
- > **Info:** Mastra uses the OpenAI-compatible `/chat/completions` endpoint. Some provider-specific features may not be available. Check the [StepFun Step Plan (Global) documentation](https://platform.stepfun.ai/docs/en/step-plan/integrations/reasoning-api) for details.
33
+ > **Note:** Mastra uses the OpenAI-compatible `/chat/completions` endpoint. Some provider-specific features may not be available. Check the [StepFun Step Plan (Global) documentation](https://platform.stepfun.ai/docs/en/step-plan/integrations/reasoning-api) for details.
34
34
 
35
35
  ## Models
36
36
 
@@ -30,7 +30,7 @@ for await (const chunk of stream) {
30
30
  }
31
31
  ```
32
32
 
33
- > **Info:** Mastra uses the OpenAI-compatible `/chat/completions` endpoint. Some provider-specific features may not be available. Check the [StepFun (Global) documentation](https://platform.stepfun.ai/docs/en/overview/concept) for details.
33
+ > **Note:** Mastra uses the OpenAI-compatible `/chat/completions` endpoint. Some provider-specific features may not be available. Check the [StepFun (Global) documentation](https://platform.stepfun.ai/docs/en/overview/concept) for details.
34
34
 
35
35
  ## Models
36
36
 
@@ -30,7 +30,7 @@ for await (const chunk of stream) {
30
30
  }
31
31
  ```
32
32
 
33
- > **Info:** Mastra uses the OpenAI-compatible `/chat/completions` endpoint. Some provider-specific features may not be available. Check the [StepFun Step Plan (China) documentation](https://platform.stepfun.com/docs/zh/step-plan/integrations/reasoning-api) for details.
33
+ > **Note:** Mastra uses the OpenAI-compatible `/chat/completions` endpoint. Some provider-specific features may not be available. Check the [StepFun Step Plan (China) documentation](https://platform.stepfun.com/docs/zh/step-plan/integrations/reasoning-api) for details.
34
34
 
35
35
  ## Models
36
36
 
@@ -30,7 +30,7 @@ for await (const chunk of stream) {
30
30
  }
31
31
  ```
32
32
 
33
- > **Info:** Mastra uses the OpenAI-compatible `/chat/completions` endpoint. Some provider-specific features may not be available. Check the [StepFun (China) documentation](https://platform.stepfun.com/docs/zh/overview/concept) for details.
33
+ > **Note:** Mastra uses the OpenAI-compatible `/chat/completions` endpoint. Some provider-specific features may not be available. Check the [StepFun (China) documentation](https://platform.stepfun.com/docs/zh/overview/concept) for details.
34
34
 
35
35
  ## Models
36
36
 
@@ -30,7 +30,7 @@ for await (const chunk of stream) {
30
30
  }
31
31
  ```
32
32
 
33
- > **Info:** Mastra uses the OpenAI-compatible `/chat/completions` endpoint. Some provider-specific features may not be available. Check the [Subconscious documentation](https://docs.subconscious.dev) for details.
33
+ > **Note:** Mastra uses the OpenAI-compatible `/chat/completions` endpoint. Some provider-specific features may not be available. Check the [Subconscious documentation](https://docs.subconscious.dev) for details.
34
34
 
35
35
  ## Models
36
36
 
@@ -30,7 +30,7 @@ for await (const chunk of stream) {
30
30
  }
31
31
  ```
32
32
 
33
- > **Info:** Mastra uses the OpenAI-compatible `/chat/completions` endpoint. Some provider-specific features may not be available. Check the [submodel documentation](https://submodel.gitbook.io) for details.
33
+ > **Note:** Mastra uses the OpenAI-compatible `/chat/completions` endpoint. Some provider-specific features may not be available. Check the [submodel documentation](https://submodel.gitbook.io) for details.
34
34
 
35
35
  ## Models
36
36
 
@@ -30,7 +30,7 @@ for await (const chunk of stream) {
30
30
  }
31
31
  ```
32
32
 
33
- > **Info:** Mastra uses the OpenAI-compatible `/chat/completions` endpoint. Some provider-specific features may not be available. Check the [Synthetic documentation](https://synthetic.new/pricing) for details.
33
+ > **Note:** Mastra uses the OpenAI-compatible `/chat/completions` endpoint. Some provider-specific features may not be available. Check the [Synthetic documentation](https://synthetic.new/pricing) for details.
34
34
 
35
35
  ## Models
36
36
 
@@ -30,7 +30,7 @@ for await (const chunk of stream) {
30
30
  }
31
31
  ```
32
32
 
33
- > **Info:** Mastra uses the OpenAI-compatible `/chat/completions` endpoint. Some provider-specific features may not be available. Check the [Tencent Coding Plan (China) documentation](https://cloud.tencent.com/document/product/1772/128947) for details.
33
+ > **Note:** Mastra uses the OpenAI-compatible `/chat/completions` endpoint. Some provider-specific features may not be available. Check the [Tencent Coding Plan (China) documentation](https://cloud.tencent.com/document/product/1772/128947) for details.
34
34
 
35
35
  ## Models
36
36
 
@@ -30,7 +30,7 @@ for await (const chunk of stream) {
30
30
  }
31
31
  ```
32
32
 
33
- > **Info:** Mastra uses the OpenAI-compatible `/chat/completions` endpoint. Some provider-specific features may not be available. Check the [Tencent Token Plan documentation](https://cloud.tencent.com/document/product/1823/130060) for details.
33
+ > **Note:** Mastra uses the OpenAI-compatible `/chat/completions` endpoint. Some provider-specific features may not be available. Check the [Tencent Token Plan documentation](https://cloud.tencent.com/document/product/1823/130060) for details.
34
34
 
35
35
  ## Models
36
36
 
@@ -30,7 +30,7 @@ for await (const chunk of stream) {
30
30
  }
31
31
  ```
32
32
 
33
- > **Info:** Mastra uses the OpenAI-compatible `/chat/completions` endpoint. Some provider-specific features may not be available. Check the [Tencent TokenHub documentation](https://cloud.tencent.com/document/product/1823/130050) for details.
33
+ > **Note:** Mastra uses the OpenAI-compatible `/chat/completions` endpoint. Some provider-specific features may not be available. Check the [Tencent TokenHub documentation](https://cloud.tencent.com/document/product/1823/130050) for details.
34
34
 
35
35
  ## Models
36
36
 
@@ -30,7 +30,7 @@ for await (const chunk of stream) {
30
30
  }
31
31
  ```
32
32
 
33
- > **Info:** Mastra uses the OpenAI-compatible `/chat/completions` endpoint. Some provider-specific features may not be available. Check the [TensorX documentation](https://docs.tensorx.ai/) for details.
33
+ > **Note:** Mastra uses the OpenAI-compatible `/chat/completions` endpoint. Some provider-specific features may not be available. Check the [TensorX documentation](https://docs.tensorx.ai/) for details.
34
34
 
35
35
  ## Models
36
36
 
@@ -30,7 +30,7 @@ for await (const chunk of stream) {
30
30
  }
31
31
  ```
32
32
 
33
- > **Info:** Mastra uses the OpenAI-compatible `/chat/completions` endpoint. Some provider-specific features may not be available. Check the [The Grid AI documentation](https://thegrid.ai/docs) for details.
33
+ > **Note:** Mastra uses the OpenAI-compatible `/chat/completions` endpoint. Some provider-specific features may not be available. Check the [The Grid AI documentation](https://thegrid.ai/docs) for details.
34
34
 
35
35
  ## Models
36
36
 
@@ -30,7 +30,7 @@ for await (const chunk of stream) {
30
30
  }
31
31
  ```
32
32
 
33
- > **Info:** Mastra uses the OpenAI-compatible `/chat/completions` endpoint. Some provider-specific features may not be available. Check the [Thinking Machines documentation](https://tinker-docs.thinkingmachines.ai/tinker/compatible-apis/anthropic/) for details.
33
+ > **Note:** Mastra uses the OpenAI-compatible `/chat/completions` endpoint. Some provider-specific features may not be available. Check the [Thinking Machines documentation](https://tinker-docs.thinkingmachines.ai/tinker/compatible-apis/anthropic/) for details.
34
34
 
35
35
  ## Models
36
36
 
@@ -30,7 +30,7 @@ for await (const chunk of stream) {
30
30
  }
31
31
  ```
32
32
 
33
- > **Info:** Mastra uses the OpenAI-compatible `/chat/completions` endpoint. Some provider-specific features may not be available. Check the [Tinfoil documentation](https://docs.tinfoil.sh) for details.
33
+ > **Note:** Mastra uses the OpenAI-compatible `/chat/completions` endpoint. Some provider-specific features may not be available. Check the [Tinfoil documentation](https://docs.tinfoil.sh) for details.
34
34
 
35
35
  ## Models
36
36
 
@@ -40,7 +40,7 @@ for await (const chunk of stream) {
40
40
  | `tinfoil/glm-5-2` | 384K | | | | | | $2 | $5 |
41
41
  | `tinfoil/gpt-oss-120b` | 131K | | | | | | $0.15 | $0.60 |
42
42
  | `tinfoil/gpt-oss-safeguard-120b` | 131K | | | | | | $0.15 | $0.60 |
43
- | `tinfoil/kimi-k2-6` | 256K | | | | | | $2 | $5 |
43
+ | `tinfoil/kimi-k3` | 256K | | | | | | $2 | $6 |
44
44
  | `tinfoil/llama3-3-70b` | 128K | | | | | | $2 | $3 |
45
45
  | `tinfoil/nomic-embed-text` | 8K | | | | | | $0.05 | — |
46
46
 
@@ -56,7 +56,7 @@ for await (const chunk of stream) {
56
56
  | `togetherai/Qwen/Qwen3.6-Plus` | 1.0M | | | | | | $0.50 | $3 |
57
57
  | `togetherai/Qwen/Qwen3.7-Max` | 1.0M | | | | | | $1 | $4 |
58
58
  | `togetherai/thinkingmachines/Inkling` | 524K | | | | | | $1 | $4 |
59
- | `togetherai/zai-org/GLM-5.2` | 262K | | | | | | $1 | $4 |
59
+ | `togetherai/zai-org/GLM-5.2` | 512K | | | | | | $1 | $4 |
60
60
 
61
61
  ## Advanced configuration
62
62
 
@@ -30,7 +30,7 @@ for await (const chunk of stream) {
30
30
  }
31
31
  ```
32
32
 
33
- > **Info:** Mastra uses the OpenAI-compatible `/chat/completions` endpoint. Some provider-specific features may not be available. Check the [TrustedRouter documentation](https://trustedrouter.com/docs) for details.
33
+ > **Note:** Mastra uses the OpenAI-compatible `/chat/completions` endpoint. Some provider-specific features may not be available. Check the [TrustedRouter documentation](https://trustedrouter.com/docs) for details.
34
34
 
35
35
  ## Models
36
36
 
@@ -30,7 +30,7 @@ for await (const chunk of stream) {
30
30
  }
31
31
  ```
32
32
 
33
- > **Info:** Mastra uses the OpenAI-compatible `/chat/completions` endpoint. Some provider-specific features may not be available. Check the [Umans AI Coding Plan documentation](https://app.umans.ai/offers/code/docs) for details.
33
+ > **Note:** Mastra uses the OpenAI-compatible `/chat/completions` endpoint. Some provider-specific features may not be available. Check the [Umans AI Coding Plan documentation](https://app.umans.ai/offers/code/docs) for details.
34
34
 
35
35
  ## Models
36
36
 
@@ -30,7 +30,7 @@ for await (const chunk of stream) {
30
30
  }
31
31
  ```
32
32
 
33
- > **Info:** Mastra uses the OpenAI-compatible `/chat/completions` endpoint. Some provider-specific features may not be available. Check the [Umans AI documentation](https://app.umans.ai/offers/code/docs/orgs) for details.
33
+ > **Note:** Mastra uses the OpenAI-compatible `/chat/completions` endpoint. Some provider-specific features may not be available. Check the [Umans AI documentation](https://app.umans.ai/offers/code/docs/orgs) for details.
34
34
 
35
35
  ## Models
36
36
 
@@ -30,7 +30,7 @@ for await (const chunk of stream) {
30
30
  }
31
31
  ```
32
32
 
33
- > **Info:** Mastra uses the OpenAI-compatible `/chat/completions` endpoint. Some provider-specific features may not be available. Check the [UnoRouter documentation](https://unorouter.com/models) for details.
33
+ > **Note:** Mastra uses the OpenAI-compatible `/chat/completions` endpoint. Some provider-specific features may not be available. Check the [UnoRouter documentation](https://unorouter.com/models) for details.
34
34
 
35
35
  ## Models
36
36
 
@@ -30,7 +30,7 @@ for await (const chunk of stream) {
30
30
  }
31
31
  ```
32
32
 
33
- > **Info:** Mastra uses the OpenAI-compatible `/chat/completions` endpoint. Some provider-specific features may not be available. Check the [Upstage documentation](https://developers.upstage.ai) for details.
33
+ > **Note:** Mastra uses the OpenAI-compatible `/chat/completions` endpoint. Some provider-specific features may not be available. Check the [Upstage documentation](https://developers.upstage.ai) for details.
34
34
 
35
35
  ## Models
36
36
 
@@ -30,7 +30,7 @@ for await (const chunk of stream) {
30
30
  }
31
31
  ```
32
32
 
33
- > **Info:** Mastra uses the OpenAI-compatible `/chat/completions` endpoint. Some provider-specific features may not be available. Check the [Venice AI documentation](https://docs.venice.ai) for details.
33
+ > **Note:** Mastra uses the OpenAI-compatible `/chat/completions` endpoint. Some provider-specific features may not be available. Check the [Venice AI documentation](https://docs.venice.ai) for details.
34
34
 
35
35
  ## Models
36
36
 
@@ -30,7 +30,7 @@ for await (const chunk of stream) {
30
30
  }
31
31
  ```
32
32
 
33
- > **Info:** Mastra uses the OpenAI-compatible `/chat/completions` endpoint. Some provider-specific features may not be available. Check the [Vivgrid documentation](https://docs.vivgrid.com/models) for details.
33
+ > **Note:** Mastra uses the OpenAI-compatible `/chat/completions` endpoint. Some provider-specific features may not be available. Check the [Vivgrid documentation](https://docs.vivgrid.com/models) for details.
34
34
 
35
35
  ## Models
36
36
 
@@ -30,7 +30,7 @@ for await (const chunk of stream) {
30
30
  }
31
31
  ```
32
32
 
33
- > **Info:** Mastra uses the OpenAI-compatible `/chat/completions` endpoint. Some provider-specific features may not be available. Check the [Vultr documentation](https://api.vultrinference.com/) for details.
33
+ > **Note:** Mastra uses the OpenAI-compatible `/chat/completions` endpoint. Some provider-specific features may not be available. Check the [Vultr documentation](https://api.vultrinference.com/) for details.
34
34
 
35
35
  ## Models
36
36
 
@@ -30,7 +30,7 @@ for await (const chunk of stream) {
30
30
  }
31
31
  ```
32
32
 
33
- > **Info:** Mastra uses the OpenAI-compatible `/chat/completions` endpoint. Some provider-specific features may not be available. Check the [Wafer documentation](https://docs.wafer.ai/wafer-pass) for details.
33
+ > **Note:** Mastra uses the OpenAI-compatible `/chat/completions` endpoint. Some provider-specific features may not be available. Check the [Wafer documentation](https://docs.wafer.ai/wafer-pass) for details.
34
34
 
35
35
  ## Models
36
36
 
@@ -30,7 +30,7 @@ for await (const chunk of stream) {
30
30
  }
31
31
  ```
32
32
 
33
- > **Info:** Mastra uses the OpenAI-compatible `/chat/completions` endpoint. Some provider-specific features may not be available. Check the [Weights & Biases documentation](https://docs.wandb.ai) for details.
33
+ > **Note:** Mastra uses the OpenAI-compatible `/chat/completions` endpoint. Some provider-specific features may not be available. Check the [Weights & Biases documentation](https://docs.wandb.ai) for details.
34
34
 
35
35
  ## Models
36
36
 
@@ -30,7 +30,7 @@ for await (const chunk of stream) {
30
30
  }
31
31
  ```
32
32
 
33
- > **Info:** Mastra uses the OpenAI-compatible `/chat/completions` endpoint. Some provider-specific features may not be available. Check the [Xiaomi Token Plan (Europe) documentation](https://platform.xiaomimimo.com/#/docs) for details.
33
+ > **Note:** Mastra uses the OpenAI-compatible `/chat/completions` endpoint. Some provider-specific features may not be available. Check the [Xiaomi Token Plan (Europe) documentation](https://platform.xiaomimimo.com/#/docs) for details.
34
34
 
35
35
  ## Models
36
36
 
@@ -30,7 +30,7 @@ for await (const chunk of stream) {
30
30
  }
31
31
  ```
32
32
 
33
- > **Info:** Mastra uses the OpenAI-compatible `/chat/completions` endpoint. Some provider-specific features may not be available. Check the [Xiaomi Token Plan (China) documentation](https://platform.xiaomimimo.com/#/docs) for details.
33
+ > **Note:** Mastra uses the OpenAI-compatible `/chat/completions` endpoint. Some provider-specific features may not be available. Check the [Xiaomi Token Plan (China) documentation](https://platform.xiaomimimo.com/#/docs) for details.
34
34
 
35
35
  ## Models
36
36
 
@@ -30,7 +30,7 @@ for await (const chunk of stream) {
30
30
  }
31
31
  ```
32
32
 
33
- > **Info:** Mastra uses the OpenAI-compatible `/chat/completions` endpoint. Some provider-specific features may not be available. Check the [Xiaomi Token Plan (Singapore) documentation](https://platform.xiaomimimo.com/#/docs) for details.
33
+ > **Note:** Mastra uses the OpenAI-compatible `/chat/completions` endpoint. Some provider-specific features may not be available. Check the [Xiaomi Token Plan (Singapore) documentation](https://platform.xiaomimimo.com/#/docs) for details.
34
34
 
35
35
  ## Models
36
36
 
@@ -30,7 +30,7 @@ for await (const chunk of stream) {
30
30
  }
31
31
  ```
32
32
 
33
- > **Info:** Mastra uses the OpenAI-compatible `/chat/completions` endpoint. Some provider-specific features may not be available. Check the [Xiaomi documentation](https://platform.xiaomimimo.com/#/docs) for details.
33
+ > **Note:** Mastra uses the OpenAI-compatible `/chat/completions` endpoint. Some provider-specific features may not be available. Check the [Xiaomi documentation](https://platform.xiaomimimo.com/#/docs) for details.
34
34
 
35
35
  ## Models
36
36
 
@@ -30,7 +30,7 @@ for await (const chunk of stream) {
30
30
  }
31
31
  ```
32
32
 
33
- > **Info:** Mastra uses the OpenAI-compatible `/chat/completions` endpoint. Some provider-specific features may not be available. Check the [Xpersona documentation](https://www.xpersona.co/docs) for details.
33
+ > **Note:** Mastra uses the OpenAI-compatible `/chat/completions` endpoint. Some provider-specific features may not be available. Check the [Xpersona documentation](https://www.xpersona.co/docs) for details.
34
34
 
35
35
  ## Models
36
36
 
@@ -30,7 +30,7 @@ for await (const chunk of stream) {
30
30
  }
31
31
  ```
32
32
 
33
- > **Info:** Mastra uses the OpenAI-compatible `/chat/completions` endpoint. Some provider-specific features may not be available. Check the [Z.AI Coding Plan documentation](https://docs.z.ai/devpack/overview) for details.
33
+ > **Note:** Mastra uses the OpenAI-compatible `/chat/completions` endpoint. Some provider-specific features may not be available. Check the [Z.AI Coding Plan documentation](https://docs.z.ai/devpack/overview) for details.
34
34
 
35
35
  ## Models
36
36
 
@@ -30,7 +30,7 @@ for await (const chunk of stream) {
30
30
  }
31
31
  ```
32
32
 
33
- > **Info:** Mastra uses the OpenAI-compatible `/chat/completions` endpoint. Some provider-specific features may not be available. Check the [Z.AI documentation](https://docs.z.ai/guides/overview/pricing) for details.
33
+ > **Note:** Mastra uses the OpenAI-compatible `/chat/completions` endpoint. Some provider-specific features may not be available. Check the [Z.AI documentation](https://docs.z.ai/guides/overview/pricing) for details.
34
34
 
35
35
  ## Models
36
36
 
@@ -17,7 +17,7 @@ const agent = new Agent({
17
17
  id: "my-agent",
18
18
  name: "My Agent",
19
19
  instructions: "You are a helpful assistant",
20
- model: "zeldoc/z-code"
20
+ model: "zeldoc/zdev"
21
21
  });
22
22
 
23
23
  // Generate a response
@@ -30,13 +30,13 @@ for await (const chunk of stream) {
30
30
  }
31
31
  ```
32
32
 
33
- > **Info:** Mastra uses the OpenAI-compatible `/chat/completions` endpoint. Some provider-specific features may not be available. Check the [Zeldoc documentation](https://docs.zeldoc.ai) for details.
33
+ > **Note:** Mastra uses the OpenAI-compatible `/chat/completions` endpoint. Some provider-specific features may not be available. Check the [Zeldoc documentation](https://docs.zeldoc.ai) for details.
34
34
 
35
35
  ## Models
36
36
 
37
- | Model | Context | Tools | Reasoning | Image | Audio | Video | Input $/1M | Output $/1M |
38
- | --------------- | ------- | ----- | --------- | ----- | ----- | ----- | ---------- | ----------- |
39
- | `zeldoc/z-code` | 1.0M | | | | | | — | — |
37
+ | Model | Context | Tools | Reasoning | Image | Audio | Video | Input $/1M | Output $/1M |
38
+ | ------------- | ------- | ----- | --------- | ----- | ----- | ----- | ---------- | ----------- |
39
+ | `zeldoc/zdev` | 1.0M | | | | | | — | — |
40
40
 
41
41
  ## Advanced configuration
42
42
 
@@ -48,7 +48,7 @@ const agent = new Agent({
48
48
  name: "custom-agent",
49
49
  model: {
50
50
  url: "https://api.zeldoc.ai/v1",
51
- id: "zeldoc/z-code",
51
+ id: "zeldoc/zdev",
52
52
  apiKey: process.env.ZELDOC_API_KEY,
53
53
  headers: {
54
54
  "X-Custom-Header": "value"
@@ -66,8 +66,8 @@ const agent = new Agent({
66
66
  model: ({ requestContext }) => {
67
67
  const useAdvanced = requestContext.task === "complex";
68
68
  return useAdvanced
69
- ? "zeldoc/z-code"
70
- : "zeldoc/z-code";
69
+ ? "zeldoc/zdev"
70
+ : "zeldoc/zdev";
71
71
  }
72
72
  });
73
73
  ```
@@ -30,7 +30,7 @@ for await (const chunk of stream) {
30
30
  }
31
31
  ```
32
32
 
33
- > **Info:** Mastra uses the OpenAI-compatible `/chat/completions` endpoint. Some provider-specific features may not be available. Check the [Zenifra documentation](https://docs.zenifra.com) for details.
33
+ > **Note:** Mastra uses the OpenAI-compatible `/chat/completions` endpoint. Some provider-specific features may not be available. Check the [Zenifra documentation](https://docs.zenifra.com) for details.
34
34
 
35
35
  ## Models
36
36
 
@@ -30,7 +30,7 @@ for await (const chunk of stream) {
30
30
  }
31
31
  ```
32
32
 
33
- > **Info:** Mastra uses the OpenAI-compatible `/chat/completions` endpoint. Some provider-specific features may not be available. Check the [ZenMux documentation](https://docs.zenmux.ai) for details.
33
+ > **Note:** Mastra uses the OpenAI-compatible `/chat/completions` endpoint. Some provider-specific features may not be available. Check the [ZenMux documentation](https://docs.zenmux.ai) for details.
34
34
 
35
35
  ## Models
36
36
 
@@ -30,7 +30,7 @@ for await (const chunk of stream) {
30
30
  }
31
31
  ```
32
32
 
33
- > **Info:** Mastra uses the OpenAI-compatible `/chat/completions` endpoint. Some provider-specific features may not be available. Check the [Zhipu AI Coding Plan documentation](https://docs.bigmodel.cn/cn/coding-plan/overview) for details.
33
+ > **Note:** Mastra uses the OpenAI-compatible `/chat/completions` endpoint. Some provider-specific features may not be available. Check the [Zhipu AI Coding Plan documentation](https://docs.bigmodel.cn/cn/coding-plan/overview) for details.
34
34
 
35
35
  ## Models
36
36
 
@@ -30,7 +30,7 @@ for await (const chunk of stream) {
30
30
  }
31
31
  ```
32
32
 
33
- > **Info:** Mastra uses the OpenAI-compatible `/chat/completions` endpoint. Some provider-specific features may not be available. Check the [Zhipu AI documentation](https://docs.z.ai/guides/overview/pricing) for details.
33
+ > **Note:** Mastra uses the OpenAI-compatible `/chat/completions` endpoint. Some provider-specific features may not be available. Check the [Zhipu AI documentation](https://docs.z.ai/guides/overview/pricing) for details.
34
34
 
35
35
  ## Models
36
36
 
@@ -2,7 +2,7 @@
2
2
 
3
3
  # AgentController
4
4
 
5
- > **Beta:** The `AgentController` feature is in beta stage and subject to breaking changes in minor versions until it graduates from its beta status.
5
+ > **Beta:** Breaking changes may occur without a major version bump until the API is stable.
6
6
 
7
7
  The `AgentController` class is a shared host for one or more [`Session`](https://mastra.ai/reference/agent-controller/session) instances. Initialize the controller, create a session, then use `session.*` APIs for conversation state and run control.
8
8
 
@@ -280,7 +280,7 @@ Returns: `boolean`
280
280
 
281
281
  #### `getWorkspace()`
282
282
 
283
- Return a static controller workspace. Dynamic workspace factories return `undefined` until resolved.
283
+ Return a static controller workspace. Dynamic workspace factories resolve per session and return `undefined` here, so use `resolveWorkspace` instead.
284
284
 
285
285
  ```typescript
286
286
  const workspace = controller.getWorkspace()
@@ -290,7 +290,7 @@ Returns: `Workspace | undefined`
290
290
 
291
291
  #### `resolveWorkspace({ session, requestContext? })`
292
292
 
293
- Resolve a dynamic workspace for a session and cache the result on the controller.
293
+ Return the workspace a session runs against. Sessions resolve theirs at creation, dynamic factories included, so this returns that instance and only falls back to the factory for a session created without one.
294
294
 
295
295
  ```typescript
296
296
  const workspace = await controller.resolveWorkspace({ session, requestContext })
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Session
4
4
 
5
- > **Beta:** The `AgentController` feature is in beta stage and subject to breaking changes in minor versions until it graduates from its beta status.
5
+ > **Beta:** Breaking changes may occur without a major version bump until the API is stable.
6
6
 
7
7
  A `Session` is the isolated runtime for one resource and optional scope. It owns its event bus, thread binding, state, mode and model selections, run control, approvals, suspensions, follow-ups, and display state. The [`AgentController`](https://mastra.ai/reference/agent-controller/agent-controller-class) supplies shared agents, configuration, storage, workspaces, and services.
8
8
 
@@ -143,12 +143,14 @@ session.abort()
143
143
 
144
144
  Return the workspace resolved for this session. This preserves session-level overrides and workspaces selected from the session scope.
145
145
 
146
+ A workspace is optional. When neither the session nor the `AgentController` configures one, the session still runs without filesystem or sandbox access, and this returns `undefined`. Check the result before using it.
147
+
146
148
  ```typescript
147
149
  const workspace = session.getWorkspace()
148
- const skill = await workspace.skills?.get('code-review')
150
+ const skill = await workspace?.skills?.get('code-review')
149
151
  ```
150
152
 
151
- Returns: `Workspace`
153
+ Returns: `Workspace | undefined`
152
154
 
153
155
  ### Session grants
154
156
 
@@ -2,6 +2,8 @@
2
2
 
3
3
  # DurableAgent
4
4
 
5
+ > **Beta:** Breaking changes may occur without a major version bump until the API is stable.
6
+
5
7
  `DurableAgent` wraps an existing [`Agent`](https://mastra.ai/reference/agents/agent) with durable execution and resumable streams. It runs the agentic loop so that a client can disconnect and reconnect without missing events, and it streams those events over [PubSub](https://mastra.ai/docs/server/pubsub). Use it when a run must outlive a single request or survive a dropped connection.
6
8
 
7
9
  Create one with the [`createDurableAgent`](#createdurableagentoptions) factory, or use [`createEventedAgent`](#createeventedagentoptions) for fire-and-forget execution on the built-in workflow engine. For Inngest-powered execution, use [`createInngestAgent`](https://mastra.ai/reference/agents/inngest-agent) from `@mastra/inngest`.
@@ -138,7 +138,7 @@ Scorer judges with legacy model adapters call `generateLegacy()`. They don't rec
138
138
 
139
139
  ## Migration to new API
140
140
 
141
- > **Info:** The new `.generate()` method offers enhanced capabilities including AI SDK v5+ compatibility, better structured output handling, and improved streaming support. See the [migration guide](https://mastra.ai/guides/migrations/vnext-to-standard-apis) for detailed migration instructions.
141
+ > **Note:** The new `.generate()` method offers enhanced capabilities including AI SDK v5+ compatibility, better structured output handling, and improved streaming support. See the [migration guide](https://mastra.ai/guides/migrations/vnext-to-standard-apis) for detailed migration instructions.
142
142
 
143
143
  ### Quick Migration Example
144
144
 
@@ -2,6 +2,8 @@
2
2
 
3
3
  # `createInngestAgent()`
4
4
 
5
+ > **Beta:** Breaking changes may occur without a major version bump until the API is stable.
6
+
5
7
  `createInngestAgent()` wraps an existing [`Agent`](https://mastra.ai/reference/agents/agent) with [Inngest](https://www.inngest.com/docs)-powered durable execution. Like [`createDurableAgent()`](https://mastra.ai/reference/agents/durable-agent), it streams events over [PubSub](https://mastra.ai/docs/server/pubsub) and supports resumable streams, but runs the agentic loop on Inngest's execution engine instead of in-process. Use it when a run must survive process restarts or run in a distributed environment.
6
8
 
7
9
  For in-process durable execution, use [`createDurableAgent()`](https://mastra.ai/reference/agents/durable-agent). For fire-and-forget execution on the built-in workflow engine, use [`createEventedAgent()`](https://mastra.ai/reference/agents/durable-agent).
@@ -38,6 +38,8 @@ export const mastra = new Mastra({
38
38
 
39
39
  **redirectUri** (`string`): The OAuth redirect URI for the SSO callback. Must match the redirect URI configured in your Okta application. (Default: `process.env.OKTA_REDIRECT_URI`)
40
40
 
41
+ **audience** (`string | string[]`): Expected aud claim for Bearer tokens. Defaults to the client ID, which matches Okta ID tokens. Set it to the authorization server's audience to accept access tokens, or pass an array to accept several. Does not affect the ID token verified during the SSO login flow, which always uses the client ID. (Default: `process.env.OKTA_AUDIENCE ?? clientId`)
42
+
41
43
  **scopes** (`string[]`): OAuth scopes to request during the login flow. (Default: `['openid', 'profile', 'email', 'groups']`)
42
44
 
43
45
  **apiToken** (`string`): Okta API token for user lookups via the Users API. Required for getUser() to return user data by ID. (Default: `process.env.OKTA_API_TOKEN`)
@@ -66,6 +68,8 @@ The following environment variables are automatically used when constructor opti
66
68
 
67
69
  **OKTA\_ISSUER** (`string`): Token issuer URL. Defaults to https\://{domain}/oauth2/default if not set.
68
70
 
71
+ **OKTA\_AUDIENCE** (`string`): Expected aud claim for Bearer tokens. Defaults to the client ID if not set.
72
+
69
73
  **OKTA\_REDIRECT\_URI** (`string`): OAuth redirect URI for the SSO callback.
70
74
 
71
75
  **OKTA\_COOKIE\_PASSWORD** (`string`): Password for encrypting session cookies. Must be at least 32 characters.
@@ -77,7 +81,7 @@ The following environment variables are automatically used when constructor opti
77
81
  `MastraAuthOkta` authenticates requests in the following order:
78
82
 
79
83
  1. **Session cookie**: Reads the encrypted session cookie and decrypts it. If the session is valid and not expired, the user is authenticated.
80
- 2. **JWT fallback**: If no session cookie is present, verifies the `Authorization` header token against Okta's JWKS endpoint.
84
+ 2. **JWT fallback**: If no session cookie is present, verifies the `Authorization` header token against Okta's JWKS endpoint. The token's `iss` claim is checked against `issuer` and its `aud` claim against `audience`.
81
85
 
82
86
  After authentication, `authorizeUser` checks that the user has a valid `oktaId`. Provide a custom `authorizeUser` function to implement additional logic.
83
87
 
@@ -153,7 +153,7 @@ MASTRA_CONCURRENCY=2 mastra build
153
153
 
154
154
  ## `mastra start`
155
155
 
156
- > **Info:** You need to run `mastra build` before using `mastra start`.
156
+ > **Note:** You need to run `mastra build` before using `mastra start`.
157
157
 
158
158
  Starts a local server to serve your built Mastra application in production mode. By default, [OTEL Tracing](https://mastra.ai/docs/observability/tracing/overview) is enabled.
159
159
 
@@ -266,7 +266,7 @@ Enable debug logging during the build.
266
266
 
267
267
  ## `mastra worker start`
268
268
 
269
- > **Info:** You need to run `mastra worker build` or `mastra build` before using `mastra worker start`.
269
+ > **Note:** You need to run `mastra worker build` or `mastra build` before using `mastra worker start`.
270
270
 
271
271
  Starts a worker process from a previously built bundle. The optional `name` argument sets `MASTRA_WORKERS` in the spawned process, controlling which worker starts.
272
272
 
@@ -609,7 +609,7 @@ Emit machine-readable JSON.
609
609
 
610
610
  ## `mastra studio deploy`
611
611
 
612
- > **Info:** `mastra studio deploy` continues to work but is superseded by [`mastra deploy`](#mastra-deploy), which supports environments (`--env staging`, `--env production`) on a single project. New setups should use `mastra deploy`.
612
+ > **Note:** `mastra studio deploy` continues to work but is superseded by [`mastra deploy`](#mastra-deploy), which supports environments (`--env staging`, `--env production`) on a single project. New setups should use `mastra deploy`.
613
613
 
614
614
  Builds and deploys your project to Mastra platform. Requires authentication via [`mastra auth login`](#mastra-auth-login) or a `MASTRA_API_TOKEN` environment variable.
615
615
 
@@ -727,7 +727,7 @@ Creates a new project through an interactive prompt. This command doesn't accept
727
727
 
728
728
  ## `mastra server deploy`
729
729
 
730
- > **Info:** `mastra server deploy` continues to work but is superseded by [`mastra deploy`](#mastra-deploy), which deploys a single project to multiple environments instead of separate Studio and Server commands. New setups should use `mastra deploy`.
730
+ > **Note:** `mastra server deploy` continues to work but is superseded by [`mastra deploy`](#mastra-deploy), which deploys a single project to multiple environments instead of separate Studio and Server commands. New setups should use `mastra deploy`.
731
731
 
732
732
  Builds and deploys your project to Server on Mastra platform. Works the same as [`mastra studio deploy`](#mastra-studio-deploy) with the same flags, arguments, and resolution logic.
733
733