@mastra/mcp-docs-server 1.0.0-beta.1 → 1.0.0-beta.11

package/.docs/raw/reference/agents/network.mdx

@@ -1,8 +1,10 @@
 ---
-title: "Reference: Agent.network() | Agents | Mastra Docs"
+title: "Reference: Agent.network() | Agents"
 description: "Documentation for the `Agent.network()` method in Mastra agents, which enables multi-agent collaboration and routing."
 ---
 
+import { MODEL_SETTINGS_OBJECT } from "@site/src/components/ModelSettingsProperties";
+
 # Agent.network()
 
 :::caution Experimental Feature
@@ -15,7 +17,6 @@ The `.network()` method enables multi-agent collaboration and routing. This meth
 
 ```typescript copy
 import { Agent } from "@mastra/core/agent";
-import { openai } from "@ai-sdk/openai";
 import { agent1, agent2 } from "./agents";
 import { workflow1 } from "./workflows";
 import { tool1, tool2 } from "./tools";
@@ -25,7 +26,7 @@ const agent = new Agent({
   name: "Network Agent",
   instructions:
     "You are a network agent that can help users with a variety of tasks.",
-  model: openai("gpt-4o"),
+  model: "openai/gpt-5.1",
   agents: {
     agent1,
     agent2,
@@ -40,7 +41,7 @@ const agent = new Agent({
 });
 
 await agent.network(`
-  Find me the weather in Tokyo. 
+  Find me the weather in Tokyo.
   Based on the weather, plan an activity for me.
 `);
 ```
@@ -153,146 +154,106 @@ await agent.network(`
             },
           ],
         },
-      ],
-    },
-    {
-      name: "telemetry",
-      type: "TelemetrySettings",
-      isOptional: true,
-      description:
-        "Settings for OTLP telemetry collection during streaming (not Tracing).",
-      properties: [
         {
           parameters: [
             {
-              name: "isEnabled",
-              type: "boolean",
+              name: "requestContextKeys",
+              type: "string[]",
               isOptional: true,
               description:
-                "Enable or disable telemetry. Disabled by default while experimental.",
+                "Additional RequestContext keys to extract as metadata for this trace. Supports dot notation for nested values (e.g., 'user.id').",
             },
           ],
         },
         {
           parameters: [
             {
-              name: "recordInputs",
-              type: "boolean",
+              name: "traceId",
+              type: "string",
               isOptional: true,
               description:
-                "Enable or disable input recording. Enabled by default. You might want to disable input recording to avoid recording sensitive information.",
+                "Trace ID to use for this execution (1-32 hexadecimal characters). If provided, this trace will be part of the specified trace.",
             },
           ],
         },
         {
           parameters: [
             {
-              name: "recordOutputs",
-              type: "boolean",
+              name: "parentSpanId",
+              type: "string",
               isOptional: true,
               description:
-                "Enable or disable output recording. Enabled by default. You might want to disable output recording to avoid recording sensitive information.",
+                "Parent span ID to use for this execution (1-16 hexadecimal characters). If provided, the root span will be created as a child of this span.",
             },
           ],
         },
         {
           parameters: [
             {
-              name: "functionId",
-              type: "string",
+              name: "tags",
+              type: "string[]",
               isOptional: true,
               description:
-                "Identifier for this function. Used to group telemetry data by function.",
+                "Tags to apply to this trace. String labels for categorizing and filtering traces.",
             },
           ],
         },
       ],
     },
     {
-      name: "modelSettings",
-      type: "CallSettings",
+      name: "telemetry",
+      type: "TelemetrySettings",
       isOptional: true,
       description:
-        "Model-specific settings like temperature, maxTokens, topP, etc. These are passed to the underlying language model.",
+        "Settings for OTLP telemetry collection during streaming (not Tracing).",
       properties: [
         {
           parameters: [
             {
-              name: "temperature",
-              type: "number",
-              isOptional: true,
-              description:
-                "Controls randomness in the model's output. Higher values (e.g., 0.8) make the output more random, lower values (e.g., 0.2) make it more focused and deterministic.",
-            },
-          ],
-        },
-        {
-          parameters: [
-            {
-              name: "maxRetries",
-              type: "number",
-              isOptional: true,
-              description: "Maximum number of retries for failed requests.",
-            },
-          ],
-        },
-        {
-          parameters: [
-            {
-              name: "topP",
-              type: "number",
-              isOptional: true,
-              description:
-                "Nucleus sampling. This is a number between 0 and 1. It is recommended to set either temperature or topP, but not both.",
-            },
-          ],
-        },
-        {
-          parameters: [
-            {
-              name: "topK",
-              type: "number",
+              name: "isEnabled",
+              type: "boolean",
               isOptional: true,
               description:
-                "Only sample from the top K options for each subsequent token. Used to remove 'long tail' low probability responses.",
+                "Enable or disable telemetry. Disabled by default while experimental.",
             },
           ],
         },
         {
           parameters: [
             {
-              name: "presencePenalty",
-              type: "number",
+              name: "recordInputs",
+              type: "boolean",
               isOptional: true,
               description:
-                "Presence penalty setting. It affects the likelihood of the model to repeat information that is already in the prompt. A number between -1 (increase repetition) and 1 (maximum penalty, decrease repetition).",
+                "Enable or disable input recording. Enabled by default. You might want to disable input recording to avoid recording sensitive information.",
             },
           ],
         },
         {
           parameters: [
             {
-              name: "frequencyPenalty",
-              type: "number",
+              name: "recordOutputs",
+              type: "boolean",
               isOptional: true,
               description:
-                "Frequency penalty setting. It affects the likelihood of the model to repeatedly use the same words or phrases. A number between -1 (increase repetition) and 1 (maximum penalty, decrease repetition).",
+                "Enable or disable output recording. Enabled by default. You might want to disable output recording to avoid recording sensitive information.",
             },
           ],
         },
         {
           parameters: [
             {
-              name: "stopSequences",
-              type: "string[]",
+              name: "functionId",
+              type: "string",
               isOptional: true,
               description:
-                "Stop sequences. If set, the model will stop generating text when one of the stop sequences is generated.",
+                "Identifier for this function. Used to group telemetry data by function.",
             },
           ],
         },
       ],
     },
+    MODEL_SETTINGS_OBJECT,
     {
       name: "runId",
       type: "string",

package/.docs/raw/reference/ai-sdk/chat-route.mdx

@@ -0,0 +1,127 @@
+---
+title: "Reference: chatRoute() | AI SDK"
+description: API reference for chatRoute(), a function to create chat route handlers for streaming agent conversations in AI SDK-compatible format.
+---
+
+import PropertiesTable from "@site/src/components/PropertiesTable";
+
+# chatRoute()
+
+Creates a chat route handler for streaming agent conversations using the AI SDK format. This function registers an HTTP `POST` endpoint that accepts messages, executes an agent, and streams the response back to the client in AI SDK-compatible format. You have to use it inside a [custom API route](/docs/v1/server-db/custom-api-routes).
+
+Use [`handleChatStream()`](/reference/v1/ai-sdk/handle-chat-stream) if you need a framework-agnostic handler.
+
+## Usage example
+
+This example shows how to set up a chat route at the `/chat` endpoint that uses an agent with the ID `weatherAgent`.
+
+```typescript title="src/mastra/index.ts" copy
+import { Mastra } from "@mastra/core";
+import { chatRoute } from "@mastra/ai-sdk";
+
+export const mastra = new Mastra({
+  server: {
+    apiRoutes: [
+      chatRoute({
+        path: "/chat",
+        agent: "weatherAgent",
+      }),
+    ],
+  },
+});
+```
+
+You can also use dynamic agent routing based on an `agentId`. The URL `/chat/weatherAgent` will resolve to the agent with the ID `weatherAgent`.
+
+```typescript title="src/mastra/index.ts" copy
+import { Mastra } from "@mastra/core";
+import { chatRoute } from "@mastra/ai-sdk";
+
+export const mastra = new Mastra({
+  server: {
+    apiRoutes: [
+      chatRoute({
+        path: "/chat/:agentId",
+      }),
+    ],
+  },
+});
+```
+
+## Parameters
+
+<PropertiesTable
+  content={[
+    {
+      name: "path",
+      type: "string",
+      description: "The route path (e.g., `/chat` or `/chat/:agentId`). Include `:agentId` for dynamic agent routing.",
+      isOptional: false,
+      defaultValue: "'/chat/:agentId'",
+    },
+    {
+      name: "agent",
+      type: "string",
+      description: "The ID of the agent to use for this chat route. Required if the path doesn't include `:agentId`.",
+      isOptional: true,
+    },
+    {
+      name: "defaultOptions",
+      type: "AgentExecutionOptions",
+      description: "Default options passed to agent execution. These can include instructions, memory configuration, maxSteps, and other execution settings.",
+      isOptional: true,
+    },
+    {
+      name: "sendStart",
+      type: "boolean",
+      description: "Whether to send start events in the stream.",
+      isOptional: true,
+      defaultValue: "true",
+    },
+    {
+      name: "sendFinish",
+      type: "boolean",
+      description: "Whether to send finish events in the stream.",
+      isOptional: true,
+      defaultValue: "true",
+    },
+    {
+      name: "sendReasoning",
+      type: "boolean",
+      description: "Whether to include reasoning steps in the stream.",
+      isOptional: true,
+      defaultValue: "false",
+    },
+    {
+      name: "sendSources",
+      type: "boolean",
+      description: "Whether to include source citations in the stream.",
+      isOptional: true,
+      defaultValue: "false",
+    },
+  ]}
+/>
+
+## Additional configuration
+
+You can use [`prepareSendMessagesRequest`](https://ai-sdk.dev/docs/reference/ai-sdk-ui/use-chat#transport.default-chat-transport.prepare-send-messages-request) to customize the request sent to the chat route, for example to pass additional configuration to the agent:
+
+```typescript
+const { error, status, sendMessage, messages, regenerate, stop } = useChat({
+  transport: new DefaultChatTransport({
+    api: "http://localhost:4111/chat",
+    prepareSendMessagesRequest({ messages }) {
+      return {
+        body: {
+          messages,
+          // Pass memory config
+          memory: {
+            thread: "user-1",
+            resource: "user-1",
+          },
+        },
+      };
+    },
+  }),
+});
+```

package/.docs/raw/reference/ai-sdk/handle-chat-stream.mdx

@@ -0,0 +1,117 @@
+---
+title: "Reference: handleChatStream() | AI SDK"
+description: API reference for handleChatStream(), a framework-agnostic handler for streaming agent chat in AI SDK-compatible format.
+---
+
+import PropertiesTable from "@site/src/components/PropertiesTable";
+
+# handleChatStream()
+
+Framework-agnostic handler for streaming agent chat in AI SDK-compatible format. Use this function directly when you need to handle chat streaming outside Hono or Mastra's own [apiRoutes](/docs/v1/server-db/custom-api-routes) feature. 
+
+`handleChatStream()` returns a `ReadableStream` that you can wrap with [`createUIMessageStreamResponse()`](https://ai-sdk.dev/docs/reference/ai-sdk-ui/create-ui-message-stream-response).
+
+Use [`chatRoute()`](/reference/v1/ai-sdk/chat-route) if you want to create a chat route inside a Mastra server.
+
+## Usage example
+
+Next.js App Router example:
+
+```typescript title="app/api/chat/route.ts" copy
+import { handleChatStream } from '@mastra/ai-sdk';
+import { createUIMessageStreamResponse } from 'ai';
+import { mastra } from '@/src/mastra';
+
+export async function POST(req: Request) {
+  const params = await req.json();
+  const stream = await handleChatStream({
+    mastra,
+    agentId: 'weatherAgent',
+    params,
+  });
+  return createUIMessageStreamResponse({ stream });
+}
+```
+
+## Parameters
+
+<PropertiesTable
+  content={[
+    {
+      name: "mastra",
+      type: "Mastra",
+      description: "The Mastra instance containing registered agents.",
+      isOptional: false,
+    },
+    {
+      name: "agentId",
+      type: "string",
+      description: "The ID of the agent to use for chat.",
+      isOptional: false,
+    },
+    {
+      name: "params",
+      type: "ChatStreamHandlerParams",
+      description: "Parameters for the chat stream, including messages and optional resume data.",
+      isOptional: false,
+    },
+    {
+      name: "params.messages",
+      type: "UIMessage[]",
+      description: "Array of messages in the conversation.",
+      isOptional: false,
+    },
+    {
+      name: "params.resumeData",
+      type: "Record<string, any>",
+      description: "Data for resuming a suspended agent execution. Requires `runId` to be set.",
+      isOptional: true,
+    },
+    {
+      name: "params.runId",
+      type: "string",
+      description: "The run ID. Required when `resumeData` is provided.",
+      isOptional: true,
+    },
+    {
+      name: "params.requestContext",
+      type: "RequestContext",
+      description: "Request context to pass to the agent execution.",
+      isOptional: true,
+    },
+    {
+      name: "defaultOptions",
+      type: "AgentExecutionOptions",
+      description: "Default options passed to agent execution. These are merged with params, with params taking precedence.",
+      isOptional: true,
+    },
+    {
+      name: "sendStart",
+      type: "boolean",
+      description: "Whether to send start events in the stream.",
+      isOptional: true,
+      defaultValue: "true",
+    },
+    {
+      name: "sendFinish",
+      type: "boolean",
+      description: "Whether to send finish events in the stream.",
+      isOptional: true,
+      defaultValue: "true",
+    },
+    {
+      name: "sendReasoning",
+      type: "boolean",
+      description: "Whether to include reasoning steps in the stream.",
+      isOptional: true,
+      defaultValue: "false",
+    },
+    {
+      name: "sendSources",
+      type: "boolean",
+      description: "Whether to include source citations in the stream.",
+      isOptional: true,
+      defaultValue: "false",
+    },
+  ]}
+/>

package/.docs/raw/reference/ai-sdk/handle-network-stream.mdx

@@ -0,0 +1,64 @@
+---
+title: "Reference: handleNetworkStream() | AI SDK"
+description: API reference for handleNetworkStream(), a framework-agnostic handler for streaming network execution in AI SDK-compatible format.
+---
+
+import PropertiesTable from "@site/src/components/PropertiesTable";
+
+# handleNetworkStream()
+
+Framework-agnostic handler for streaming network execution in AI SDK-compatible format. Use this function directly when you need to handle network streaming outside Hono or Mastra's own [apiRoutes](/docs/v1/server-db/custom-api-routes) feature. 
+
+`handleNetworkStream()` returns a `ReadableStream` that you can wrap with [`createUIMessageStreamResponse()`](https://ai-sdk.dev/docs/reference/ai-sdk-ui/create-ui-message-stream-response).
+
+Use [`networkRoute()`](/reference/v1/ai-sdk/network-route) if you want to create a network route inside a Mastra server.
+## Usage example
+
+Next.js App Router example:
+
+```typescript title="app/api/network/route.ts" copy
+import { handleNetworkStream } from '@mastra/ai-sdk';
+import { createUIMessageStreamResponse } from 'ai';
+import { mastra } from '@/src/mastra';
+
+export async function POST(req: Request) {
+  const params = await req.json();
+  const stream = await handleNetworkStream({
+    mastra,
+    agentId: 'routingAgent',
+    params,
+  });
+  return createUIMessageStreamResponse({ stream });
+}
+```
+
+## Parameters
+
+<PropertiesTable
+  content={[
+    {
+      name: "mastra",
+      type: "Mastra",
+      description: "The Mastra instance to use for agent lookup and execution.",
+      isOptional: false,
+    },
+    {
+      name: "agentId",
+      type: "string",
+      description: "The ID of the routing agent to execute as a network.",
+      isOptional: false,
+    },
+    {
+      name: "params",
+      type: "NetworkStreamHandlerParams",
+      description: "The request parameters containing messages and execution options. Includes `messages` (required) and any AgentExecutionOptions like `memory`, `maxSteps`, `runId`, etc.",
+      isOptional: false,
+    },
+    {
+      name: "defaultOptions",
+      type: "AgentExecutionOptions",
+      description: "Default options passed to agent execution. These are merged with params, with params taking precedence.",
+      isOptional: true,
+    },
+  ]}
+/>

package/.docs/raw/reference/ai-sdk/handle-workflow-stream.mdx

@@ -0,0 +1,116 @@
+---
+title: "Reference: handleWorkflowStream() | AI SDK"
+description: API reference for handleWorkflowStream(), a framework-agnostic handler for streaming workflow execution in AI SDK-compatible format.
+---
+
+import PropertiesTable from "@site/src/components/PropertiesTable";
+
+# handleWorkflowStream()
+
+Framework-agnostic handler for streaming workflow execution in AI SDK-compatible format. Use this function directly when you need to handle workflow streaming outside Hono or Mastra's own [apiRoutes](/docs/v1/server-db/custom-api-routes) feature. 
+
+`handleWorkflowStream()` returns a `ReadableStream` that you can wrap with [`createUIMessageStreamResponse()`](https://ai-sdk.dev/docs/reference/ai-sdk-ui/create-ui-message-stream-response).
+
+Use [`workflowRoute()`](/reference/v1/ai-sdk/workflow-route) if you want to create a workflow route inside a Mastra server.
+
+:::tip Agent streaming in workflows
+
+When a workflow step pipes an agent's stream to the workflow writer (e.g., `await response.fullStream.pipeTo(writer)`), the agent's text chunks and tool calls are forwarded to the UI stream in real time, even when the agent runs inside workflow steps.
+
+See [Workflow Streaming](/docs/v1/streaming/workflow-streaming#streaming-agent-text-chunks-to-ui) for more details.
+
+:::
+
+## Usage example
+
+Next.js App Router example:
+
+```typescript title="app/api/workflow/route.ts" copy
+import { handleWorkflowStream } from '@mastra/ai-sdk';
+import { createUIMessageStreamResponse } from 'ai';
+import { mastra } from '@/src/mastra';
+
+export async function POST(req: Request) {
+  const params = await req.json();
+  const stream = await handleWorkflowStream({
+    mastra,
+    workflowId: 'weatherWorkflow',
+    params,
+  });
+  return createUIMessageStreamResponse({ stream });
+}
+```
+
+## Parameters
+
+<PropertiesTable
+  content={[
+    {
+      name: "mastra",
+      type: "Mastra",
+      description: "The Mastra instance containing registered workflows.",
+      isOptional: false,
+    },
+    {
+      name: "workflowId",
+      type: "string",
+      description: "The ID of the workflow to execute.",
+      isOptional: false,
+    },
+    {
+      name: "params",
+      type: "WorkflowStreamHandlerParams",
+      description: "Parameters for the workflow stream.",
+      isOptional: false,
+    },
+    {
+      name: "params.runId",
+      type: "string",
+      description: "Optional run ID for the workflow execution.",
+      isOptional: true,
+    },
+    {
+      name: "params.resourceId",
+      type: "string",
+      description: "Optional resource ID for the workflow run.",
+      isOptional: true,
+    },
+    {
+      name: "params.inputData",
+      type: "Record<string, any>",
+      description: "Input data for starting a new workflow execution.",
+      isOptional: true,
+    },
+    {
+      name: "params.resumeData",
+      type: "Record<string, any>",
+      description: "Data for resuming a suspended workflow execution.",
+      isOptional: true,
+    },
+    {
+      name: "params.requestContext",
+      type: "RequestContext",
+      description: "Request context to pass to the workflow execution.",
+      isOptional: true,
+    },
+    {
+      name: "params.tracingOptions",
+      type: "TracingOptions",
+      description: "Options for tracing and observability.",
+      isOptional: true,
+    },
+    {
+      name: "params.step",
+      type: "string",
+      description: "Specific step to target in the workflow.",
+      isOptional: true,
+    },
+    {
+      name: "includeTextStreamParts",
+      type: "boolean",
+      description: "Whether to include text stream parts in the output.",
+      isOptional: true,
+      defaultValue: "true",
+    },
+  ]}
+/>