@mastra/mcp-docs-server 0.13.0 → 0.13.1-alpha.2

package/.docs/raw/getting-started/project-structure.mdx

@@ -13,22 +13,9 @@ You could write everything in a single file, or separate each agent, tool, and w
 
 We don't enforce a specific folder structure, but we do recommend some best practices, and the CLI will scaffold a project with a sensible structure.
 
-## Using the CLI
+## Example Project Structure
 
-The Mastra CLI is [interactive](/docs/getting-started/installation#interactive) and allows you to:
-
-- **Choose a directory for Mastra files**: Specify where you want the Mastra files to be placed (default is `src/mastra`).
-- **Select components to install**: Choose which components you want to include in your project:
-  - Agents
-  - Tools
-  - Workflows
-- **Select a default LLM provider**: Choose from supported providers like OpenAI, Anthropic, Groq, Google or Cerebras.
-- **Include example code**: Decide whether to include example code to help you get started.
-- **Install Mastra docs MCP server**: Make your AI IDE a Mastra expert
-
-### Example Project Structure
-
-Assuming you select all components and include example code, your project structure will look like this:
+A default project created with the CLI looks like this:
 
 <FileTree>
   <FileTree.Folder name="src" defaultOpen>
@@ -49,7 +36,7 @@ Assuming you select all components and include example code, your project struct
   <FileTree.File name="package.json" />
   <FileTree.File name="tsconfig.json" />
 </FileTree>
-{/* 
+{/*
 ```
 root/
 ├── src/

package/.docs/raw/rag/vector-databases.mdx

@@ -180,22 +180,19 @@ await store.upsert({
   ```ts filename="vector-store.ts" showLineNumbers copy
   import { UpstashVector } from '@mastra/upstash'
 
+  // In upstash they refer to the store as an index
   const store = new UpstashVector({
     url: process.env.UPSTASH_URL,
     token: process.env.UPSTASH_TOKEN
   })
 
-  await store.createIndex({
-    indexName: "myCollection",
-    dimension: 1536,
-  });
-
+  // There is no store.createIndex call here, Upstash creates indexes (known as namespaces in Upstash) automatically
+  // when you upsert if that namespace does not exist yet.
   await store.upsert({
-    indexName: "myCollection",
+    indexName: "myCollection", // the namespace name in Upstash
     vectors: embeddings,
     metadata: chunks.map(chunk => ({ text: chunk.text })),
   });
-
 ```
 </Tabs.Tab>
 

package/.docs/raw/reference/agents/generate.mdx

@@ -66,6 +66,38 @@ An optional object that can include configuration for output structure, memory m
       description:
         "Defines the expected structure of the output. Can be a JSON Schema object or a Zod schema.",
     },
+    {
+      name: "memory",
+      type: "object",
+      isOptional: true,
+      description: "Configuration for memory. This is the preferred way to manage memory.",
+      properties: [
+        {
+          parameters: [{
+              name: "thread",
+              type: "string | { id: string; metadata?: Record<string, any>, title?: string }",
+              isOptional: false,
+              description: "The conversation thread, as a string ID or an object with an `id` and optional `metadata`."
+          }]
+        },
+        {
+          parameters: [{
+              name: "resource",
+              type: "string",
+              isOptional: false,
+              description: "Identifier for the user or resource associated with the thread."
+          }]
+        },
+        {
+          parameters: [{
+              name: "options",
+              type: "MemoryConfig",
+              isOptional: true,
+              description: "Configuration for memory behavior, like message history and semantic recall. See `MemoryConfig` below."
+          }]
+        }
+      ]
+    },
     {
       name: "maxSteps",
       type: "number",
@@ -85,7 +117,7 @@ An optional object that can include configuration for output structure, memory m
       type: "MemoryConfig",
       isOptional: true,
       description:
-        "Configuration options for memory management. See MemoryConfig section below for details.",
+        "**Deprecated.** Use `memory.options` instead. Configuration options for memory management. See MemoryConfig section below for details.",
     },
     {
       name: "onStepFinish",
@@ -99,7 +131,7 @@ An optional object that can include configuration for output structure, memory m
       type: "string",
       isOptional: true,
       description:
-        "Identifier for the user or resource interacting with the agent. Must be provided if threadId is provided.",
+        "**Deprecated.** Use `memory.resource` instead. Identifier for the user or resource interacting with the agent. Must be provided if threadId is provided.",
     },
     {
       name: "telemetry",
@@ -120,7 +152,7 @@ An optional object that can include configuration for output structure, memory m
       type: "string",
       isOptional: true,
       description:
-        "Identifier for the conversation thread. Allows for maintaining context across multiple interactions. Must be provided if resourceId is provided.",
+        "**Deprecated.** Use `memory.thread` instead. Identifier for the conversation thread. Allows for maintaining context across multiple interactions. Must be provided if resourceId is provided.",
     },
     {
       name: "toolChoice",

package/.docs/raw/reference/agents/stream.mdx

@@ -59,6 +59,38 @@ An optional object that can include configuration for output structure, memory m
       description:
         "Custom instructions that override the agent's default instructions for this specific generation. Useful for dynamically modifying agent behavior without creating a new agent instance.",
     },
+    {
+      name: "memory",
+      type: "object",
+      isOptional: true,
+      description: "Configuration for memory. This is the preferred way to manage memory.",
+      properties: [
+        {
+          parameters: [{
+              name: "thread",
+              type: "string | { id: string; metadata?: Record<string, any>, title?: string }",
+              isOptional: false,
+              description: "The conversation thread, as a string ID or an object with an `id` and optional `metadata`."
+          }]
+        },
+        {
+          parameters: [{
+              name: "resource",
+              type: "string",
+              isOptional: false,
+              description: "Identifier for the user or resource associated with the thread."
+          }]
+        },
+        {
+          parameters: [{
+              name: "options",
+              type: "MemoryConfig",
+              isOptional: true,
+              description: "Configuration for memory behavior, like message history and semantic recall. See `MemoryConfig` below."
+          }]
+        }
+      ]
+    },
     {
       name: "maxSteps",
       type: "number",
@@ -78,7 +110,7 @@ An optional object that can include configuration for output structure, memory m
       type: "MemoryConfig",
       isOptional: true,
       description:
-        "Configuration options for memory management. See MemoryConfig section below for details.",
+        "**Deprecated.** Use `memory.options` instead. Configuration options for memory management. See MemoryConfig section below for details.",
     },
     {
       name: "onFinish",
@@ -105,7 +137,7 @@ An optional object that can include configuration for output structure, memory m
       type: "string",
       isOptional: true,
       description:
-        "Identifier for the user or resource interacting with the agent. Must be provided if threadId is provided.",
+        "**Deprecated.** Use `memory.resource` instead. Identifier for the user or resource interacting with the agent. Must be provided if threadId is provided.",
     },
     {
       name: "telemetry",
@@ -126,7 +158,7 @@ An optional object that can include configuration for output structure, memory m
       type: "string",
       isOptional: true,
       description:
-        "Identifier for the conversation thread. Allows for maintaining context across multiple interactions. Must be provided if resourceId is provided.",
+        "**Deprecated.** Use `memory.thread` instead. Identifier for the conversation thread. Allows for maintaining context across multiple interactions. Must be provided if resourceId is provided.",
     },
     {
       name: "toolChoice",

package/.docs/raw/reference/client-js/memory.mdx

@@ -79,6 +79,8 @@ Delete a thread and its messages:
 await thread.delete();
 ```
 
+
+
 ## Message Operations
 
 ### Save Messages
@@ -101,6 +103,18 @@ const savedMessages = await client.saveMessageToMemory({
 });
 ```
 
+### Retrieve Thread Messages
+
+Get messages associated with a memory thread:
+
+```typescript
+// Get all messages in the thread
+const { messages } = await thread.getMessages();
+
+// Limit the number of messages retrieved
+const { messages } = await thread.getMessages({ limit: 10 });
+```
+
 ### Get Memory Status
 
 Check the status of the memory system:

package/.docs/raw/reference/client-js/workflows.mdx

@@ -125,6 +125,34 @@ try {
 }
 ```
 
+### Get Workflow Run result
+
+Get the result of a workflow run:
+
+```typescript
+try  {
+  const workflow = client.getWorkflow("testWorkflow");
+
+  const run = await workflow.createRun();
+
+  // start the workflow run
+  const startResult = await workflow.start({
+    runId: run.runId,
+    inputData: {
+      city: "New York",
+    },
+  });
+
+  const result = await workflow.runExecutionResult(run.runId);
+
+  console.log(result);
+} catch (e) {
+  console.error(e);
+}
+```
+
+This is useful when dealing with long running workflows. You can use this to poll the result of the workflow run.
+
 ### Workflow run result
 
 A workflow run result yields the following:

package/.docs/raw/reference/deployer/cloudflare.mdx

@@ -5,15 +5,22 @@ description: "Documentation for the CloudflareDeployer class, which deploys Mast
 
 # CloudflareDeployer
 
-The CloudflareDeployer deploys Mastra applications to Cloudflare Workers, handling configuration, environment variables, and route management. It extends the abstract Deployer class to provide Cloudflare-specific deployment functionality.
+The CloudflareDeployer deploys standalone Mastra applications to Cloudflare Workers, handling configuration, environment variables, and route management. It extends the abstract Deployer class to provide Cloudflare-specific deployment functionality.
+
+## Installation
+
+```bash copy
+npm install @mastra/deployer-cloudflare@latest
+```
 
 ## Usage Example
 
-```typescript
+```typescript filename="src/mastra/index.ts" showLineNumbers copy
 import { Mastra } from "@mastra/core";
 import { CloudflareDeployer } from "@mastra/deployer-cloudflare";
 
 const mastra = new Mastra({
+  // ...
   deployer: new CloudflareDeployer({
     scope: "your-account-id",
     projectName: "your-project-name",
@@ -43,7 +50,6 @@ const mastra = new Mastra({
       },
     ],
   }),
-  // ... other Mastra configuration options
 });
 ```
 

package/.docs/raw/reference/deployer/deployer.mdx

@@ -5,7 +5,7 @@ description: Documentation for the Deployer abstract class, which handles packag
 
 # Deployer
 
-The Deployer handles the deployment of Mastra applications by packaging code, managing environment files, and serving applications using the Hono framework. Concrete implementations must define the deploy method for specific deployment targets.
+The Deployer handles the deployment of standalone Mastra applications by packaging code, managing environment files, and serving applications using the Hono framework. Concrete implementations must define the deploy method for specific deployment targets.
 
 ## Usage Example
 

package/.docs/raw/reference/deployer/netlify.mdx

@@ -5,21 +5,27 @@ description: "Documentation for the NetlifyDeployer class, which deploys Mastra
 
 # NetlifyDeployer
 
-The NetlifyDeployer deploys Mastra applications to Netlify Functions, handling site creation, configuration, and deployment processes. It extends the abstract Deployer class to provide Netlify-specific deployment functionality.
+The NetlifyDeployer deploys standalone Mastra applications to Netlify Functions, handling site creation, configuration, and deployment processes. It extends the abstract Deployer class to provide Netlify-specific deployment functionality.
+
+## Installation
+
+```bash copy
+npm install @mastra/deployer-netlify@latest
+```
 
 ## Usage Example
 
-```typescript
+```typescript filename="src/mastra/index.ts" showLineNumbers copy
 import { Mastra } from "@mastra/core";
 import { NetlifyDeployer } from "@mastra/deployer-netlify";
 
 const mastra = new Mastra({
+  // ...
   deployer: new NetlifyDeployer({
     scope: "your-team-slug",
     projectName: "your-project-name",
     token: "your-netlify-token",
-  }),
-  // ... other Mastra configuration options
+  })
 });
 ```
 
@@ -115,6 +121,21 @@ After building, you can deploy your Mastra application `.mastra/output` to Netli
 
 2. **Netlify Dashboard**: Connect your Git repository or drag-and-drop the build output through the Netlify dashboard
 
+  When connecting a Mastra project Git repository to Netlify, use these recommended build settings since Netlify resolves paths relative to the project root:
+
+   ```bash
+   # Build command
+   npm run build
+
+   # Publish directory 
+   .mastra/output
+
+   # Functions directory
+   .mastra/output/netlify/functions
+   ```
+
+
+
 3. **Netlify Dev**: Run your Mastra application locally with Netlify's development environment
 
 > You can also run `netlify dev` in your output directory `.mastra/output` to test your Mastra application locally.

package/.docs/raw/reference/deployer/vercel.mdx

@@ -5,21 +5,27 @@ description: "Documentation for the VercelDeployer class, which deploys Mastra a
 
 # VercelDeployer
 
-The VercelDeployer deploys Mastra applications to Vercel, handling configuration, environment variable synchronization, and deployment processes. It extends the abstract Deployer class to provide Vercel-specific deployment functionality.
+The VercelDeployer deploys standalone Mastra applications to Vercel, handling configuration, environment variable synchronization, and deployment processes. It extends the abstract Deployer class to provide Vercel-specific deployment functionality.
+
+## Installation
+
+```bash copy
+npm install @mastra/deployer-vercel@latest
+```
 
 ## Usage Example
 
-```typescript
+```typescript filename="src/mastra/index.ts" showLineNumbers copy
 import { Mastra } from "@mastra/core";
 import { VercelDeployer } from "@mastra/deployer-vercel";
 
 const mastra = new Mastra({
+  // ...
   deployer: new VercelDeployer({
     teamSlug: "your-team-slug",
     projectName: "your-project-name",
     token: "your-vercel-token",
-  }),
-  // ... other Mastra configuration options
+  })
 });
 ```