@mastra/mcp-docs-server 1.2.1-alpha.2 → 1.2.1-alpha.4

package/.docs/reference/agents/inngest-agent.md

@@ -0,0 +1,339 @@
+# `createInngestAgent()`
+
+`createInngestAgent()` wraps an existing [`Agent`](https://mastra.ai/reference/agents/agent) with [Inngest](https://www.inngest.com/docs)-powered durable execution. Like [`createDurableAgent()`](https://mastra.ai/reference/agents/durable-agent), it streams events over [PubSub](https://mastra.ai/docs/server/pubsub) and supports resumable streams, but runs the agentic loop on Inngest's execution engine instead of in-process. Use it when a run must survive process restarts or run in a distributed environment.
+
+For in-process durable execution, use [`createDurableAgent()`](https://mastra.ai/reference/agents/durable-agent). For fire-and-forget execution on the built-in workflow engine, use [`createEventedAgent()`](https://mastra.ai/reference/agents/durable-agent).
+
+## Usage example
+
+Set up the Inngest client, wrap an agent, register it with Mastra, and expose the Inngest serve endpoint:
+
+```typescript
+import { Mastra } from '@mastra/core'
+import { Agent } from '@mastra/core/agent'
+import { createInngestAgent, serve as inngestServe } from '@mastra/inngest'
+import { Inngest } from 'inngest'
+
+const inngest = new Inngest({ id: 'my-app' })
+
+const agent = new Agent({
+  id: 'my-agent',
+  name: 'My Agent',
+  instructions: 'You are a helpful assistant',
+  model: 'openai/gpt-5.5',
+})
+
+const durableAgent = createInngestAgent({ agent, inngest })
+
+export const mastra = new Mastra({
+  agents: { myAgent: durableAgent },
+  server: {
+    apiRoutes: [
+      {
+        path: '/inngest/api',
+        method: 'ALL',
+        createHandler: async ({ mastra }) => inngestServe({ mastra, inngest }),
+      },
+    ],
+  },
+})
+```
+
+Stream a response and read the result:
+
+```typescript
+const { output, runId, cleanup } = await durableAgent.stream('Hello!')
+
+const text = await output.text
+
+cleanup()
+```
+
+## `createInngestAgent(options)`
+
+Wraps an `Agent` with Inngest-powered durable execution and resumable streams.
+
+```typescript
+import { createInngestAgent } from '@mastra/inngest'
+
+const durableAgent = createInngestAgent({ agent, inngest })
+```
+
+Returns: [`InngestAgent`](#inngestagent-interface)
+
+### Parameters
+
+**agent** (`Agent`): The Agent to wrap with Inngest durable execution. Agent methods (e.g., \`generate()\`, \`listTools()\`, \`getMemory()\`) delegate to this agent via a Proxy.
+
+**inngest** (`Inngest`): The Inngest client instance. Used to send workflow events and, in SDK v4, publish realtime stream events.
+
+**id** (`string`): ID override. (Default: `agent.id`)
+
+**name** (`string`): Name override. (Default: `agent.name`)
+
+**pubsub** (`PubSub`): PubSub instance for streaming events. The default \`InngestPubSub\` uses Inngest Realtime, which works across processes. (Default: `InngestPubSub`)
+
+**cache** (`MastraServerCache`): Cache for stored stream events, which enables resumable streams. When provided, the PubSub is automatically wrapped with \`CachingPubSub\`. If omitted, the agent inherits the cache from the Mastra instance.
+
+**mastra** (`Mastra`): Mastra instance for observability. Set automatically when the agent is registered with Mastra.
+
+## `InngestAgent` interface
+
+The object returned by `createInngestAgent()`. It implements the full `Agent` interface via a Proxy: any property or method not explicitly defined (e.g., `generate()`, `listTools()`, `getMemory()`) is forwarded to the underlying agent.
+
+### Properties
+
+**id** (`string`): The agent ID.
+
+**name** (`string`): The agent name.
+
+**agent** (`Agent`): The underlying Mastra Agent.
+
+**inngest** (`Inngest`): The Inngest client.
+
+**cache** (`MastraServerCache | undefined`): The resolved cache instance, if resumable streams are enabled.
+
+**pubsub** (`PubSub`): The PubSub instance used for streaming events.
+
+## Methods
+
+### Execution
+
+#### `stream(messages, options?)`
+
+Streams a response using Inngest's durable execution engine. The workflow is triggered via an Inngest event after the PubSub subscription is established.
+
+```typescript
+const { output, runId, cleanup } = await durableAgent.stream('Hello!', {
+  onChunk: chunk => console.log(chunk),
+  onFinish: result => console.log('done', result),
+})
+
+const text = await output.text
+cleanup()
+```
+
+Returns: [`Promise<InngestAgentStreamResult>`](#inngestagentstreamresult)
+
+#### `resume(runId, resumeData, options?)`
+
+Resumes a suspended Inngest run, for example after a tool approval. Loads the workflow snapshot from storage, finds the suspended step, and sends a resume event to Inngest.
+
+```typescript
+const { output, cleanup } = await durableAgent.resume(
+  runId,
+  {
+    approved: true,
+  },
+  { threadId: 'thread-1', resourceId: 'user-1' },
+)
+
+await output.text
+cleanup()
+```
+
+The third argument accepts `threadId` and `resourceId` in addition to the lifecycle callbacks:
+
+**threadId** (`string`): Thread ID to associate with the resumed run.
+
+**resourceId** (`string`): Resource ID to associate with the resumed run.
+
+**onChunk** (`(chunk: ChunkType) => void | Promise<void>`): Called for each streamed chunk.
+
+**onStepFinish** (`(result: AgentStepFinishEventData) => void | Promise<void>`): Called when a step in the agentic loop finishes.
+
+**onFinish** (`(result: AgentFinishEventData) => void | Promise<void>`): Called when the run finishes.
+
+**onError** (`(error: Error) => void | Promise<void>`): Called when the run errors.
+
+**onSuspended** (`(data: AgentSuspendedEventData) => void | Promise<void>`): Called when the run suspends.
+
+Returns: [`Promise<InngestAgentStreamResult>`](#inngestagentstreamresult)
+
+#### `observe(runId, options?)`
+
+Reconnects to an existing run, replaying cached events before delivering live ones. Use this after a network disconnection. Pass `offset` to start replay from a known position.
+
+```typescript
+const { output, cleanup } = await durableAgent.observe(runId, {
+  offset: 0,
+  onChunk: chunk => console.log(chunk),
+})
+
+await output.text
+```
+
+The result from `observe()` does not include `threadId` or `resourceId`.
+
+Returns: `Promise<Omit<InngestAgentStreamResult, 'threadId' | 'resourceId'>>`
+
+> **Warning:** The `cleanup()` returned by `observe()` destroys the run's registry entries and cached events. Only call it when you are done with the run. If the run is suspended and you intend to resume later, don't call `cleanup()`.
+
+#### `prepare(messages, options?)`
+
+Prepares a run for durable execution without triggering it. Returns the serialized workflow input that can be used to manually trigger the Inngest workflow event.
+
+```typescript
+const { runId, messageId, workflowInput, threadId, resourceId } = await durableAgent.prepare(
+  'Summarize the document',
+  {
+    memory: { threadId: 'thread-1', resourceId: 'user-1' },
+  },
+)
+```
+
+Returns:
+
+```typescript
+interface PrepareResult {
+  runId: string
+  messageId: string
+  workflowInput: any
+  threadId?: string
+  resourceId?: string
+}
+```
+
+### Introspection
+
+#### `isInngestAgent(obj)`
+
+Type guard that checks whether an object is an `InngestAgent`.
+
+```typescript
+import { isInngestAgent } from '@mastra/inngest'
+
+if (isInngestAgent(agent)) {
+  // agent is InngestAgent
+}
+```
+
+Returns: `boolean`
+
+## Stream options
+
+`stream()` accepts an `InngestAgentStreamOptions` object. It supports the same agent execution options as [`DurableAgent.stream()`](https://mastra.ai/reference/agents/durable-agent), plus lifecycle callbacks.
+
+**runId** (`string`): Unique identifier for this run. Use it later with \`resume()\` or \`observe()\`.
+
+**instructions** (`AgentExecutionOptions['instructions']`): Overrides the agent's default instructions for this run.
+
+**context** (`ModelMessage[]`): Additional context messages to provide to the agent.
+
+**memory** (`object`): Memory configuration for conversation persistence and retrieval.
+
+**requestContext** (`RequestContext`): Request context carrying dynamic configuration and state for this run.
+
+**maxSteps** (`number`): Maximum number of steps to run.
+
+**toolsets** (`object`): Additional tool sets available for this run.
+
+**clientTools** (`object`): Client-side tools available during execution.
+
+**toolChoice** (`'auto' | 'none' | 'required' | { type: 'tool'; toolName: string }`): Tool selection strategy.
+
+**modelSettings** (`object`): Model-specific settings such as temperature.
+
+**requireToolApproval** (`boolean`): Require approval for all tool calls, which suspends the run until resumed.
+
+**autoResumeSuspendedTools** (`boolean`): Automatically resume tools that suspended, instead of waiting for an external \`resume()\` call.
+
+**toolCallConcurrency** (`number`): Maximum number of tool calls to execute concurrently.
+
+**includeRawChunks** (`boolean`): Include raw provider chunks in the stream output.
+
+**maxProcessorRetries** (`number`): Maximum number of processor retries per generation.
+
+**untilIdle** (`boolean | { maxIdleMs?: number }`): When set, keeps the stream open across background-task continuations until the agent is idle. Pass \`true\` for the default 5-minute idle timeout, or \`{ maxIdleMs }\` to customise.
+
+**onChunk** (`(chunk: ChunkType) => void | Promise<void>`): Called for each streamed chunk.
+
+**onStepFinish** (`(result: AgentStepFinishEventData) => void | Promise<void>`): Called when a step in the agentic loop finishes.
+
+**onFinish** (`(result: AgentFinishEventData) => void | Promise<void>`): Called when the run finishes.
+
+**onError** (`(error: Error) => void | Promise<void>`): Called when the run errors.
+
+**onSuspended** (`(data: AgentSuspendedEventData) => void | Promise<void>`): Called when the run suspends, for example for tool approval.
+
+`observe()` accepts the lifecycle callbacks (`onChunk`, `onStepFinish`, `onFinish`, `onError`, `onSuspended`) plus an `offset` to control where replay starts.
+
+## `InngestAgentStreamResult`
+
+The object returned by `stream()` and `resume()`. The `observe()` method returns the same shape but omits `threadId` and `resourceId`.
+
+```typescript
+interface InngestAgentStreamResult<OUTPUT = undefined> {
+  output: MastraModelOutput<OUTPUT>
+  readonly fullStream: ReadableStream<any>
+  runId: string
+  threadId?: string
+  resourceId?: string
+  cleanup: () => void
+}
+```
+
+**output** (`MastraModelOutput`): The streaming output. Await \`output.text\` for the full text, or consume \`output.fullStream\`.
+
+**fullStream** (`ReadableStream`): The full event stream, delegating to \`output.fullStream\`.
+
+**runId** (`string`): The unique run ID. Pass it to \`resume()\` or \`observe()\` to reconnect.
+
+**threadId** (`string`): Thread ID when using memory.
+
+**resourceId** (`string`): Resource ID when using memory.
+
+**cleanup** (`() => void`): Unsubscribes from PubSub and clears registry entries for the run. Call it when done with the run.
+
+## Serving Inngest functions
+
+The `@mastra/inngest` package provides `serve()` and `createServe()` to register Inngest workflow functions with your HTTP framework.
+
+### `serve(options)`
+
+Serves Mastra workflows with Hono (the default framework). Collects all Inngest-backed workflows from Mastra and registers them as Inngest functions.
+
+```typescript
+import { serve } from '@mastra/inngest'
+
+app.use('/inngest/api', async c => {
+  return serve({ mastra, inngest })(c)
+})
+```
+
+### `createServe(adapter)`
+
+Factory that accepts any Inngest serve adapter (`inngest/express`, `inngest/fastify`, `inngest/next`, etc.) and returns a serve function for that framework.
+
+```typescript
+import { createServe } from '@mastra/inngest'
+import { serve } from 'inngest/express'
+
+const serveExpress = createServe(serve)
+app.use('/inngest/api', serveExpress({ mastra, inngest }))
+```
+
+```typescript
+import { createServe } from '@mastra/inngest'
+import { serve } from 'inngest/next'
+
+const serveNext = createServe(serve)
+export const { GET, POST, PUT } = serveNext({ mastra, inngest })
+```
+
+### Serve options
+
+**mastra** (`Mastra`): The Mastra instance containing registered agents and workflows.
+
+**inngest** (`Inngest`): The Inngest client instance.
+
+**functions** (`InngestFunction.Like[]`): Additional Inngest functions to serve alongside Mastra workflows.
+
+**registerOptions** (`RegisterOptions`): Options passed to the Inngest registration handler.
+
+## Related
+
+- [DurableAgent reference](https://mastra.ai/reference/agents/durable-agent)
+- [Agent class](https://mastra.ai/reference/agents/agent)
+- [Inngest deployment guide](https://mastra.ai/guides/deployment/inngest)
+- [PubSub](https://mastra.ai/docs/server/pubsub)

package/.docs/reference/ai-sdk/handle-workflow-stream.md

@@ -10,7 +10,7 @@ Use [`workflowRoute()`](https://mastra.ai/reference/ai-sdk/workflow-route) if yo
 
 > **Agent streaming in workflows:** When a workflow step pipes an agent's stream to the workflow writer (e.g., `await response.fullStream.pipeTo(writer)`), the agent's text chunks and tool calls are forwarded to the UI stream in real time, even when the agent runs inside workflow steps.
 >
-> See [Workflow Streaming](https://mastra.ai/docs/streaming/workflow-streaming) for more details.
+> See [Workflow Streaming](https://mastra.ai/docs/workflows/overview) for more details.
 
 ## Usage example
 

package/.docs/reference/ai-sdk/workflow-route.md

@@ -8,7 +8,7 @@ Use [`handleWorkflowStream()`](https://mastra.ai/reference/ai-sdk/handle-workflo
 
 > **Agent streaming in workflows:** When a workflow step pipes an agent's stream to the workflow writer (e.g., `await response.fullStream.pipeTo(writer)`), the agent's text chunks and tool calls are forwarded to the UI stream in real time, even when the agent runs inside workflow steps.
 >
-> See [Workflow Streaming](https://mastra.ai/docs/streaming/workflow-streaming) for more details.
+> See [Workflow Streaming](https://mastra.ai/docs/workflows/overview) for more details.
 
 ## Usage example
 

package/.docs/reference/index.md

@@ -6,6 +6,7 @@ The Reference section provides documentation of Mastra's API, including paramete
 - [createACPTool()](https://mastra.ai/reference/acp/create-acp-tool)
 - [Agent Class](https://mastra.ai/reference/agents/agent)
 - [Channels](https://mastra.ai/reference/agents/channels)
+- [createInngestAgent()](https://mastra.ai/reference/agents/inngest-agent)
 - [DurableAgent](https://mastra.ai/reference/agents/durable-agent)
 - [.generate()](https://mastra.ai/reference/agents/generate)
 - [.generateLegacy()](https://mastra.ai/reference/agents/generateLegacy)

package/.docs/reference/streaming/workflows/timeTravelStream.md

@@ -137,6 +137,6 @@ const result = await output.result
 
 - [Run.timeTravel()](https://mastra.ai/reference/workflows/run-methods/timeTravel)
 - [Time Travel](https://mastra.ai/docs/workflows/time-travel)
-- [Workflow Streaming](https://mastra.ai/docs/streaming/workflow-streaming)
+- [Workflow Streaming](https://mastra.ai/docs/workflows/overview)
 - [Run.stream()](https://mastra.ai/reference/streaming/workflows/stream)
 - [Run.resumeStream()](https://mastra.ai/reference/streaming/workflows/resumeStream)

package/.docs/reference/tools/create-tool.md

@@ -445,5 +445,5 @@ These annotations follow the [MCP specification](https://spec.modelcontextprotoc
 - [MCP Overview](https://mastra.ai/docs/mcp/overview)
 - [Using Tools with Agents](https://mastra.ai/docs/agents/using-tools)
 - [Agent Approval](https://mastra.ai/docs/agents/agent-approval)
-- [Tool Streaming](https://mastra.ai/docs/streaming/tool-streaming)
+- [Tool Streaming](https://mastra.ai/docs/agents/using-tools)
 - [Request Context](https://mastra.ai/docs/server/request-context)

package/.docs/reference/workflows/run.md

@@ -55,5 +55,5 @@ A workflow run's `status` indicates its current execution state. The possible va
 - [Run.cancel()](https://mastra.ai/reference/workflows/run-methods/cancel)
 - [Run.restart()](https://mastra.ai/reference/workflows/run-methods/restart)
 - [Run.timeTravel()](https://mastra.ai/reference/workflows/run-methods/timeTravel)
-- [Run.stream()](https://mastra.ai/docs/streaming/workflow-streaming)
+- [Run.stream()](https://mastra.ai/docs/workflows/overview)
 - [Run.timeTravelStream()](https://mastra.ai/reference/streaming/workflows/timeTravelStream)

package/CHANGELOG.md

@@ -1,5 +1,12 @@
 # @mastra/mcp-docs-server
 
+## 1.2.1-alpha.3
+
+### Patch Changes
+
+- Updated dependencies [[`65f255a`](https://github.com/mastra-ai/mastra/commit/65f255a38667beb6ceeadabfa9eb5059bfec8298), [`4a88c6e`](https://github.com/mastra-ai/mastra/commit/4a88c6e2bdce316f8d7551b4ec3449b0b06fc71c), [`87a17ef`](https://github.com/mastra-ai/mastra/commit/87a17efbd725aca6639febdc5e69e2abb3048689), [`e11ff30`](https://github.com/mastra-ai/mastra/commit/e11ff301408bf1731dca2fb7fbfcd8c819500a35), [`9d2c946`](https://github.com/mastra-ai/mastra/commit/9d2c946d0859e90ae4bcec5beeb1da7398d2ad1e), [`f1ec385`](https://github.com/mastra-ai/mastra/commit/f1ec385386f62b1a0847ec5353ae2bb169d1c3d9), [`e14986f`](https://github.com/mastra-ai/mastra/commit/e14986f6e5478d6384d04ff9a7f9a79a46a8b529), [`0be490f`](https://github.com/mastra-ai/mastra/commit/0be490fabb538c5a7de796ea0aff7d04a0bea1f3), [`0be490f`](https://github.com/mastra-ai/mastra/commit/0be490fabb538c5a7de796ea0aff7d04a0bea1f3), [`974f614`](https://github.com/mastra-ai/mastra/commit/974f614e083bd68278536f94453f7b320b86a3c7), [`31be1cf`](https://github.com/mastra-ai/mastra/commit/31be1cf5f2a7b5eef12f6123a40653b4d8115c16)]:
+  - @mastra/core@1.46.0-alpha.3
+
 ## 1.2.1-alpha.2
 
 ### Patch Changes

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mastra/mcp-docs-server",
-  "version": "1.2.1-alpha.2",
+  "version": "1.2.1-alpha.4",
   "description": "MCP server for accessing Mastra.ai documentation, changelogs, and news.",
   "type": "module",
   "main": "dist/index.js",
@@ -28,8 +28,8 @@
     "jsdom": "^26.1.0",
     "local-pkg": "^1.1.2",
     "zod": "^4.4.3",
-    "@mastra/core": "1.46.0-alpha.2",
-    "@mastra/mcp": "^1.12.0-alpha.0"
+    "@mastra/mcp": "^1.12.0-alpha.0",
+    "@mastra/core": "1.46.0-alpha.3"
   },
   "devDependencies": {
     "@hono/node-server": "^1.19.11",
@@ -45,9 +45,9 @@
     "tsx": "^4.22.4",
     "typescript": "^6.0.3",
     "vitest": "4.1.8",
-    "@internal/types-builder": "0.0.82",
     "@internal/lint": "0.0.107",
-    "@mastra/core": "1.46.0-alpha.2"
+    "@internal/types-builder": "0.0.82",
+    "@mastra/core": "1.46.0-alpha.3"
   },
   "homepage": "https://mastra.ai",
   "repository": {

package/.docs/docs/build-with-ai/mcp-docs-server.md

@@ -1,238 +0,0 @@
-# Mastra docs server
-
-The `@mastra/mcp-docs-server` package provides direct access to Mastra’s full documentation via the [Model Context Protocol (MCP)](https://modelcontextprotocol.io/docs/getting-started/intro). It works with Cursor, Windsurf, Cline, Claude Code, VS Code, Codex or any tool that supports MCP.
-
-These tools are designed to help agents retrieve precise, task-specific information — whether you're adding a feature to an agent, scaffolding a new project, or exploring how something works.
-
-In this guide you'll learn how to add Mastra's MCP server to your AI tooling.
-
-[YouTube video player](https://www.youtube-nocookie.com/embed/vciV57lF0og)
-
-## Installation
-
-### create-mastra
-
-During the interactive [create-mastra](https://mastra.ai/reference/cli/create-mastra) wizard, choose one of your tools in the MCP step.
-
-### Manual setup
-
-If there are no specific instructions for your tool below, you may be able to add the MCP server with this common JSON configuration anyways.
-
-```json
-{
-  "mcpServers": {
-    "mastra": {
-      "type": "stdio",
-      "command": "npx",
-      "args": ["-y", "@mastra/mcp-docs-server@latest"]
-    }
-  }
-}
-```
-
-### Claude Code CLI
-
-Install using the terminal command:
-
-```bash
-claude mcp add --scope project mastra -- npx -y @mastra/mcp-docs-server@latest
-```
-
-This creates a project-scoped `.mcp.json` file if one doesn't already exist. You can use the same command when using Claude Code as a [Visual Studio Code extension](https://code.claude.com/docs/en/vs-code#connect-to-external-tools-with-mcp).
-
-[More info on using MCP servers with Claude Code](https://docs.claude.com/en/docs/claude-code/mcp)
-
-### OpenAI Codex CLI
-
-1. Register it from the terminal:
-
-   ```bash
-   codex mcp add mastra-docs -- npx -y @mastra/mcp-docs-server@latest
-   ```
-
-2. Run `codex mcp list` to confirm the server shows as `enabled`.
-
-[More info on using MCP servers with OpenAI Codex](https://developers.openai.com/codex/mcp)
-
-### Cursor
-
-Install by selecting the button below:
-
-[![Install MCP Server](https://cursor.com/deeplink/mcp-install-light.svg)](cursor://anysphere.cursor-deeplink/mcp/install?name=mastra\&config=eyJjb21tYW5kIjoibnB4IC15IEBtYXN0cmEvbWNwLWRvY3Mtc2VydmVyIn0%3D)
-
-If you followed the automatic installation, you'll see a popup when you open cursor in the bottom left corner to prompt you to enable the Mastra Docs MCP Server.
-
-![Popup inside Cursor showing: \"New MCP server detected: mastra\". The user can \"Skip\" or \"Enable\" it as an action.](/assets/images/enable-mastra-docs-cursor-cd5872abdc36c0e10951a59a47f25e12.png)
-
-[More info on using MCP servers with Cursor](https://cursor.com/de/docs/context/mcp)
-
-### Antigravity
-
-Google Antigravity is an agent-first development platform that supports MCP servers for accessing external documentation, APIs, and project context.
-
-1. Open your Antigravity MCP configuration file:
-
-   - Click on **Agent session** and select the **“…” dropdown** at the top of the editor’s side panel, then select **MCP Servers** to access the **MCP Store**.
-   - You can access it through the MCP Store interface in Antigravity
-
-   ![The Antigravity MCP store. At the top is a search bar and below a list of available MCP servers. On the very top right is a dropdown menu.](/assets/images/antigravity_mcp_server-689ea495d9c7139cc431f1f1b9827f9b.png)
-
-2. To add a custom MCP server, select **Manage MCP Servers** at the top of the MCP Store and select **View raw config** in the main tab.
-
-   ![The Antigravity MCP store showing the Manage MCP Servers option and the View raw config button.](/assets/images/antigravity_managed_mcp-b661e8c04b3219000f8d842e5eb26a1a.png)
-
-3. Add the Mastra MCP server configuration:
-
-   ```json
-   {
-     "mcpServers": {
-       "mastra-docs": {
-         "command": "npx",
-         "args": ["-y", "@mastra/mcp-docs-server"]
-       }
-     }
-   }
-   ```
-
-4. Save the configuration and restart Antigravity
-
-   ![The UI shows that the MCP server is enabled. You can also toggle individual tools.](/assets/images/antigravity_final_interface_mcp-7fa132dbe76cdee9f61136a26d6e6615.png)
-
-Once configured, the Mastra MCP server exposes the following to Antigravity agents:
-
-- Indexed documentation and API schemas for Mastra, enabling programmatic retrieval of relevant context during code generation
-- Access to example code snippets and usage patterns stored in Mastra Docs
-- Structured data for error handling and debugging references in the editor
-- Metadata about current Mastra project patterns for code suggestion and completion
-
-The MCP server will appear in Antigravity's MCP Store, where you can manage its connection status and authentication if needed.
-
-[More info on using MCP servers with Antigravity](https://antigravity.google)
-
-### Visual Studio Code
-
-1. Create a `.vscode/mcp.json` file in your workspace
-
-2. Insert the following configuration:
-
-   ```json
-   {
-     "servers": {
-       "mastra": {
-         "type": "stdio",
-         "command": "npx",
-         "args": ["-y", "@mastra/mcp-docs-server@latest"]
-       }
-     }
-   }
-   ```
-
-Once you installed the MCP server, you can use it like so:
-
-1. Open VSCode settings.
-
-2. Navigate to MCP settings.
-
-3. Click "enable" on the Chat > MCP option.
-
-   ![Entry in VSCode\'s settings page. The option is called \"Chat \> MCP: Enabled (Preview)\". The description says: \"Enables integration with Model Context Protocol servers to provide additional tools and functionality.\"](/assets/images/vscode-mcp-setting-8d1eb4f3df1e33606503f8c5e937e9e3.png)
-
-MCP only works in Agent mode in VSCode. Once you are in agent mode, open the `mcp.json` file and select the "start" button. Note that the "start" button will only appear if the `.vscode` folder containing `mcp.json` is in your workspace root, or the highest level of the in-editor file explorer.
-
-![A screenshot of the mcp.json file showing the start button in the editor](/assets/images/vscode-start-mcp-26480d86080c4907cb497a325de106a4.png)
-
-After starting the MCP server, select the tools button in the Copilot pane to see available tools.
-
-![Tools page of VSCode to see available tools](/assets/images/vscode-mcp-running-d92d6ed234d1148093dc804b0ead3515.png)
-
-[More info on using MCP servers with Visual Studio Code](https://code.visualstudio.com/docs/copilot/customization/mcp-servers)
-
-### Windsurf
-
-1. Open `~/.codeium/windsurf/mcp_config.json` in your editor
-
-2. Insert the following configuration:
-
-   ```json
-   {
-     "mcpServers": {
-       "mastra": {
-         "command": "npx",
-         "args": ["-y", "@mastra/mcp-docs-server@latest"]
-       }
-     }
-   }
-   ```
-
-3. Save the configuration and restart Windsurf
-
-[More info on using MCP servers with Windsurf](https://docs.windsurf.com/windsurf/cascade/mcp#mcp-config-json)
-
-### OpenCode
-
-You can define MCP servers in your [OpenCode configuration](https://opencode.ai/docs/config/) under `mcp`. Create an `opencode.jsonc` file in your project root with the following content:
-
-```json
-{
-  "$schema": "https://opencode.ai/config.json",
-  "mcp": {
-    "mastra": {
-      "type": "local",
-      "command": ["npx", "-y", "@mastra/mcp-docs-server@latest"],
-      "enabled": true
-    }
-  }
-}
-```
-
-[More info on using MCP servers with OpenCode](https://opencode.ai/docs/mcp-servers)
-
-### Zed
-
-1. Open `~/.config/zed/settings.json` in your editor
-2. Insert the following configuration:
-
-```json
-{
-  "context_servers": {
-    "Mastra": {
-      "command": "npx",
-      "args": ["-y", "@mastra/mcp-docs-server@latest"]
-    }
-  }
-}
-```
-
-## Usage
-
-Once configured, you can ask your AI tool questions about Mastra or instruct it to take actions. For these steps, it'll take the up-to-date information from Mastra's MCP server.
-
-**Add features:**
-
-- "Add evals to my agent and write tests"
-- "Write me a workflow that does the following `[task]`"
-- "Make a new tool that allows my agent to access `[3rd party API]`"
-
-**Ask about integrations:**
-
-- "Does Mastra work with the AI SDK? How can I use it in my `[React/Svelte/etc]` project?"
-- "Does Mastra support `[provider]` speech and voice APIs? Show me an example in my code of how I can use it."
-
-**Debug or update existing code:**
-
-- "I'm running into a bug with agent memory, have there been any related changes or bug fixes recently?"
-- "How does working memory behave in Mastra and how can I use it to do `[task]`? It doesn't seem to work the way I expect."
-- "I saw there are new workflow features, explain them to me and then update `[workflow]` to use them."
-
-### Troubleshooting
-
-1. **Server Not Starting**
-
-   - Ensure [npx](https://docs.npmjs.com/cli/v11/commands/npx) is installed and working.
-   - Check for conflicting MCP servers.
-   - Verify your configuration file syntax.
-
-2. **Tool Calls Failing**
-
-   - Restart the MCP server and/or your IDE.
-   - Update to the latest version of your IDE.