@mastra/mcp-docs-server 1.2.2-alpha.4 → 1.2.2-alpha.5

package/.docs/docs/agents/background-tasks.md

@@ -49,7 +49,7 @@ Once a tool has opted in, the LLM can optionally include a `_background` field i
 
 ### Tool-level
 
-Set `backgroundTasks.enabled: true` on the tool definition. Tools opted in at this layer run in the background whenever called by an agent that has the manager enabled.
+Set `background.enabled: true` on the tool definition. Tools opted in at this layer run in the background whenever called by an agent that has the manager enabled.
 
 ```typescript
 import { createTool } from '@mastra/core/tools'
@@ -59,7 +59,7 @@ export const researchTool = createTool({
   id: 'research',
   description: 'Run a long research job',
   inputSchema: z.object({ topic: z.string() }),
-  backgroundTasks: {
+  background: {
     enabled: true,
     timeoutMs: 600_000,
     maxRetries: 1,
@@ -111,7 +111,7 @@ The `_background` override is a _modifier_ on tools the developer has already op
 When a tool call is dispatched, the resolved background config is computed in this priority order:
 
 1. Agent-level `backgroundTasks.tools` entry for the tool.
-2. Tool-level `backgroundTasks` config.
+2. Tool-level `background` config.
 3. LLM `_background.enabled` override (only used to enable background dispatch when the tool was opted in at one of the layers above).
 4. Manager defaults (`defaultTimeoutMs`, `defaultRetries`).
 
@@ -200,7 +200,7 @@ const stream = await supervisor.stream('Research AI in education and write an ar
 
 ### Inheriting from the subagent
 
-If a subagent isn't listed under the supervisor's `backgroundTasks.tools` but has background-eligible tools of its own (either via tool-level `backgroundTasks.enabled: true` or its own `backgroundTasks.tools` entry) the framework still dispatches the entire subagent invocation as a background task. The supervisor inherits the subagent's intent: the subagent itself becomes the background task, and its inner tools run in the foreground inside the subagent's loop.
+If a subagent isn't listed under the supervisor's `backgroundTasks.tools` but has background-eligible tools of its own (either via tool-level `background.enabled: true` or its own `backgroundTasks.tools` entry) the framework still dispatches the entire subagent invocation as a background task. The supervisor inherits the subagent's intent: the subagent itself becomes the background task, and its inner tools run in the foreground inside the subagent's loop.
 
 The background config used for the inherited dispatch (for example `waitTimeoutMs`) is derived from the subagent's own `backgroundTasks` config.
 
@@ -285,7 +285,7 @@ The manager keeps tool executors in process memory. If the process restarts whil
 
 Each layer can register terminal-state callbacks. They don't replace one another, and success/failure hooks fire for their respective outcomes:
 
-- Tool-level `backgroundTasks.onComplete` / `onFailed`: scoped to one tool.
+- Tool-level `background.onComplete` / `onFailed`: scoped to one tool.
 - Agent-level `backgroundTasks.onTaskComplete` / `onTaskFailed`: scoped to all tasks dispatched by this agent.
 - Manager-level `onTaskComplete` / `onTaskFailed`: scoped globally.
 

package/.docs/reference/ai-sdk/workflow-snapshot-to-stream.md

@@ -0,0 +1,51 @@
+# workflowSnapshotToStream()
+
+Converts a `WorkflowState` object (as returned by `workflow.getWorkflowRunById()`) into a `ReadableStream` of AI SDK UIMessage data parts. The stream contains the same `WorkflowDataPart` and `WorkflowStepDataPart` chunks that the live [`workflowRoute()`](https://mastra.ai/reference/ai-sdk/workflow-route) produces.
+
+Use this when you want to display a completed or suspended workflow run using the same UI components that render live workflow streams.
+
+## Usage example
+
+Next.js App Router endpoint that replays a past workflow run as a stream:
+
+```typescript
+import { workflowSnapshotToStream } from '@mastra/ai-sdk'
+import { createUIMessageStreamResponse } from 'ai'
+import { mastra } from '@/src/mastra'
+
+export async function GET(req: Request) {
+  const { searchParams } = new URL(req.url)
+  const runId = searchParams.get('runId')!
+
+  const workflowRun = await mastra.getWorkflow('myWorkflow').getWorkflowRunById(runId)
+
+  if (!workflowRun) {
+    return new Response('Not found', { status: 404 })
+  }
+
+  const stream = workflowSnapshotToStream(workflowRun)
+  return createUIMessageStreamResponse({ stream })
+}
+```
+
+## Parameters
+
+**workflowRun** (`WorkflowState`): The workflow run state object, as returned by \`getWorkflowRunById()\` or the workflow runs API. Contains \`runId\`, \`workflowName\`, \`status\`, and \`steps\`.
+
+## Returns
+
+`ReadableStream` — A stream of AI SDK UIMessage data parts containing:
+
+- A `start` marker
+- A `WorkflowDataPart` with the overall workflow status and all step summaries
+- A `WorkflowStepDataPart` for each step with its full output
+- A `finish` marker
+
+Pass this stream to [`createUIMessageStreamResponse()`](https://ai-sdk.dev/docs/reference/ai-sdk-ui/create-ui-message-stream-response) or `createUIMessageStream()` from the AI SDK.
+
+## Related
+
+- [`workflowRoute()`](https://mastra.ai/reference/ai-sdk/workflow-route): Stream live workflow runs
+- [`handleWorkflowStream()`](https://mastra.ai/reference/ai-sdk/handle-workflow-stream): Framework-agnostic handler for live workflow streaming
+- [`toAISdkStream()`](https://mastra.ai/reference/ai-sdk/to-ai-sdk-stream): Convert live Mastra streams to AI SDK format
+- [`toAISdkMessages()`](https://mastra.ai/reference/ai-sdk/to-ai-sdk-messages): Convert stored agent messages to AI SDK format

package/.docs/reference/cli/mastra.md

@@ -666,6 +666,14 @@ Target a specific Mastra server URL.
 mastra api --url https://example.com agent list
 ```
 
+#### `--server-api-prefix <prefix>`
+
+Set the API route prefix of the target server. Defaults to `/api`. Use this when the server is mounted under a custom prefix (for example a `@mastra/fastify` `MastraServer` with `prefix: "/api/mastra-studio"`), the same way `mastra studio` accepts `--server-api-prefix`. You can also set the `MASTRA_API_PREFIX` environment variable instead of passing the flag.
+
+```bash
+mastra api --url https://example.com --server-api-prefix /api/mastra-studio agent list
+```
+
 #### `--header <"Key: Value">`
 
 Send a custom HTTP header. Repeat the flag to send multiple headers.

package/.docs/reference/index.md

@@ -40,6 +40,7 @@ The Reference section provides documentation of Mastra's API, including paramete
 - [toAISdkV5Messages()](https://mastra.ai/reference/ai-sdk/to-ai-sdk-v5-messages)
 - [withMastra()](https://mastra.ai/reference/ai-sdk/with-mastra)
 - [workflowRoute()](https://mastra.ai/reference/ai-sdk/workflow-route)
+- [workflowSnapshotToStream()](https://mastra.ai/reference/ai-sdk/workflow-snapshot-to-stream)
 - [Auth0](https://mastra.ai/reference/auth/auth0)
 - [Better Auth](https://mastra.ai/reference/auth/better-auth)
 - [Clerk](https://mastra.ai/reference/auth/clerk)

package/CHANGELOG.md

@@ -1,5 +1,12 @@
 # @mastra/mcp-docs-server
 
+## 1.2.2-alpha.5
+
+### Patch Changes
+
+- Updated dependencies [[`bf3fe49`](https://github.com/mastra-ai/mastra/commit/bf3fe49f9467dbbdb8f9eaf74e0f7971ffb19559), [`24ceaea`](https://github.com/mastra-ai/mastra/commit/24ceaea0bdd8609cabbab764380608ca6621a194), [`6ccf67b`](https://github.com/mastra-ai/mastra/commit/6ccf67bf075753754927a57bc2e1734ba2c820c5), [`825d8de`](https://github.com/mastra-ai/mastra/commit/825d8def9fa64c2bcc3d8dd6b49e09342c3ac5c7), [`ffa09e7`](https://github.com/mastra-ai/mastra/commit/ffa09e772a5c92270eabe2090fc42d45bd8ec4b7), [`461a7c5`](https://github.com/mastra-ai/mastra/commit/461a7c501449295287f4f0ee4b0b42344f39fcf8), [`4211472`](https://github.com/mastra-ai/mastra/commit/4211472a5a2bd319c60cd2e42d9109c3eef7ac1c), [`9e45902`](https://github.com/mastra-ai/mastra/commit/9e4590208e745055cecca202e2db0e5c65e17d3c), [`5c0df77`](https://github.com/mastra-ai/mastra/commit/5c0df776c40efa420f8c07a2f3ee66010296618e)]:
+  - @mastra/core@1.47.0-alpha.3
+
 ## 1.2.2-alpha.3
 
 ### Patch Changes

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mastra/mcp-docs-server",
-  "version": "1.2.2-alpha.4",
+  "version": "1.2.2-alpha.5",
   "description": "MCP server for accessing Mastra.ai documentation, changelogs, and news.",
   "type": "module",
   "main": "dist/index.js",
@@ -28,7 +28,7 @@
     "jsdom": "^26.1.0",
     "local-pkg": "^1.1.2",
     "zod": "^4.4.3",
-    "@mastra/core": "1.47.0-alpha.2",
+    "@mastra/core": "1.47.0-alpha.3",
     "@mastra/mcp": "^1.12.0"
   },
   "devDependencies": {
@@ -45,9 +45,9 @@
     "tsx": "^4.22.4",
     "typescript": "^6.0.3",
     "vitest": "4.1.8",
-    "@mastra/core": "1.47.0-alpha.2",
+    "@internal/lint": "0.0.108",
     "@internal/types-builder": "0.0.83",
-    "@internal/lint": "0.0.108"
+    "@mastra/core": "1.47.0-alpha.3"
   },
   "homepage": "https://mastra.ai",
   "repository": {