@mastra/mcp-docs-server 0.13.22-alpha.3 → 0.13.22-alpha.4

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

@@ -0,0 +1,258 @@
+---
+title: "Reference: Agent.network() (Experimental) | Agents | Mastra Docs"
+description: "Documentation for the `Agent.network()` method in Mastra agents, which enables multi-agent collaboration and routing."
+---
+
+import { NetworkCallout } from "@/components/network-callout.tsx"
+
+# Agent.network()
+
+<NetworkCallout />
+
+The `.network()` method enables multi-agent collaboration and routing. This method accepts messages and optional execution options.
+
+## Usage example
+
+```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';
+
+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'),
+  agents: {
+    agent1,
+    agent2,
+  },
+  workflows: {
+    workflow1,
+  },
+  tools: {
+    tool1,
+    tool2,
+  },
+})
+
+await agent.network(`
+  Find me the weather in Tokyo. 
+  Based on the weather, plan an activity for me.
+`);
+```
+
+## Parameters
+
+<PropertiesTable
+  content={[
+    {
+      name: "messages",
+      type: "string | string[] | CoreMessage[] | AiMessageType[] | UIMessageWithMetadata[]",
+      description: "The messages to send to the agent. Can be a single string, array of strings, or structured message objects.",
+    },
+    {
+      name: "options",
+      type: "MultiPrimitiveExecutionOptions",
+      isOptional: true,
+      description: "Optional configuration for the network process.",
+    },
+  ]}
+/>
+
+### Options
+
+<PropertiesTable
+  content={[
+    {
+      name: "maxSteps",
+      type: "number",
+      isOptional: true,
+      description: "Maximum number of steps to run during execution.",
+    },
+    {
+      name: "memory",
+      type: "object",
+      isOptional: true,
+      description: "Configuration for memory. This is the preferred way to manage memory.",
+      properties: [
+        {
+          parameters: [{
+              name: "thread",
+              type: "string | { id: string; metadata?: Record<string, any>, title?: string }",
+              isOptional: false,
+              description: "The conversation thread, as a string ID or an object with an `id` and optional `metadata`."
+          }]
+        },
+        {
+          parameters: [{
+              name: "resource",
+              type: "string",
+              isOptional: false,
+              description: "Identifier for the user or resource associated with the thread."
+          }]
+        },
+        {
+          parameters: [{
+              name: "options",
+              type: "MemoryConfig",
+              isOptional: true,
+              description: "Configuration for memory behavior, like message history and semantic recall."
+          }]
+        }
+      ]
+    },
+    {
+      name: "tracingContext",
+      type: "TracingContext",
+      isOptional: true,
+      description: "AI tracing context for span hierarchy and metadata.",
+    },
+    {
+      name: "telemetry",
+      type: "TelemetrySettings",
+      isOptional: true,
+      description:
+        "Settings for telemetry collection during streaming.",
+      properties: [
+        {
+          parameters: [{
+            name: "isEnabled",
+            type: "boolean",
+            isOptional: true,
+            description: "Enable or disable telemetry. Disabled by default while experimental."
+          }]
+        },
+        {
+          parameters: [{
+            name: "recordInputs",
+            type: "boolean",
+            isOptional: true,
+            description: "Enable or disable input recording. Enabled by default. You might want to disable input recording to avoid recording sensitive information."
+          }]
+        },
+        {
+          parameters: [{
+            name: "recordOutputs",
+            type: "boolean",
+            isOptional: true,
+            description: "Enable or disable output recording. Enabled by default. You might want to disable output recording to avoid recording sensitive information."
+          }]
+        },
+        {
+          parameters: [{
+            name: "functionId",
+            type: "string",
+            isOptional: true,
+            description: "Identifier for this function. Used to group telemetry data by function."
+          }]
+        }
+      ]
+    },
+    {
+      name: "modelSettings",
+      type: "CallSettings",
+      isOptional: true,
+      description:
+        "Model-specific settings like temperature, maxTokens, topP, etc. These are passed to the underlying language model.",
+      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",
+            isOptional: true,
+            description: "Only sample from the top K options for each subsequent token. Used to remove 'long tail' low probability responses."
+          }]
+        },
+        {
+          parameters: [{
+            name: "presencePenalty",
+            type: "number",
+            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)."
+          }]
+        },
+        {
+          parameters: [{
+            name: "frequencyPenalty",
+            type: "number",
+            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)."
+          }]
+        },
+        {
+          parameters: [{
+            name: "stopSequences",
+            type: "string[]",
+            isOptional: true,
+            description: "Stop sequences. If set, the model will stop generating text when one of the stop sequences is generated."
+          }]
+        },
+      ]
+    },
+    {
+      name: "runId",
+      type: "string",
+      isOptional: true,
+      description: "Unique ID for this generation run. Useful for tracking and debugging purposes.",
+    },
+    {
+      name: "runtimeContext",
+      type: "RuntimeContext",
+      isOptional: true,
+      description: "Runtime context for dependency injection and contextual information.",
+    },
+  ]}
+/>
+
+## Returns
+
+<PropertiesTable
+  content={[
+    {
+      name: "stream",
+      type: "MastraAgentNetworkStream<NetworkChunkType>",
+      description: "A custom stream that extends ReadableStream<NetworkChunkType> with additional network-specific properties",
+    },
+    {
+      name: "status",
+      type: "Promise<RunStatus>",
+      description: "A promise that resolves to the current workflow run status",
+    },
+    {
+      name: "result",
+      type: "Promise<WorkflowResult<TOutput, TSteps>>",
+      description: "A promise that resolves to the final workflow result",
+    },
+    {
+      name: "usage",
+      type: "Promise<{ promptTokens: number; completionTokens: number; totalTokens: number }>",
+      description: "A promise that resolves to token usage statistics",
+    },
+  ]}
+/>

package/.docs/raw/reference/storage/dynamodb.mdx

@@ -194,7 +194,3 @@ This implementation uses a single-table design pattern with ElectroDB, which off
 3.  **Simplified administration:** Fewer distinct tables to monitor, back up, and manage.
 4.  **Reduced complexity in access patterns:** ElectroDB helps manage the complexity of item types and access patterns on a single table.
 5.  **Transaction support:** DynamoDB transactions can be used across different "entity" types stored within the same table if needed.
-
-## License
-
-This package is distributed under the MIT License. See [LICENSE.md](https://github.com/mastra-ai/mastra/blob/main/LICENSE.md) for more information.

package/.docs/raw/reference/{agents → streaming}/ChunkType.mdx

@@ -1,15 +1,15 @@
 ---
-title: "Reference: ChunkType | Agents | Mastra Docs"
+title: "Reference: ChunkType (Experimental) | Agents | Mastra Docs"
 description: "Documentation for the ChunkType type used in Mastra streaming responses, defining all possible chunk types and their payloads."
 ---
 
 import { Callout } from "nextra/components";
 import { PropertiesTable } from "@/components/properties-table";
 
-# ChunkType
+# ChunkType (Experimental)
 
-<Callout type="warning">
-  **Experimental API**: This type is part of the experimental [`streamVNext()`](../streamVNext) method. The API may change as we refine the feature based on feedback.
+<Callout type="important">
+  <strong className="block">Experimental API: </strong>This type is part of the experimental `.streamVNext()` method. The API may change as we refine the feature based on feedback.
 </Callout>
 
 The `ChunkType` type defines the mastra format of stream chunks that can be emitted during streaming responses from agents.
@@ -854,4 +854,4 @@ for await (const chunk of stream.fullStream) {
 ## Related Types
 
 - [MastraModelOutput](./MastraModelOutput.mdx) - The stream object that emits these chunks
-- [Agent.streamVNext()](./streamVNext.mdx) - Method that returns streams emitting these chunks
+- [.streamVNext()](./streamVNext.mdx) - Method that returns streams emitting these chunks

package/.docs/raw/reference/{agents → streaming}/MastraModelOutput.mdx

@@ -1,25 +1,25 @@
 ---
-title: "Reference: MastraModelOutput | Agents | Mastra Docs"
+title: "Reference: MastraModelOutput (Experimental) | Agents | Mastra Docs"
 description: "Complete reference for MastraModelOutput - the stream object returned by agent.streamVNext() with streaming and promise-based access to model outputs."
 ---
 
 import { Callout } from "nextra/components";
 import { PropertiesTable } from "@/components/properties-table";
 
-# MastraModelOutput
+# MastraModelOutput (Experimental)
 
-<Callout type="warning">
-  **Experimental API**: This type is part of the experimental [`streamVNext()`](/reference/agents/streamVNext) method. The API may change as we refine the feature based on feedback.
+<Callout type="important">
+  <strong className="block">Experimental API: </strong>This type is part of the experimental `.streamVNext()` method. The API may change as we refine the feature based on feedback.
 </Callout>
 
-The `MastraModelOutput` class is returned by [`agent.streamVNext()`](/reference/agents/streamVNext) and provides both streaming and promise-based access to model outputs. It supports structured output generation, tool calls, reasoning, and comprehensive usage tracking.
+The `MastraModelOutput` class is returned by [.streamVNext()](./streamVNext.mdx) and provides both streaming and promise-based access to model outputs. It supports structured output generation, tool calls, reasoning, and comprehensive usage tracking.
 
 ```typescript
 // MastraModelOutput is returned by agent.streamVNext()
 const stream = await agent.streamVNext("Hello world");
 ```
 
-For setup and basic usage, see the [streamVNext() method documentation](/reference/agents/streamVNext).
+For setup and basic usage, see the [.streamVNext()](./streamVNext.mdx) method documentation.
 
 ## Streaming Properties
 
@@ -113,7 +113,7 @@ These properties resolve to final values after the stream completes:
       type: "Promise<ToolResultChunk[]>",
       description: "Array of all tool result chunks corresponding to the tool calls. Contains execution results and error information.",
       properties: [{
-        type: "ToolResultChunk", 
+        type: "ToolResultChunk",
         parameters: [
           { name: "type", type: "'tool-result'", description: "Chunk type identifier" },
           { name: "runId", type: "string", description: "Execution run identifier" },
@@ -302,7 +302,7 @@ try {
       console.error("Stream error:", error);
     }
   });
-  
+
   const result = await stream.text;
 } catch (error) {
   console.error("Failed to get result:", error);
@@ -317,5 +317,5 @@ if (stream.error) {
 
 ## Related Types
 
-- [ChunkType](/reference/agents/ChunkType) - All possible chunk types in the full stream
-- [Agent.streamVNext()](/reference/agents/streamVNext) - Method that returns MastraModelOutput
+- [ChunkType](./ChunkType.mdx) - All possible chunk types in the full stream
+- [.streamVNext()](./streamVNext.mdx) - Method that returns MastraModelOutput

package/.docs/raw/reference/tools/mcp-server.mdx

@@ -86,7 +86,7 @@ The constructor accepts an `MCPServerConfig` object with the following propertie
       type: "Record<string, Workflow>",
       isOptional: true,
       description:
-        "An object where keys are workflow identifiers and values are Mastra Workflow instances. Each workflow is converted into a tool named `run_<workflowKey>`. The workflow's `inputSchema` becomes the tool's input schema. The workflow **must** have a non-empty `description` string property, which is used for the tool's description. If a workflow's description is missing or empty, an error will be thrown. The tool executes the workflow by calling `workflow.createRun().start({ inputData: <tool_input> })`. If a tool name derived from an agent or workflow (e.g., `ask_myAgent` or `run_myWorkflow`) collides with an explicitly defined tool name or another derived name, the explicitly defined tool takes precedence, and a warning is logged. Agents/workflows leading to subsequent collisions are skipped.",
+        "An object where keys are workflow identifiers and values are Mastra Workflow instances. Each workflow is converted into a tool named `run_<workflowKey>`. The workflow's `inputSchema` becomes the tool's input schema. The workflow **must** have a non-empty `description` string property, which is used for the tool's description. If a workflow's description is missing or empty, an error will be thrown. The tool executes the workflow by calling `workflow.createRunAsync()` followed by `run.start({ inputData: <tool_input> })`. If a tool name derived from an agent or workflow (e.g., `ask_myAgent` or `run_myWorkflow`) collides with an explicitly defined tool name or another derived name, the explicitly defined tool takes precedence, and a warning is logged. Agents/workflows leading to subsequent collisions are skipped.",
     },
     {
       name: "id",