npm - @mastra/mcp-docs-server - Versions diffs - 1.0.0-beta.2 → 1.0.0-beta.3 - Mend

@mastra/mcp-docs-server 1.0.0-beta.2 → 1.0.0-beta.3

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 (390) hide show

package/.docs/raw/reference/voice/voice.answer.mdx CHANGED Viewed

@@ -1,5 +1,5 @@
 ---
-title: "Reference: voice.answer() | Voice | Mastra Docs"
+title: "Reference: voice.answer() | Voice"
 description: "Documentation for the answer() method available in real-time voice providers, which triggers the voice provider to generate a response."
 ---

package/.docs/raw/reference/voice/voice.close.mdx CHANGED Viewed

@@ -1,5 +1,5 @@
 ---
-title: "Reference: voice.close() | Voice | Mastra Docs"
+title: "Reference: voice.close() | Voice"
 description: "Documentation for the close() method available in voice providers, which disconnects from real-time voice services."
 ---

package/.docs/raw/reference/voice/voice.connect.mdx CHANGED Viewed

@@ -1,5 +1,5 @@
 ---
-title: "Reference: voice.connect() | Voice | Mastra Docs"
+title: "Reference: voice.connect() | Voice"
 description: "Documentation for the connect() method available in real-time voice providers, which establishes a connection for speech-to-speech communication."
 ---

package/.docs/raw/reference/voice/voice.events.mdx CHANGED Viewed

@@ -1,5 +1,5 @@
 ---
-title: "Reference: Voice Events | Voice | Mastra Docs"
+title: "Reference: Voice Events | Voice"
 description: "Documentation for events emitted by voice providers, particularly for real-time voice interactions."
 ---

package/.docs/raw/reference/voice/voice.getSpeakers.mdx CHANGED Viewed

@@ -1,5 +1,5 @@
 ---
-title: "Reference: voice.getSpeakers() | Voice Providers | Mastra Docs"
+title: "Reference: voice.getSpeakers() | Voice Providers"
 description: "Documentation for the getSpeakers() method available in voice providers, which retrieves available voice options."
 ---

package/.docs/raw/reference/voice/voice.listen.mdx CHANGED Viewed

@@ -1,5 +1,5 @@
 ---
-title: "Reference: voice.listen() | Voice | Mastra Docs"
+title: "Reference: voice.listen() | Voice"
 description: "Documentation for the listen() method available in all Mastra voice providers, which converts speech to text."
 ---

package/.docs/raw/reference/voice/voice.off.mdx CHANGED Viewed

@@ -1,5 +1,5 @@
 ---
-title: "Reference: voice.off() | Voice | Mastra Docs"
+title: "Reference: voice.off() | Voice"
 description: "Documentation for the off() method available in voice providers, which removes event listeners for voice events."
 ---

package/.docs/raw/reference/voice/voice.on.mdx CHANGED Viewed

@@ -1,5 +1,5 @@
 ---
-title: "Reference: voice.on() | Voice | Mastra Docs"
+title: "Reference: voice.on() | Voice"
 description: "Documentation for the on() method available in voice providers, which registers event listeners for voice events."
 ---

package/.docs/raw/reference/voice/voice.send.mdx CHANGED Viewed

@@ -1,5 +1,5 @@
 ---
-title: "Reference: voice.send() | Voice | Mastra Docs"
+title: "Reference: voice.send() | Voice"
 description: "Documentation for the send() method available in real-time voice providers, which streams audio data for continuous processing."
 ---

package/.docs/raw/reference/voice/voice.speak.mdx CHANGED Viewed

@@ -1,5 +1,5 @@
 ---
-title: "Reference: voice.speak() | Voice | Mastra Docs"
+title: "Reference: voice.speak() | Voice"
 description: "Documentation for the speak() method available in all Mastra voice providers, which converts text to speech."
 ---

package/.docs/raw/reference/voice/voice.updateConfig.mdx CHANGED Viewed

@@ -1,5 +1,5 @@
 ---
-title: "Reference: voice.updateConfig() | Voice | Mastra Docs"
+title: "Reference: voice.updateConfig() | Voice"
 description: "Documentation for the updateConfig() method available in voice providers, which updates the configuration of a voice provider at runtime."
 ---

package/.docs/raw/reference/workflows/run-methods/cancel.mdx CHANGED Viewed

@@ -1,5 +1,5 @@
 ---
-title: "Reference: Run.cancel() | Workflows | Mastra Docs"
+title: "Reference: Run.cancel() | Workflows"
 description: Documentation for the `Run.cancel()` method in workflows, which cancels a workflow run.
 ---

package/.docs/raw/reference/workflows/run-methods/resume.mdx CHANGED Viewed

@@ -1,5 +1,5 @@
 ---
-title: "Reference: Run.resume() | Workflows | Mastra Docs"
+title: "Reference: Run.resume() | Workflows"
 description: Documentation for the `Run.resume()` method in workflows, which resumes a suspended workflow run with new data.
 ---

package/.docs/raw/reference/workflows/run-methods/start.mdx CHANGED Viewed

@@ -1,5 +1,5 @@
 ---
-title: "Reference: Run.start() | Workflows | Mastra Docs"
+title: "Reference: Run.start() | Workflows"
 description: Documentation for the `Run.start()` method in workflows, which starts a workflow run with input data.
 ---

package/.docs/raw/reference/workflows/run.mdx CHANGED Viewed

@@ -1,5 +1,5 @@
 ---
-title: "Reference: Run Class | Workflows | Mastra Docs"
+title: "Reference: Run Class | Workflows"
 description: Documentation for the Run class in Mastra, which represents a workflow execution instance.
 ---

package/.docs/raw/reference/workflows/step.mdx CHANGED Viewed

@@ -1,5 +1,5 @@
 ---
-title: "Reference: Step Class | Workflows | Mastra Docs"
+title: "Reference: Step Class | Workflows"
 description: Documentation for the Step class in Mastra, which defines individual units of work within a workflow.
 ---

package/.docs/raw/reference/workflows/workflow-methods/branch.mdx CHANGED Viewed

@@ -1,5 +1,5 @@
 ---
-title: "Reference: Workflow.branch() | Workflows | Mastra Docs"
+title: "Reference: Workflow.branch() | Workflows"
 description: Documentation for the `Workflow.branch()` method in workflows, which creates conditional branches between steps.
 ---

package/.docs/raw/reference/workflows/workflow-methods/commit.mdx CHANGED Viewed

@@ -1,5 +1,5 @@
 ---
-title: "Reference: Workflow.commit() | Workflows | Mastra Docs"
+title: "Reference: Workflow.commit() | Workflows"
 description: Documentation for the `Workflow.commit()` method in workflows, which finalizes the workflow and returns the final result.
 ---

package/.docs/raw/reference/workflows/workflow-methods/create-run.mdx CHANGED Viewed

@@ -1,5 +1,5 @@
 ---
-title: "Reference: Workflow.createRun() | Workflows | Mastra Docs"
+title: "Reference: Workflow.createRun() | Workflows"
 description: Documentation for the `Workflow.createRun()` method in workflows, which creates a new workflow run instance.
 ---

package/.docs/raw/reference/workflows/workflow-methods/dountil.mdx CHANGED Viewed

@@ -1,5 +1,5 @@
 ---
-title: "Reference: Workflow.dountil() | Workflows | Mastra Docs"
+title: "Reference: Workflow.dountil() | Workflows"
 description: Documentation for the `Workflow.dountil()` method in workflows, which creates a loop that executes a step until a condition is met.
 ---

package/.docs/raw/reference/workflows/workflow-methods/dowhile.mdx CHANGED Viewed

@@ -1,5 +1,5 @@
 ---
-title: "Reference: Workflow.dowhile() | Workflows | Mastra Docs"
+title: "Reference: Workflow.dowhile() | Workflows"
 description: Documentation for the `Workflow.dowhile()` method in workflows, which creates a loop that executes a step while a condition is met.
 ---

package/.docs/raw/reference/workflows/workflow-methods/foreach.mdx CHANGED Viewed

@@ -1,5 +1,5 @@
 ---
-title: "Reference: Workflow.foreach() | Workflows | Mastra Docs"
+title: "Reference: Workflow.foreach() | Workflows"
 description: Documentation for the `Workflow.foreach()` method in workflows, which creates a loop that executes a step for each item in an array.
 ---

package/.docs/raw/reference/workflows/workflow-methods/map.mdx CHANGED Viewed

@@ -1,5 +1,5 @@
 ---
-title: "Reference: Workflow.map() | Workflows | Mastra Docs"
+title: "Reference: Workflow.map() | Workflows"
 description: Documentation for the `Workflow.map()` method in workflows, which maps output data from a previous step to the input of a subsequent step.
 ---

package/.docs/raw/reference/workflows/workflow-methods/parallel.mdx CHANGED Viewed

@@ -1,5 +1,5 @@
 ---
-title: "Reference: Workflow.parallel() | Workflows | Mastra Docs"
+title: "Reference: Workflow.parallel() | Workflows"
 description: Documentation for the `Workflow.parallel()` method in workflows, which executes multiple steps in parallel.
 ---

package/.docs/raw/reference/workflows/workflow-methods/sendEvent.mdx CHANGED Viewed

@@ -1,5 +1,5 @@
 ---
-title: "Reference: Workflow.sendEvent() | Workflows | Mastra Docs"
+title: "Reference: Workflow.sendEvent() | Workflows"
 description: Documentation for the `Workflow.sendEvent()` method in workflows, which resumes execution when an event is sent.
 ---

package/.docs/raw/reference/workflows/workflow-methods/sleep.mdx CHANGED Viewed

@@ -1,5 +1,5 @@
 ---
-title: "Reference: Workflow.sleep() | Workflows | Mastra Docs"
+title: "Reference: Workflow.sleep() | Workflows"
 description: Documentation for the `Workflow.sleep()` method in workflows, which pauses execution for a specified number of milliseconds.
 ---

package/.docs/raw/reference/workflows/workflow-methods/sleepUntil.mdx CHANGED Viewed

@@ -1,5 +1,5 @@
 ---
-title: "Reference: Workflow.sleepUntil() | Workflows | Mastra Docs"
+title: "Reference: Workflow.sleepUntil() | Workflows"
 description: Documentation for the `Workflow.sleepUntil()` method in workflows, which pauses execution until a specified date.
 ---

package/.docs/raw/reference/workflows/workflow-methods/then.mdx CHANGED Viewed

@@ -1,5 +1,5 @@
 ---
-title: "Reference: Workflow.then() | Workflows | Mastra Docs"
+title: "Reference: Workflow.then() | Workflows"
 description: Documentation for the `Workflow.then()` method in workflows, which creates sequential dependencies between steps.
 ---

package/.docs/raw/reference/workflows/workflow-methods/waitForEvent.mdx CHANGED Viewed

@@ -1,5 +1,5 @@
 ---
-title: "Reference: Workflow.waitForEvent() | Workflows | Mastra Docs"
+title: "Reference: Workflow.waitForEvent() | Workflows"
 description: Documentation for the `Workflow.waitForEvent()` method in workflows, which pauses execution until an event is received.
 ---

package/.docs/raw/reference/workflows/workflow.mdx CHANGED Viewed

@@ -1,5 +1,5 @@
 ---
-title: "Reference: Workflow Class | Workflows | Mastra Docs"
+title: "Reference: Workflow Class | Workflows"
 description: Documentation for the `Workflow` class in Mastra, which enables you to create state machines for complex sequences of operations with conditional branching and data validation.
 ---
@@ -75,7 +75,7 @@ export const workflow = createWorkflow({
       description:
         "Optional flag to determine whether to validate the workflow inputs. This also applies default values from zodSchemas on the workflow/step input/resume data. If input/resume data validation fails on start/resume, the workflow will not start/resume, it throws an error instead. If input data validation fails on a step execution, the step fails, causing the workflow to fail and the error is returned.",
       isOptional: true,
-      defaultValue: "false",
+      defaultValue: "true",
     },
     {
       name: "shouldPersistSnapshot",

package/.docs/raw/server-db/custom-api-routes.mdx CHANGED Viewed

@@ -1,5 +1,5 @@
 ---
-title: "Custom API Routes | Server & DB | Mastra Docs"
+title: "Custom API Routes | Server & DB"
 description: "Expose additional HTTP endpoints from your Mastra server."
 ---

package/.docs/raw/server-db/mastra-client.mdx CHANGED Viewed

@@ -1,5 +1,5 @@
 ---
-title: "Mastra Client SDK | Server & DB | Mastra Docs"
+title: "Mastra Client SDK | Server & DB"
 description: "Learn how to set up and use the Mastra Client SDK"
 ---
@@ -8,7 +8,7 @@ import TabItem from "@theme/TabItem";
 # Mastra Client SDK
-The Mastra Client SDK provides a simple and type-safe interface for interacting with your [Mastra Server](/docs/v1/server-db/production-server) from your client environment.
+The Mastra Client SDK provides a simple and type-safe interface for interacting with your [Mastra Server](/docs/v1/server-db/mastra-server) from your client environment.
 ## Prerequisites

package/.docs/raw/server-db/{production-server.mdx → mastra-server.mdx} RENAMED Viewed

@@ -1,9 +1,9 @@
 ---
-title: "Create a Mastra Production Server | Server & DB | Mastra Docs"
+title: "Mastra Server | Server & DB"
 description: "Learn how to configure and deploy a production-ready Mastra server with custom settings for APIs, CORS, and more"
 ---
-# Create a Mastra Production Server
+# Mastra Server
 When deploying your Mastra application to production, it runs as an HTTP server that exposes your agents, workflows, and other functionality as API endpoints. This page covers how to configure and customize the server for a production environment.

package/.docs/raw/server-db/middleware.mdx CHANGED Viewed

@@ -1,5 +1,5 @@
 ---
-title: "Middleware | Server & DB | Mastra Docs"
+title: "Middleware | Server & DB"
 description: "Apply custom middleware functions to intercept requests."
 ---
@@ -64,6 +64,35 @@ registerApiRoute("/my-custom-route", {
 ## Common examples
+### Using `RequestContext`
+You can populate `RequestContext` dynamically in server middleware by extracting information from the request. In this example, the `temperature-unit` is set based on the Cloudflare `CF-IPCountry` header to ensure responses match the user's locale.
+```typescript title="src/mastra/index.ts" showLineNumbers copy
+import { Mastra } from "@mastra/core";
+import { RequestContext } from "@mastra/core/request-context";
+import { testWeatherAgent } from "./agents/test-weather-agent";
+export const mastra = new Mastra({
+  agents: { testWeatherAgent },
+  server: {
+    middleware: [
+      async (context, next) => {
+        const country = context.req.header("CF-IPCountry");
+        const requestContext = context.get("requestContext");
+        requestContext.set(
+          "temperature-unit",
+          country === "US" ? "fahrenheit" : "celsius",
+        );
+        await next();
+      },
+    ],
+  },
+});
+```
 ### Authentication
 ```typescript copy
@@ -143,35 +172,6 @@ be inspected by middleware to tailor behavior:
 - `x-mastra-client-type`: identifies the client SDK, e.g. `js` or `python`
 - `x-studio`: request triggered from Studio
-### Setting `requestContext`
-You can populate `requestContext` dynamically in server middleware by extracting information from the request. In this example, the `temperature-unit` is set based on the Cloudflare `CF-IPCountry` header to ensure responses match the user's locale.
-```typescript title="src/mastra/index.ts" showLineNumbers copy
-import { Mastra } from "@mastra/core";
-import { RequestContext } from "@mastra/core/request-context";
-import { testWeatherAgent } from "./agents/test-weather-agent";
-export const mastra = new Mastra({
-  agents: { testWeatherAgent },
-  server: {
-    middleware: [
-      async (context, next) => {
-        const country = context.req.header("CF-IPCountry");
-        const requestContext = context.get("requestContext");
-        requestContext.set(
-          "temperature-unit",
-          country === "US" ? "fahrenheit" : "celsius",
-        );
-        await next();
-      },
-    ],
-  },
-});
-```
 # Related
-- [Request Context](./request-context)
+- [Request Context](/docs/v1/server-db/request-context)

package/.docs/raw/server-db/request-context.mdx CHANGED Viewed

@@ -1,5 +1,5 @@
 ---
-title: "Request Context | Server & DB | Mastra Docs"
+title: "Request Context | Server & DB"
 description: Learn how to use Mastra's RequestContext to provide dynamic, request-specific configuration to agents.
 ---
@@ -190,5 +190,5 @@ export const weatherTool = createTool({
 - [Request Context Example](/examples/v1/agents/request-context)
 - [Agent Request Context](/docs/v1/agents/overview#using-requestcontext)
 - [Workflow Request Context](../workflows/overview#using-requestcontext)
-- [Tool Request Context](../tools-mcp/overview#using-requestcontext)
-- [Server Middleware Request Context](/docs/v1/server-db/middleware)
+- [Tool Request Context](../mcp/overview#using-requestcontext)
+- [Server Middleware](/docs/v1/server-db/middleware)

package/.docs/raw/server-db/storage.mdx CHANGED Viewed

@@ -1,5 +1,5 @@
 ---
-title: "MastraStorage | Server & DB | Mastra Docs"
+title: "MastraStorage | Server & DB"
 description: Overview of Mastra's storage system and data persistence capabilities.
 ---

package/.docs/raw/streaming/events.mdx CHANGED Viewed

@@ -1,5 +1,5 @@
 ---
-title: "Streaming Events | Streaming | Mastra Docs"
+title: "Streaming Events | Streaming"
 description: "Learn about the different types of streaming events in Mastra, including text deltas, tool calls, step events, and how to handle them in your applications."
 ---

package/.docs/raw/streaming/overview.mdx CHANGED Viewed

@@ -1,5 +1,5 @@
 ---
-title: "Streaming Overview | Streaming | Mastra Docs"
+title: "Streaming Overview | Streaming"
 description: "Streaming in Mastra enables real-time, incremental responses from both agents and workflows, providing immediate feedback as AI-generated content is produced."
 ---

package/.docs/raw/streaming/tool-streaming.mdx CHANGED Viewed

@@ -1,5 +1,5 @@
 ---
-title: "Tool streaming | Streaming | Mastra Docs"
+title: "Tool streaming | Streaming"
 description: "Learn how to use tool streaming in Mastra, including handling tool calls, tool results, and tool execution events during streaming."
 ---

package/.docs/raw/streaming/workflow-streaming.mdx CHANGED Viewed

@@ -1,5 +1,5 @@
 ---
-title: "Workflow streaming | Streaming | Mastra Docs"
+title: "Workflow streaming | Streaming"
 description: "Learn how to use workflow streaming in Mastra, including handling workflow execution events, step streaming, and workflow integration with agents and tools."
 ---

package/.docs/raw/tools-mcp/advanced-usage.mdx CHANGED Viewed

@@ -1,5 +1,5 @@
 ---
-title: "Advanced Tool Usage | Tools & MCP | Mastra Docs"
+title: "Advanced Tool Usage | Tools & MCP"
 description: This page covers advanced features for Mastra tools, including abort signals and compatibility with the Vercel AI SDK tool format.
 ---

package/.docs/raw/tools-mcp/mcp-overview.mdx CHANGED Viewed

@@ -1,5 +1,5 @@
 ---
-title: "MCP Overview | Tools & MCP | Mastra Docs"
+title: "MCP Overview | Tools & MCP"
 description: Learn about the Model Context Protocol (MCP), how to use third-party tools via MCPClient, connect to registries, and share your own tools using MCPServer.
 ---

package/.docs/raw/tools-mcp/overview.mdx CHANGED Viewed

@@ -1,5 +1,5 @@
 ---
-title: "Using Tools | Tools & MCP | Mastra Docs"
+title: "Using Tools | Tools & MCP"
 description: Understand what tools are in Mastra, how to add them to agents, and best practices for designing effective tools.
 ---

package/.docs/raw/voice/overview.mdx CHANGED Viewed

@@ -1,5 +1,5 @@
 ---
-title: "Voice in Mastra | Voice | Mastra Docs"
+title: "Voice in Mastra | Voice"
 description: Overview of voice capabilities in Mastra, including text-to-speech, speech-to-text, and real-time speech-to-speech interactions.
 ---

package/.docs/raw/voice/speech-to-speech.mdx CHANGED Viewed

@@ -1,5 +1,5 @@
 ---
-title: "Speech-to-Speech Capabilities in Mastra | Voice | Mastra Docs"
+title: "Speech-to-Speech Capabilities in Mastra | Voice"
 description: Overview of speech-to-speech capabilities in Mastra, including real-time interactions and event-driven architecture.
 ---

package/.docs/raw/voice/speech-to-text.mdx CHANGED Viewed

@@ -1,5 +1,5 @@
 ---
-title: "Speech-to-Text (STT) | Voice | Mastra Docs"
+title: "Speech-to-Text (STT) | Voice"
 description: Overview of Speech-to-Text capabilities in Mastra, including configuration, usage, and integration with voice providers.
 ---

package/.docs/raw/voice/text-to-speech.mdx CHANGED Viewed

@@ -1,5 +1,5 @@
 ---
-title: "Text-to-Speech (TTS) | Voice | Mastra Docs"
+title: "Text-to-Speech (TTS) | Voice"
 description: Overview of Text-to-Speech capabilities in Mastra, including configuration, usage, and integration with voice providers.
 ---

package/.docs/raw/workflows/agents-and-tools.mdx CHANGED Viewed

@@ -1,5 +1,5 @@
 ---
-title: "Agents and Tools | Workflows | Mastra Docs"
+title: "Agents and Tools | Workflows"
 description: "Learn how to call agents and tools from workflow steps and choose between execute functions and step composition."
 ---
@@ -39,8 +39,6 @@ const step1 = createStep({
 });
 ```
-> See [Calling Agents](/examples/v1/agents/calling-agents) for more examples.
 ### Agents as steps
 Compose an agent as a step using `createStep()` when you don't need to modify the agent call. Use `.map()` to transform the previous step's output into a `prompt` the agent can use.
@@ -143,4 +141,4 @@ export const testWorkflow = createWorkflow({
 ## Related
 - [Using Agents](/docs/v1/agents/overview)
-- [Using Tools](../tools-mcp/overview)
+- [MCP Overview](/docs/v1/mcp/overview)

package/.docs/raw/workflows/control-flow.mdx CHANGED Viewed

@@ -1,5 +1,5 @@
 ---
-title: "Control Flow | Workflows | Mastra Docs"
+title: "Control Flow | Workflows"
 description: "Control flow in Mastra workflows allows you to manage branching, merging, and conditions to construct workflows that meet your logic requirements."
 ---
@@ -306,3 +306,8 @@ export const testWorkflow = createWorkflow({...})
   })
   .commit();
 ```
+## Related
+- [Suspend & Resume](/docs/v1/workflows/suspend-and-resume)
+- [Human-in-the-loop](/docs/v1/workflows/human-in-the-loop)

package/.docs/raw/workflows/error-handling.mdx CHANGED Viewed

@@ -1,5 +1,5 @@
 ---
-title: "Error Handling | Workflows | Mastra Docs"
+title: "Error Handling | Workflows"
 description: "Learn how to handle errors in Mastra workflows using step retries, conditional branching, and monitoring."
 ---
@@ -187,6 +187,6 @@ for await (const chunk of stream.stream) {
 ## Related
-- [Control Flow](./control-flow)
-- [Conditional Branching](./control-flow#conditional-logic-with-branch)
-- [Running Workflows](/docs/v1/workflows/overview)
+- [Control Flow](/docs/v1/workflows/control-flow)
+- [Suspend & Resume](/docs/v1/workflows/suspend-and-resume)
+- [Human-in-the-loop](/docs/v1/workflows/human-in-the-loop)