@mastra/mcp-docs-server 1.0.0-beta.4 → 1.0.0-beta.6

package/.docs/raw/frameworks/agentic-uis/openrouter.mdx

@@ -1,179 +0,0 @@
----
-title: "Using OpenRouter | Frameworks"
-description: "Learn how to integrate OpenRouter with Mastra"
----
-
-import Steps from "@site/src/components/Steps";
-import StepItem from "@site/src/components/StepItem";
-
-# Using OpenRouter
-
-Integrate [OpenRouter](https://openrouter.ai/) with Mastra to leverage the numerous models available on OpenRouter.
-
-<Steps>
-
-<StepItem>
-
-The simplest way to get started with Mastra is to use the `mastra` CLI to initialize a new project:
-
-```bash copy
-npx create-mastra@beta
-```
-
-You'll be guided through prompts to set up your project. For this example, select:
-
-- Name your project: my-mastra-openrouter-app
-- Components: Agents (recommended)
-- For default provider, select OpenAI (recommended) - we'll configure OpenRouter manually later
-- Optionally include example code
-
-</StepItem>
-
-<StepItem>
-
-After creating your project with `create-mastra`, you'll find a `.env` file in your project root.
-Since we selected OpenAI during setup, we'll configure OpenRouter manually:
-
-```bash title=".env" copy
-OPENROUTER_API_KEY=
-```
-
-We remove the `@ai-sdk/openai` package from the project:
-
-```bash copy
-npm uninstall @ai-sdk/openai
-```
-
-Then, we install the `@openrouter/ai-sdk-provider` package:
-
-```bash copy
-npm install @openrouter/ai-sdk-provider
-```
-
-</StepItem>
-
-<StepItem>
-
-We will now configure our agent to use OpenRouter.
-
-```typescript title="src/mastra/agents/assistant.ts" copy showLineNumbers {4-6,11}
-import { Agent } from "@mastra/core/agent";
-import { createOpenRouter } from "@openrouter/ai-sdk-provider";
-
-const openrouter = createOpenRouter({
-  apiKey: process.env.OPENROUTER_API_KEY,
-});
-
-export const assistant = new Agent({
-  id: "assistant",
-  name: "assistant",
-  instructions: "You are a helpful assistant.",
-  model: openrouter("anthropic/claude-sonnet-4"),
-});
-```
-
-Make sure to register your agent to the Mastra instance:
-
-```typescript title="src/mastra/index.ts" copy showLineNumbers {4}
-import { assistant } from "./agents/assistant";
-
-export const mastra = new Mastra({
-  agents: { assistant },
-});
-```
-
-</StepItem>
-
-<StepItem>
-
-```bash copy
-npm run dev
-```
-
-This will start the Mastra development server.
-
-You can now test your agent by visiting [http://localhost:4111](http://localhost:4111) and using Studio or via the Mastra API at [http://localhost:4111/api/agents/assistant/stream](http://localhost:4111/api/agents/assistant/stream).
-
-</StepItem>
-
-</Steps>
-
-## Advanced Configuration
-
-For more control over your OpenRouter requests, you can pass additional configuration options.
-
-### Provider-wide options:
-
-You can pass provider-wide options to the OpenRouter provider:
-
-```typescript title="src/mastra/agents/assistant.ts" {6-10} copy showLineNumbers
-import { Agent } from "@mastra/core/agent";
-import { createOpenRouter } from "@openrouter/ai-sdk-provider";
-
-const openrouter = createOpenRouter({
-  apiKey: process.env.OPENROUTER_API_KEY,
-  extraBody: {
-    reasoning: {
-      max_tokens: 10,
-    },
-  },
-});
-
-export const assistant = new Agent({
-  id: "assistant",
-  name: "assistant",
-  instructions: "You are a helpful assistant.",
-  model: openrouter("anthropic/claude-sonnet-4"),
-});
-```
-
-### Model-specific options:
-
-You can pass model-specific options to the OpenRouter provider:
-
-```typescript title="src/mastra/agents/assistant.ts" {11-17} copy showLineNumbers
-import { Agent } from "@mastra/core/agent";
-import { createOpenRouter } from "@openrouter/ai-sdk-provider";
-
-const openrouter = createOpenRouter({
-  apiKey: process.env.OPENROUTER_API_KEY,
-});
-
-export const assistant = new Agent({
-  id: "assistant",
-  name: "assistant",
-  instructions: "You are a helpful assistant.",
-  model: openrouter("anthropic/claude-sonnet-4", {
-    extraBody: {
-      reasoning: {
-        max_tokens: 10,
-      },
-    },
-  }),
-});
-```
-
-### Provider-specific options:
-
-You can pass provider-specific options to the OpenRouter provider:
-
-```typescript copy showLineNumbers {7-12}
-// Get a response with provider-specific options
-const response = await assistant.generate([
-  {
-    role: "system",
-    content:
-      "You are Chef Michel, a culinary expert specializing in ketogenic (keto) diet...",
-    providerOptions: {
-      // Provider-specific options - key can be 'anthropic' or 'openrouter'
-      anthropic: {
-        cacheControl: { type: "ephemeral" },
-      },
-    },
-  },
-  {
-    role: "user",
-    content: "Can you suggest a keto breakfast?",
-  },
-]);
-```

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

@@ -1,379 +0,0 @@
----
-title: "Integrate Mastra in your Next.js project | Frameworks"
-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/quickstart.mdx

@@ -1,27 +0,0 @@
----
-title: "Quickstart | Getting Started"
-description: Choose how to get started with Mastra - standalone server or Next.js integration.
----
-
-import { CardGrid, CardGridItem } from "@site/src/components/cards/card-grid";
-
-# Quickstart
-
-Choose how you want to get started with Mastra:
-
-<CardGrid columns={2}>
-  <CardGridItem
-    title="Standalone Server (Recommended)"
-    href="/guides/v1/quickstarts/standalone-server"
-  >
-    The fastest way to get started - spin up a standalone Mastra server and interact with your agents in Studio
-  </CardGridItem>
-  <CardGridItem
-    title="Next.js"
-    href="/guides/v1/quickstarts/nextjs"
-  >
-    Integrate Mastra into a Next.js app and use the AI SDK UI to build an in-app chat interface for your agents
-  </CardGridItem>
-</CardGrid>
-
-For more control over setup, or to add Mastra to an existing project, see the [manual installation guide](/guides/v1/guide/manual-install). You can also use [`mastra init`](/reference/v1/cli/mastra#mastra-init) for existing projects.

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

@@ -1,73 +0,0 @@
----
-title: "Templates | Getting Started"
-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/reference/streaming/workflows/observeStreamVNext.mdx

@@ -1,47 +0,0 @@
----
-title: "Reference: Run.observeStreamVNext() (Experimental) | Streaming"
-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)