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

package/.docs/raw/frameworks/agentic-uis/cedar-os.mdx

@@ -1,123 +0,0 @@
----
-title: "Integrate Cedar-OS with Mastra | Frameworks | Mastra Docs"
-description: "Build AI-native frontends for your Mastra agents with Cedar-OS"
----
-
-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 Cedar-OS with Mastra
-
-Cedar-OS is an open-source agentic UI framework designed specifically for building the most ambitious AI-native applications. Cedar was built with Mastra in mind.
-
-## Should you use Cedar?
-
-There are a few pillars Cedar cares about strongly that you can read more about [here](https://docs.cedarcopilot.com/introduction/philosophy):
-
-#### 1. Developer experience
-
-- **Every single component is downloaded shadcn-style** – You own all the code and can style it however you want
-- **Works out of the box** – Just drop in the chat component, and it'll work
-- **Fully extensible** - Built on a [Zustand store architecture](https://docs.cedarcopilot.com/introduction/architecture) that you can customize completely. Every single internal function can be overridden in one line.
-
-#### 2. Enabling truly AI-native applications
-
-For the first time in history, products can come to life. Cedar is aimed at helping you build something with life.
-
-- **[Spells](https://docs.cedarcopilot.com/spells/spells#what-are-spells)** - Users can trigger AI from keyboard shortcuts, mouse events, text selection, and other components
-- **[State Diff Management](https://docs.cedarcopilot.com/state-diff/using-state-diff)** - Give users control over accepting/rejecting agent outputs
-- **[Voice Integration](https://docs.cedarcopilot.com/voice/voice-integration)** - Let users control your app with their voice
-
-## Quick Start
-
-<Steps>
-
-<StepItem>
-
-Run Cedar's CLI command:
-
-```bash
-npx cedar-os-cli plant-seed
-```
-
-If starting from scratch, select the **Mastra starter** template for a complete setup with both frontend and backend in a monorepo
-
-If you already have a Mastra backend, use the **blank frontend cedar repo** option instead. This will give you the option to download components and download all dependencies for Cedar. It is recommended to download at least one of the chat components to get started.
-
-</StepItem>
-
-<StepItem>
-
-Wrap your application with the CedarCopilot provider to connect to your Mastra backend:
-
-```tsx
-import { CedarCopilot } from "cedar-os";
-
-function App() {
-  return (
-    <CedarCopilot
-      llmProvider={{
-        provider: "mastra",
-        baseURL: "http://localhost:4111", // default dev port for Mastra
-        apiKey: process.env.NEXT_PUBLIC_MASTRA_API_KEY, // optional — only for backend auth
-      }}
-    >
-      <YourApp />
-    </CedarCopilot>
-  );
-}
-```
-
-</StepItem>
-
-<StepItem>
-
-Configure your Mastra backend to work with Cedar by following the [Mastra Configuration Options](https://docs.cedarcopilot.com/agent-backend-connection/agent-backend-connection#mastra-configuration-options).
-
-[Register API routes](https://mastra.ai/en/examples/deployment/custom-api-route) in your Mastra server (or NextJS serverless routes if in a monorepo):
-
-```ts mastra/src/index.ts
-import { registerApiRoute } from "@mastra/core/server";
-
-// POST /chat
-// The chat's non-streaming default endpoint
-registerApiRoute("/chat", {
-  method: "POST",
-  // …validate input w/ zod
-  handler: async (c) => {
-    /* your agent.generate() logic */
-  },
-});
-
-// POST /chat/stream (SSE)
-// The chat's streaming default endpoint
-registerApiRoute("/chat/stream", {
-  method: "POST",
-  handler: async (c) => {
-    /* stream agent output in SSE format */
-  },
-});
-```
-
-</StepItem>
-
-<StepItem>
-
-Drop Cedar components into your frontend – see [Chat Overview](https://docs.cedarcopilot.com/chat/chat-overview).
-
-Your backend and frontend are now linked! You're ready to start building AI-native experiences with your Mastra agents.
-
-</StepItem>
-
-</Steps>
-
-## More information
-
-- Check out the [detailed Mastra integration guide](https://docs.cedarcopilot.com/agent-backend-connection/mastra#extending-mastra) for more configuration options (or for manual installation instructions if something goes wrong)
-- Explore Mastra-specific optimizations and features Cedar has built
-  - **Seamless event streaming** - Automatic rendering of [Mastra streamed events](https://docs.cedarcopilot.com/chat/custom-message-rendering#mastra-event-renderer)
-  - **Voice endpoint support** - Built-in [voice backend integration](https://docs.cedarcopilot.com/voice/agentic-backend#endpoint-configuration)
-  - **End-to-End type safety** - [Types](https://docs.cedarcopilot.com/type-safety/typing-agent-requests) for communicating between your app and Mastra backend
-- [Join the Discord!](https://discord.gg/4AWawRjNdZ) The Cedar team is excited to have you :)

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

@@ -1,382 +0,0 @@
----
-title: "Integrate CopilotKit with Mastra | Frameworks | Mastra Docs"
-description: "Learn how Mastra leverages the CopilotKit's AGUI library and how you can leverage it to build user experiences"
----
-
-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 CopilotKit with Mastra
-
-CopilotKit provides React components to quickly integrate customizable AI copilots into your application. Combined with Mastra, you can build sophisticated AI apps featuring bidirectional state synchronization and interactive UIs.
-
-Visit the [CopilotKit documentation](https://docs.copilotkit.ai/) to learn more about CopilotKit concepts, components, and advanced usage patterns.
-
-This guide shows two distinct integration approaches:
-
-1. Integrate CopilotKit in your Mastra server with a separate React frontend.
-2. Integrate CopilotKit in your Next.js app
-
-<Tabs>
-<TabItem value="mastra-server" label="Mastra Server">
-
-  <Steps>
-
-  <StepItem>
-
-In your React frontend, install the required CopilotKit packages:
-
-<Tabs>
-<TabItem value="npm" label="npm">
-
-```bash copy
-npm install @copilotkit/react-core @copilotkit/react-ui
-```
-
-</TabItem>
-<TabItem value="yarn" label="yarn">
-
-```bash copy
-yarn add @copilotkit/react-core @copilotkit/react-ui
-```
-
-</TabItem>
-<TabItem value="pnpm" label="pnpm">
-
-```bash copy
-pnpm add @copilotkit/react-core @copilotkit/react-ui
-```
-
-</TabItem>
-</Tabs>
-
-</StepItem>
-
-<StepItem>
-
-Create a CopilotKit component in your React frontend:
-
-```tsx title="components/copilotkit-component.tsx" copy
-import { CopilotChat } from "@copilotkit/react-ui";
-import { CopilotKit } from "@copilotkit/react-core";
-import "@copilotkit/react-ui/styles.css";
-
-export function CopilotKitComponent({ runtimeUrl }: { runtimeUrl: string }) {
-  return (
-    <CopilotKit runtimeUrl={runtimeUrl} agent="weatherAgent">
-      <CopilotChat
-        labels={{
-          title: "Your Assistant",
-          initial: "Hi! 👋 How can I assist you today?",
-        }}
-      />
-    </CopilotKit>
-  );
-}
-```
-
-</StepItem>
-
-<StepItem>
-
-If you have not yet set up your Mastra server, follow the [getting started guide](/docs/v1/getting-started/installation) to set up a new Mastra project.
-
-In your Mastra server, install additional packages for CopilotKit integration:
-
-<Tabs>
-<TabItem value="npm" label="npm">
-
-```bash copy
-npm install @copilotkit/runtime @ag-ui/mastra@beta
-```
-
-</TabItem>
-<TabItem value="yarn" label="yarn">
-
-```bash copy
-yarn add @copilotkit/runtime @ag-ui/mastra@beta
-```
-
-</TabItem>
-<TabItem value="pnpm" label="pnpm">
-
-```bash copy
-pnpm add @copilotkit/runtime @ag-ui/mastra@beta
-```
-
-</TabItem>
-</Tabs>
-
-</StepItem>
-
-<StepItem>
-
-Configure your Mastra instance to include CopilotKit's runtime endpoint:
-
-```typescript title="src/mastra/index.ts" copy {2,5-8,12-28}
-import { Mastra } from "@mastra/core";
-import { registerCopilotKit } from "@ag-ui/mastra/copilotkit";
-import { weatherAgent } from "./agents/weather-agent";
-
-type WeatherRequestContext = {
-  "user-id": string;
-  "temperature-scale": "celsius" | "fahrenheit";
-};
-
-export const mastra = new Mastra({
-  agents: { weatherAgent },
-  server: {
-    cors: {
-      origin: "*",
-      allowMethods: ["*"],
-      allowHeaders: ["*"],
-    },
-    apiRoutes: [
-      registerCopilotKit<WeatherRequestContext>({
-        path: "/copilotkit",
-        resourceId: "weatherAgent",
-        setContext: (c, requestContext) => {
-          requestContext.set(
-            "user-id",
-            c.req.header("X-User-ID") || "anonymous",
-          );
-          requestContext.set("temperature-scale", "celsius");
-        },
-      }),
-    ],
-  },
-});
-```
-
-</StepItem>
-
-<StepItem>
-
-Use the component in your React app with your Mastra server URL:
-
-```tsx title="App.tsx" copy {5}
-import { CopilotKitComponent } from "./components/copilotkit-component";
-
-function App() {
-  return <CopilotKitComponent runtimeUrl="http://localhost:4111/copilotkit" />;
-}
-
-export default App;
-```
-
-Now start both the Mastra server and your frontend.
-
-</StepItem>
-
-  </Steps>
- </TabItem>
-
-  <TabItem value="nextjs" label="Next.js">
-
-  <Steps>
-
-<StepItem>
-
-In your Next.js app, install the required packages:
-
-<Tabs>
-<TabItem value="npm" label="npm">
-
-```bash copy
-npm install @copilotkit/react-core @copilotkit/react-ui @copilotkit/runtime @ag-ui/mastra@beta
-```
-
-</TabItem>
-<TabItem value="yarn" label="yarn">
-
-```bash copy
-yarn add @copilotkit/react-core @copilotkit/react-ui @copilotkit/runtime @ag-ui/mastra@beta
-```
-
-</TabItem>
-<TabItem value="pnpm" label="pnpm">
-
-```bash copy
-pnpm add @copilotkit/react-core @copilotkit/react-ui @copilotkit/runtime @ag-ui/mastra@beta
-```
-
-</TabItem>
-</Tabs>
-
-</StepItem>
-
-<StepItem>
-
-Create a CopilotKit component:
-
-```tsx title="components/copilotkit-component.tsx" copy
-'use client';
-import { CopilotChat } from "@copilotkit/react-ui";
-import { CopilotKit } from "@copilotkit/react-core";
-import "@copilotkit/react-ui/styles.css";
-
-export function CopilotKitComponent({ runtimeUrl }: { runtimeUrl: string}) {
-  return (
-    <CopilotKit
-      runtimeUrl={runtimeUrl}
-      agent="weatherAgent"
-    >
-      <CopilotChat
-        labels={{
-          title: "Your Assistant",
-          initial: "Hi! 👋 How can I assist you today?",
-        }}
-      />
-    </CopilotKit>
-  );
-}
-```
-
-</StepItem>
-
-<StepItem>
-
-There are two approaches for the API route determined by how you're integrating Mastra in your Next.js application.
-
-1. For a full-stack Next.js app with an instance of Mastra integrated into the app.
-2. For a Next.js app with a separate Mastra server and the Mastra Client SDK.
-
-<Tabs>
-  <TabItem value="mastra-instance" label="With a Mastra instance">
-
-Create an API route that connects to local Mastra agents.
-
-```typescript title="app/api/copilotkit/route.ts" copy {1-7,11-26}
-import { mastra } from "../../mastra";
-import {
-  CopilotRuntime,
-  ExperimentalEmptyAdapter,
-  copilotRuntimeNextJSAppRouterEndpoint,
-} from "@copilotkit/runtime";
-import { MastraAgent } from "@ag-ui/mastra";
-import { NextRequest } from "next/server";
-
-export const POST = async (req: NextRequest) => {
-  const mastraAgents = MastraAgent.getLocalAgents({
-    mastra,
-    agentId: "weatherAgent",
-  });
-
-  const runtime = new CopilotRuntime({
-    agents: mastraAgents,
-  });
-
-  const { handleRequest } = copilotRuntimeNextJSAppRouterEndpoint({
-    runtime,
-    serviceAdapter: new ExperimentalEmptyAdapter(),
-    endpoint: "/api/copilotkit",
-  });
-
-  return handleRequest(req);
-};
-```
-
-  </TabItem>
-  <TabItem value="mastra-client" label="With the Mastra Client SDK">
-
-Install the Mastra Client SDK.
-
-<Tabs>
-<TabItem value="npm" label="npm">
-
-```bash copy
-npm install @mastra/client-js@beta
-```
-
-</TabItem>
-<TabItem value="yarn" label="yarn">
-
-```bash copy
-yarn add @mastra/client-js@beta
-```
-
-</TabItem>
-<TabItem value="pnpm" label="pnpm">
-
-```bash copy
-pnpm add @mastra/client-js@beta
-```
-
-</TabItem>
-</Tabs>
-
-Create an API route that connects to remote Mastra agents:
-
-```typescript title="app/api/copilotkit/route.ts" copy {1-7,12-26}
-import { MastraClient } from "@mastra/client-js";
-import {
-  CopilotRuntime,
-  ExperimentalEmptyAdapter,
-  copilotRuntimeNextJSAppRouterEndpoint,
-} from "@copilotkit/runtime";
-import { MastraAgent } from "@ag-ui/mastra";
-import { NextRequest } from "next/server";
-
-export const POST = async (req: NextRequest) => {
-  const baseUrl = process.env.MASTRA_BASE_URL || "http://localhost:4111";
-  const mastraClient = new MastraClient({ baseUrl });
-
-  const mastraAgents = await MastraAgent.getRemoteAgents({ mastraClient });
-
-  const runtime = new CopilotRuntime({
-    agents: mastraAgents,
-  });
-
-  const { handleRequest } = copilotRuntimeNextJSAppRouterEndpoint({
-    runtime,
-    serviceAdapter: new ExperimentalEmptyAdapter(),
-    endpoint: "/api/copilotkit",
-  });
-
-  return handleRequest(req);
-};
-```
-
-  </TabItem>
-</Tabs>
-
-</StepItem>
-
-<StepItem>
-
-Use the component with the local API endpoint:
-
-```tsx title="App.tsx" copy {5}
-import { CopilotKitComponent } from "./components/copilotkit-component";
-
-function App() {
-  return <CopilotKitComponent runtimeUrl="/api/copilotkit" />;
-}
-
-export default App;
-```
-
-</StepItem>
-
-  </Steps>
-  </TabItem>
-</Tabs>
-
-Start building the future!
-
-<br />
-
-<img
-  className="rounded-lg"
-  src="/img/copilotkit/cpkoutput.jpg"
-  alt="CopilotKit output"
-  style={{ maxWidth: "700px", width: "100%" }}
-/>
-
-## Next Steps
-
-- [CopilotKit Documentation](https://docs.copilotkit.ai) - Complete CopilotKit reference
-- [React Hooks with CopilotKit](https://docs.copilotkit.ai/reference/hooks/useCoAgent) - Advanced React integration patterns
-- [Next.js Integration with Mastra](/docs/v1/frameworks/web-frameworks/next-js) - Full-stack Next.js setup guide

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

@@ -1,179 +0,0 @@
----
-title: "Use OpenRouter with Mastra | Frameworks | Mastra Docs"
-description: "Learn how to integrate OpenRouter with Mastra"
----
-
-import Steps from "@site/src/components/Steps";
-import StepItem from "@site/src/components/StepItem";
-
-# Use OpenRouter with Mastra
-
-Integrate OpenRouter 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?",
-  },
-]);
-```