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

package/.docs/raw/frameworks/web-frameworks/next-js.mdx

@@ -1,379 +0,0 @@
----
-title: "Integrate Mastra in your Next.js project | Frameworks | Mastra Docs"
-description: A step-by-step guide to integrating Mastra with Next.js.
----
-
-import Tabs from "@theme/Tabs";
-import TabItem from "@theme/TabItem";
-import Steps from "@site/src/components/Steps";
-import StepItem from "@site/src/components/StepItem";
-
-# Integrate Mastra in your Next.js project
-
-Mastra integrates with Next.js, making it easy to:
-
-- Build flexible APIs to serve AI-powered features
-- Simplify deployment with a unified codebase for frontend and backend
-- Take advantage of Next.js's built-in server actions (App Router) or API Routes (Pages Router) for efficient server-client workflows
-
-Use this guide to scaffold and integrate Mastra with your Next.js project.
-
-<Tabs>
-  <TabItem value="app-router" label="App Router">
-
-:::warning
-
-This guide assumes you're using the Next.js App Router at the root of your project, e.g., `app` rather than `src/app`.
-
-:::
-
-<Steps>
-
-<StepItem>
-
-To integrate Mastra into your project, you have two options:
-
-- Use the One-Liner
-
-  Run the following command to quickly scaffold the default Weather agent with sensible defaults:
-
-  ```bash copy
-  npx mastra@beta init --dir . --components agents,tools --example --llm openai
-  ```
-
-  > See [mastra init](/reference/v1/cli/create-mastra) for more information.
-
-- Use the Interactive CLI
-
-  If you prefer to customize the setup, run the `init` command and choose from the options when prompted:
-
-  ```bash copy
-  npx mastra@beta init
-  ```
-
-  :::warning
-
-  By default, `mastra init` suggests `src` as the install location. If you're using the App Router at the root of your project (e.g., `app`, not `src/app`), enter `.` when prompted:
-
-  :::
-
-</StepItem>
-
-<StepItem>
-
-Set Up API Key
-
-```bash title=".env" copy
-OPENAI_API_KEY=<your-api-key>
-```
-
-> Each LLM provider uses a different env var. See [Model Capabilities](https://sdk.vercel.ai/providers) for more information.
-
-</StepItem>
-
-<StepItem>
-
-Add to your `next.config.ts`:
-
-```typescript title="next.config.ts" showLineNumbers copy
-import type { NextConfig } from "next";
-
-const nextConfig: NextConfig = {
-  serverExternalPackages: ["@mastra/*"],
-};
-
-export default nextConfig;
-```
-
-</StepItem>
-
-<StepItem>
-
-You can start your Next.js app in the usual way.
-
-</StepItem>
-
-<StepItem>
-
-Create a new directory that will contain a Page, Action, and Form for testing purposes.
-
-```bash copy
-mkdir app/test
-```
-
-</StepItem>
-
-<StepItem>
-
-Create a new Action, and add the example code:
-
-```bash copy
-touch app/test/action.ts
-```
-
-```typescript title="app/test/action.ts" showLineNumbers copy
-"use server";
-
-import { mastra } from "../../mastra";
-
-export async function getWeatherInfo(formData: FormData) {
-  const city = formData.get("city")?.toString();
-  const agent = mastra.getAgent("weatherAgent");
-
-  const result = await agent.generate(`What's the weather like in ${city}?`);
-
-  return result.text;
-}
-```
-
-</StepItem>
-
-<StepItem>
-
-Create a new Form component, and add the example code:
-
-```bash copy
-touch app/test/form.tsx
-```
-
-```typescript title="app/test/form.tsx" showLineNumbers copy
-"use client";
-
-import { useState } from "react";
-import { getWeatherInfo } from "./action";
-
-export function Form() {
-  const [result, setResult] = useState<string | null>(null);
-
-  async function handleSubmit(formData: FormData) {
-    const res = await getWeatherInfo(formData);
-    setResult(res);
-  }
-
-  return (
-    <>
-      <form action={handleSubmit}>
-        <input name="city" placeholder="Enter city" required />
-        <button type="submit">Get Weather</button>
-      </form>
-      {result && <pre>{result}</pre>}
-    </>
-  );
-}
-```
-
-</StepItem>
-
-<StepItem>
-
-Create a new Page, and add the example code:
-
-```bash copy
-touch app/test/page.tsx
-```
-
-```typescript title="app/test/page.tsx" showLineNumbers copy
-import { Form } from "./form";
-
-export default async function Page() {
-  return (
-    <>
-      <h1>Test</h1>
-      <Form />
-    </>
-  );
-}
-```
-
-> You can now navigate to `/test` in your browser to try it out.
-
-Submitting **London** as the city would return a result similar to:
-
-```plaintext
-Agent response: The current weather in London is as follows:
-
-- **Temperature:** 12.9°C (Feels like 9.7°C)
-- **Humidity:** 63%
-- **Wind Speed:** 14.7 km/h
-- **Wind Gusts:** 32.4 km/h
-- **Conditions:** Overcast
-
-Let me know if you need more information!
-```
-
-</StepItem>
-
-  </Steps>
-  </TabItem>
-
-  <TabItem value="pages-router" label="Pages Router">
-
-:::warning
-
-This guide assumes you're using the Next.js Pages Router at the root of your project, e.g., `pages` rather than `src/pages`.
-
-:::
-
-<Steps>
-
-<StepItem>
-
-To integrate Mastra into your project, you have two options:
-
-- Use the One-Liner
-
-  Run the following command to quickly scaffold the default Weather agent with sensible defaults:
-
-  ```bash copy
-  npx mastra@beta init --dir . --components agents,tools --example --llm openai
-  ```
-
-  > See [mastra init](/reference/v1/cli/create-mastra) for more information.
-
-- Use the Interactive CLI
-
-  If you prefer to customize the setup, run the `init` command and choose from the options when prompted:
-
-  ```bash copy
-  npx mastra@beta init
-  ```
-
-  :::warning
-
-  By default, `mastra init` suggests `src` as the install location. If you're using the Pages Router at the root of your project (e.g., `pages`, not `src/pages`), enter `.` when prompted:
-
-  :::
-
-</StepItem>
-
-<StepItem>
-
-Set Up API Key
-
-```bash title=".env" copy
-OPENAI_API_KEY=<your-api-key>
-```
-
-> Each LLM provider uses a different env var. See [Model Capabilities](https://sdk.vercel.ai/providers) for more information.
-
-</StepItem>
-
-<StepItem>
-
-Add to your `next.config.ts`:
-
-```typescript title="next.config.ts" showLineNumbers copy
-import type { NextConfig } from "next";
-
-const nextConfig: NextConfig = {
-  serverExternalPackages: ["@mastra/*"],
-};
-
-export default nextConfig;
-```
-
-</StepItem>
-
-<StepItem>
-
-You can start your Next.js app in the usual way.
-
-</StepItem>
-
-<StepItem>
-
-Create a new API Route, and add the example code:
-
-```bash copy
-touch pages/api/test.ts
-```
-
-```typescript title="pages/api/test.ts" showLineNumbers copy
-import type { NextApiRequest, NextApiResponse } from "next";
-
-import { mastra } from "../../mastra";
-
-export default async function getWeatherInfo(
-  req: NextApiRequest,
-  res: NextApiResponse,
-) {
-  const city = req.body.city;
-  const agent = mastra.getAgent("weatherAgent");
-
-  const result = await agent.generate(`What's the weather like in ${city}?`);
-
-  return res.status(200).json(result.text);
-}
-```
-
-</StepItem>
-
-<StepItem>
-
-Create a new Page, and add the example code:
-
-```bash copy
-touch pages/test.tsx
-```
-
-```typescript title="pages/test.tsx" showLineNumbers copy
-import { useState } from "react";
-
-export default function Test() {
-  const [result, setResult] = useState<string | null>(null);
-
-  async function handleSubmit(event: React.FormEvent<HTMLFormElement>) {
-    event.preventDefault();
-
-    const formData = new FormData(event.currentTarget);
-    const city = formData.get("city")?.toString();
-
-    const response = await fetch("/api/test", {
-      method: "POST",
-      headers: { "Content-Type": "application/json" },
-      body: JSON.stringify({ city })
-    });
-
-    const text = await response.json();
-    setResult(text);
-  }
-
-  return (
-    <>
-      <h1>Test</h1>
-      <form onSubmit={handleSubmit}>
-        <input name="city" placeholder="Enter city" required />
-        <button type="submit">Get Weather</button>
-      </form>
-      {result && <pre>{result}</pre>}
-    </>
-  );
-}
-```
-
-> You can now navigate to `/test` in your browser to try it out.
-
-Submitting **London** as the city would return a result similar to:
-
-```plaintext
-Agent response: The current weather in London is as follows:
-
-- **Temperature:** 12.9°C (Feels like 9.7°C)
-- **Humidity:** 63%
-- **Wind Speed:** 14.7 km/h
-- **Wind Gusts:** 32.4 km/h
-- **Conditions:** Overcast
-
-Let me know if you need more information!
-```
-
-</StepItem>
-
-  </Steps>
-  </TabItem>
-</Tabs>
-
-## Next Steps
-
-- [Deployment | With Next.js on Vercel](/docs/v1/deployment/web-framework#with-nextjs-on-vercel)
-- [Monorepo Deployment](../../deployment/monorepo)

package/.docs/raw/getting-started/templates.mdx

@@ -1,73 +0,0 @@
----
-title: "Templates | Getting Started | Mastra Docs"
-description: Pre-built project structures that demonstrate common Mastra use cases and patterns
----
-
-import Tabs from "@theme/Tabs";
-import TabItem from "@theme/TabItem";
-
-# Templates
-
-Templates are pre-built Mastra projects that demonstrate specific use cases and patterns. Browse available templates in the [templates directory](https://mastra.ai/templates).
-
-## Using Templates
-
-Install a template using the `create-mastra` command:
-
-<Tabs>
-  <TabItem value="npm" label="npm">
-    ```bash copy
-    npx create-mastra@beta --template template-name
-    ```
-  </TabItem>
-  <TabItem value="yarn" label="yarn">
-    ```bash copy
-    yarn dlx create-mastra@beta --template template-name
-    ```
-  </TabItem>
-  <TabItem value="pnpm" label="pnpm">
-    ```bash copy
-    pnpm create mastra@beta --template template-name
-    ```
-  </TabItem>
-  <TabItem value="bun" label="bun">
-    ```bash copy
-    bun create mastra@beta --template template-name
-    ```
-  </TabItem>
-</Tabs>
-
-For example, to create a text-to-SQL application:
-
-```bash copy
-npx create-mastra@beta --template text-to-sql
-```
-
-## Setting Up a Template
-
-After installation:
-
-1. **Navigate to your project**:
-
-   ```bash copy
-   cd your-project-name
-   ```
-
-2. **Configure environment variables**:
-
-   ```bash copy
-   cp .env.example .env
-   ```
-
-   Edit `.env` with your API keys as specified in the template's README.
-
-3. **Start development**:
-   ```bash copy
-   npm run dev
-   ```
-
-:::info
-Each template includes a comprehensive README with specific setup instructions and usage examples.
-:::
-
-For detailed information on creating templates, see the [Templates Reference](/reference/v1/templates/overview).

package/.docs/raw/mastra-cloud/observability.mdx

@@ -1,51 +0,0 @@
----
-title: "Understanding Tracing and Logs | Mastra Cloud | Mastra Docs"
-description: Monitoring and debugging tools for Mastra Cloud deployments
----
-
-import { MastraCloudCallout } from "@site/src/components/MastraCloudCallout";
-
-# Understanding Tracing and Logs
-
-Mastra Cloud captures execution data to help you monitor your application's behavior in the production environment.
-
-<MastraCloudCallout />
-
-## Logs
-
-You can view detailed logs for debugging and monitoring your application's behavior on the [Logs](/docs/v1/mastra-cloud/dashboard#logs) page of the Dashboard.
-
-![Dashboard logs](/img/mastra-cloud/mastra-cloud-dashboard-logs.jpg)
-
-Key features:
-
-Each log entry includes its severity level and a detailed message showing agent, workflow, or storage activity.
-
-## Traces
-
-More detailed traces are available for both agents and workflows by using a [logger](/docs/v1/logging) or enabling [observability](/docs/v1/observability/tracing/overview) using one of our [supported providers](/docs/v1/observability/tracing/overview#exporters).
-
-### Agents
-
-With a [logger](/docs/v1/logging) enabled, you can view detailed outputs from your agents in the **Traces** section in Studio.
-
-![observability agents](/img/mastra-cloud/mastra-cloud-observability-agents.jpg)
-
-Key features:
-
-Tools passed to the agent during generation are standardized using `convertTools`. This includes retrieving client-side tools, memory tools, and tools exposed from workflows.
-
-### Workflows
-
-With a [logger](/docs/v1/logging) enabled, you can view detailed outputs from your workflows in the **Traces** section in Studio.
-
-![observability workflows](/img/mastra-cloud/mastra-cloud-observability-workflows.jpg)
-
-Key features:
-
-Workflows are created using `createWorkflow`, which sets up steps, metadata, and tools. You can run them with `runWorkflow` by passing input and options.
-
-## Next steps
-
-- [Logging](/docs/v1/logging)
-- [Tracing](/docs/v1/observability/tracing/overview)

package/.docs/raw/reference/streaming/workflows/observeStreamVNext.mdx

@@ -1,47 +0,0 @@
----
-title: "Reference: Run.observeStreamVNext() (Experimental) | Streaming | Mastra Docs"
-description: Documentation for the `Run.observeStreamVNext()` method in workflows, which enables reopening the stream of an already active workflow run.
----
-
-# Run.observeStreamVNext() (Experimental)
-
-The `.observeStreamVNext()` method opens a new `ReadableStream` to a workflow run that is currently running, allowing you to observe the stream of events if the original stream is no longer available.
-
-## Usage example
-
-```typescript showLineNumbers copy
-const run = await workflow.createRun();
-
-run.streamVNext({
-  inputData: {
-    value: "initial data",
-  },
-});
-
-const stream = await run.observeStreamVNext();
-
-for await (const chunk of stream) {
-  console.log(chunk);
-}
-```
-
-## Returns
-
-`ReadableStream<ChunkType>`
-
-## Stream Events
-
-The stream emits various event types during workflow execution. Each event has a `type` field and a `payload` containing relevant data:
-
-- **`workflow-start`**: Workflow execution begins
-- **`workflow-step-start`**: A step begins execution
-- **`workflow-step-output`**: Custom output from a step
-- **`workflow-step-result`**: A step completes with results
-- **`workflow-finish`**: Workflow execution completes with usage statistics
-
-## Related
-
-- [Workflows overview](/docs/v1/workflows/overview#running-workflows)
-- [Workflow.createRun()](/reference/v1/workflows/workflow-methods/create-run)
-- [Run.streamVNext()](./streamVNext)
-- [Run.resumeStreamVNext()](./resumeStreamVNext)

package/.docs/raw/reference/streaming/workflows/streamVNext.mdx

@@ -1,153 +0,0 @@
----
-title: "Reference: Run.streamVNext() (Experimental) | Streaming | Mastra Docs"
-description: Documentation for the `Run.streamVNext()` method in workflows, which enables real-time streaming of responses.
----
-
-# Run.streamVNext() (Experimental)
-
-:::caution Experimental Feature
-This is an experimental API that may change in future versions. The `streamVNext()` method will eventually replace the current `stream()` method. Use with caution in production environments.
-:::
-
-The `.streamVNext()` method enables real-time streaming of responses from a workflow. This enhanced streaming capability will eventually replace the current `stream()` method.
-
-## Usage example
-
-```typescript showLineNumbers copy
-const run = await workflow.createRun();
-
-const stream = run.streamVNext({
-  inputData: {
-    value: "initial data",
-  },
-});
-```
-
-## Parameters
-
-<PropertiesTable
-  content={[
-    {
-      name: "inputData",
-      type: "z.infer<TInput>",
-      description: "Input data that matches the workflow's input schema",
-      isOptional: true,
-    },
-    {
-      name: "requestContext",
-      type: "RequestContext",
-      description: "Request Context data to use during workflow execution",
-      isOptional: true,
-    },
-    {
-      name: "tracingContext",
-      type: "TracingContext",
-      isOptional: true,
-      description:
-        "Tracing context for creating child spans and adding metadata.",
-      properties: [
-        {
-          parameters: [
-            {
-              name: "currentSpan",
-              type: "Span",
-              isOptional: true,
-              description:
-                "Current span for creating child spans and adding metadata.",
-            },
-          ],
-        },
-      ],
-    },
-    {
-      name: "tracingOptions",
-      type: "TracingOptions",
-      isOptional: true,
-      description: "Options for Tracing configuration.",
-      properties: [
-        {
-          parameters: [
-            {
-              name: "metadata",
-              type: "Record<string, any>",
-              isOptional: true,
-              description: "Metadata to add to the root trace span.",
-            },
-          ],
-        },
-      ],
-    },
-    {
-      name: "closeOnSuspend",
-      type: "boolean",
-      description:
-        "Whether to close the stream when the workflow is suspended, or to keep the stream open until the workflow is finished (by success or error). Default value is true.",
-      isOptional: true,
-    },
-  ]}
-/>
-
-## Returns
-
-<PropertiesTable
-  content={[
-    {
-      name: "stream",
-      type: "MastraWorkflowStream<ChunkType>",
-      description:
-        "A custom stream that extends ReadableStream<ChunkType> with additional workflow-specific properties",
-    },
-    {
-      name: "stream.status",
-      type: "Promise<RunStatus>",
-      description: "A promise that resolves to the current workflow run status",
-    },
-    {
-      name: "stream.result",
-      type: "Promise<WorkflowResult<TState, TOutput, TSteps>>",
-      description: "A promise that resolves to the final workflow result",
-    },
-    {
-      name: "stream.usage",
-      type: "Promise<{ inputTokens: number; outputTokens: number; totalTokens: number, reasoningTokens?: number, cacheInputTokens?: number }>",
-      description: "A promise that resolves to token usage statistics",
-    },
-    {
-      name: "stream.traceId",
-      type: "string",
-      isOptional: true,
-      description:
-        "The trace ID associated with this execution when Tracing is enabled.",
-    },
-  ]}
-/>
-
-## Extended usage example
-
-```typescript showLineNumbers copy
-const run = await workflow.createRun();
-
-const stream = run.streamVNext({
-  inputData: {
-    value: "initial data",
-  },
-});
-
-const result = await stream.result;
-```
-
-## Stream Events
-
-The stream emits various event types during workflow execution. Each event has a `type` field and a `payload` containing relevant data:
-
-- **`workflow-start`**: Workflow execution begins
-- **`workflow-step-start`**: A step begins execution
-- **`workflow-step-output`**: Custom output from a step
-- **`workflow-step-result`**: A step completes with results
-- **`workflow-finish`**: Workflow execution completes with usage statistics
-
-## Related
-
-- [Workflows overview](/docs/v1/workflows/overview#running-workflows)
-- [Workflow.createRun()](/reference/v1/workflows/workflow-methods/create-run)
-- [Run.resumeStreamVNext()](./resumeStreamVNext)