@mastra/mcp-docs-server 1.0.0-beta.8 → 1.0.0

package/.docs/raw/reference/core/listMemory.mdx

@@ -0,0 +1,74 @@
+---
+title: "Reference: Mastra.listMemory() | Core"
+description: "Documentation for the `Mastra.listMemory()` method in Mastra, which returns all registered memory instances."
+packages:
+  - "@mastra/core"
+  - "@mastra/libsql"
+  - "@mastra/memory"
+---
+
+# Mastra.listMemory()
+
+The `.listMemory()` method returns all memory instances registered with the Mastra instance.
+
+## Usage example
+
+```typescript
+const memoryInstances = mastra.listMemory();
+
+for (const [key, memory] of Object.entries(memoryInstances)) {
+  console.log(`Memory "${key}": ${memory.id}`);
+}
+```
+
+## Parameters
+
+This method takes no parameters.
+
+## Returns
+
+<PropertiesTable
+  content={[
+    {
+      name: "memory",
+      type: "Record<string, MastraMemory>",
+      description:
+        "An object containing all registered memory instances, keyed by their registry keys.",
+    },
+  ]}
+/>
+
+## Example: Checking Registered Memory
+
+```typescript
+import { Mastra } from "@mastra/core";
+import { Memory } from "@mastra/memory";
+import { LibSQLStore } from "@mastra/libsql";
+
+const conversationMemory = new Memory({
+  id: "conversation-memory",
+  storage: new LibSQLStore({ id: 'conversation-store', url: ":memory:" }),
+});
+
+const analyticsMemory = new Memory({
+  id: "analytics-memory",
+  storage: new LibSQLStore({ id: 'analytics-store', url: ":memory:" }),
+});
+
+const mastra = new Mastra({
+  memory: {
+    conversationMemory,
+    analyticsMemory,
+  },
+});
+
+// List all registered memory instances
+const allMemory = mastra.listMemory();
+console.log(Object.keys(allMemory)); // ["conversationMemory", "analyticsMemory"]
+```
+
+## Related
+
+- [Mastra.getMemory()](/reference/v1/core/getMemory)
+- [Memory overview](/docs/v1/memory/overview)
+- [Agent Memory](/docs/v1/agents/agent-memory)

package/.docs/raw/reference/core/listScorers.mdx

@@ -1,6 +1,8 @@
 ---
 title: "Reference: listScorers() | Core"
 description: "Documentation for the `listScorers()` method in Mastra, which returns all registered scorers for evaluating AI outputs."
+packages:
+  - "@mastra/core"
 ---
 
 # listScorers()

package/.docs/raw/reference/core/listStoredAgents.mdx

@@ -0,0 +1,153 @@
+---
+title: "Reference: Mastra.listStoredAgents() | Core"
+description: "Documentation for the `Mastra.listStoredAgents()` method in Mastra, which retrieves a paginated list of agents from storage."
+packages:
+  - "@mastra/core"
+---
+
+# Mastra.listStoredAgents()
+
+The `.listStoredAgents()` method retrieves a paginated list of agent configurations from storage. By default, it returns executable `Agent` instances, but can also return raw storage data.
+
+## Usage example
+
+```typescript
+// Get Agent instances from storage
+const { agents, total, hasMore } = await mastra.listStoredAgents();
+
+for (const agent of agents) {
+  console.log(agent.id, agent.name);
+  // Each agent is ready to use
+  // const response = await agent.generate("Hello");
+}
+```
+
+```typescript
+// Get paginated results with raw storage data
+const result = await mastra.listStoredAgents({
+  page: 0,
+  perPage: 10,
+  raw: true,
+});
+
+console.log(`Showing ${result.agents.length} of ${result.total} agents`);
+console.log(`Has more: ${result.hasMore}`);
+
+for (const config of result.agents) {
+  console.log(config.id, config.name, config.createdAt);
+}
+```
+
+## Parameters
+
+<PropertiesTable
+  content={[
+    {
+      name: "args",
+      type: "object",
+      description:
+        "Optional configuration object for pagination and output format.",
+      isOptional: true,
+    },
+  ]}
+/>
+
+### Args Options
+
+<PropertiesTable
+  content={[
+    {
+      name: "page",
+      type: "number",
+      description: "Zero-indexed page number for pagination.",
+      isOptional: true,
+      defaultValue: "0",
+    },
+    {
+      name: "perPage",
+      type: "number | false",
+      description:
+        "Number of items per page. Set to `false` to fetch all records without pagination.",
+      isOptional: true,
+      defaultValue: "100",
+    },
+    {
+      name: "raw",
+      type: "boolean",
+      description:
+        "When `true`, returns raw `StorageAgentType` objects instead of `Agent` instances.",
+      isOptional: true,
+      defaultValue: "false",
+    },
+  ]}
+/>
+
+## Returns
+
+<PropertiesTable
+  content={[
+    {
+      name: "agents",
+      type: "Agent[] | StorageAgentType[]",
+      description:
+        "Array of `Agent` instances by default, or `StorageAgentType` objects when `raw: true`.",
+    },
+    {
+      name: "total",
+      type: "number",
+      description: "Total number of stored agents across all pages.",
+    },
+    {
+      name: "page",
+      type: "number",
+      description: "Current page number (zero-indexed).",
+    },
+    {
+      name: "perPage",
+      type: "number | false",
+      description: "Number of items per page, or `false` if fetching all.",
+    },
+    {
+      name: "hasMore",
+      type: "boolean",
+      description: "Whether there are more pages available.",
+    },
+  ]}
+/>
+
+## Primitive Resolution
+
+When creating `Agent` instances (default behavior), each stored agent's configuration is resolved against registered primitives:
+
+- **Tools**: Resolved from `tools` registered in Mastra config
+- **Workflows**: Resolved from `workflows` registered in Mastra config
+- **Sub-agents**: Resolved from `agents` registered in Mastra config
+- **Memory**: Resolved from `memory` registered in Mastra config
+- **Scorers**: Resolved from `scorers` registered in Mastra config
+
+If a referenced primitive is not found, a warning is logged but the agent is still created.
+
+## Example: Iterating Through All Stored Agents
+
+```typescript
+async function getAllStoredAgents(mastra: Mastra) {
+  const allAgents: Agent[] = [];
+  let page = 0;
+  let hasMore = true;
+
+  while (hasMore) {
+    const result = await mastra.listStoredAgents({ page, perPage: 50 });
+    allAgents.push(...result.agents);
+    hasMore = result.hasMore;
+    page++;
+  }
+
+  return allAgents;
+}
+```
+
+## Related
+
+- [Mastra.getStoredAgentById()](/reference/v1/core/getStoredAgentById)
+- [Storage overview](/reference/v1/storage/overview)
+- [Agents overview](/docs/v1/agents/overview)

package/.docs/raw/reference/core/listVectors.mdx

@@ -1,6 +1,8 @@
 ---
 title: "Reference: Mastra.listVectors() | Core"
 description: "Documentation for the `Mastra.listVectors()` method in Mastra, which retrieves all configured vector stores."
+packages:
+  - "@mastra/core"
 ---
 
 # Mastra.listVectors()
@@ -9,7 +11,7 @@ The `.listVectors()` method is used to retrieve all vector stores that have been
 
 ## Usage example
 
-```typescript copy
+```typescript
 mastra.listVectors();
 ```
 

package/.docs/raw/reference/core/listWorkflows.mdx

@@ -1,6 +1,8 @@
 ---
 title: "Reference: Mastra.listWorkflows() | Core"
 description: "Documentation for the `Mastra.listWorkflows()` method in Mastra, which retrieves all configured workflows."
+packages:
+  - "@mastra/core"
 ---
 
 # Mastra.listWorkflows()
@@ -9,7 +11,7 @@ The `.listWorkflows()` method is used to retrieve all workflows that have been c
 
 ## Usage example
 
-```typescript copy
+```typescript
 mastra.listWorkflows();
 ```
 

package/.docs/raw/reference/core/mastra-class.mdx

@@ -1,16 +1,17 @@
 ---
 title: "Reference: Mastra Class | Core"
 description: "Documentation for the `Mastra` class in Mastra, the core entry point for managing agents, workflows, MCP servers, and server endpoints."
+packages:
+  - "@mastra/core"
+  - "@mastra/libsql"
+  - "@mastra/loggers"
 ---
 
 # Mastra Class
 
-The `Mastra` class is the central orchestrator in any Mastra application, managing agents, workflows, storage, logging, telemetry, and more. Typically, you create a single instance of `Mastra` to coordinate your application.
+The `Mastra` class is the central orchestrator in any Mastra application, managing agents, workflows, storage, logging, observability, and more. Typically, you create a single instance of `Mastra` to coordinate your application.
 
-Think of `Mastra` as a top-level registry:
-
-- Registering **integrations** makes them accessible to **agents**, **workflows**, and **tools** alike.
-- **tools** aren’t registered on `Mastra` directly but are associated with agents and discovered automatically.
+Think of `Mastra` as a top-level registry where you register agents, workflows, tools, and other components that need to be accessible throughout your application.
 
 ## Usage example
 
@@ -37,14 +38,16 @@ export const mastra = new Mastra({
 
 ## Constructor parameters
 
+Visit the [Configuration reference](/reference/v1/configuration) for detailed documentation on all available configuration options.
+
 <PropertiesTable
   content={[
     {
       name: "agents",
-      type: "Agent[]",
-      description: "Array of Agent instances to register",
+      type: "Record<string, Agent>",
+      description: "Agent instances to register, keyed by name",
       isOptional: true,
-      defaultValue: "[]",
+      defaultValue: "{}",
     },
     {
       name: "tools",
@@ -56,7 +59,7 @@ export const mastra = new Mastra({
     },
     {
       name: "storage",
-      type: "MastraStorage",
+      type: "MastraCompositeStore",
       description: "Storage engine instance for persisting data",
       isOptional: true,
     },
@@ -91,15 +94,15 @@ export const mastra = new Mastra({
     },
     {
       name: "tts",
-      type: "Record<string, MastraTTS>",
+      type: "Record<string, MastraVoice>",
       isOptional: true,
-      description: "An object for registering Text-To-Speech services.",
+      description: "Text-to-speech providers for voice synthesis",
     },
     {
-      name: "telemetry",
-      type: "OtelConfig",
+      name: "observability",
+      type: "ObservabilityEntrypoint",
       isOptional: true,
-      description: "Configuration for OpenTelemetry integration.",
+      description: "Observability configuration for tracing and monitoring",
     },
     {
       name: "deployer",
@@ -113,8 +116,6 @@ export const mastra = new Mastra({
       description:
         "Server configuration including port, host, timeout, API routes, middleware, CORS settings, and build options for Swagger UI, API request logging, and OpenAPI docs.",
       isOptional: true,
-      defaultValue:
-        "{ port: 4111, host: localhost,  cors: { origin: '*', allowMethods: ['GET', 'POST', 'PUT', 'PATCH', 'DELETE', 'OPTIONS'], allowHeaders: ['Content-Type', 'Authorization', 'x-mastra-client-type'], exposeHeaders: ['Content-Length', 'X-Requested-With'], credentials: false } }",
     },
     {
       name: "mcpServers",
@@ -129,14 +130,20 @@ export const mastra = new Mastra({
       description:
         "Configuration for the asset bundler with options for externals, sourcemap, and transpilePackages.",
       isOptional: true,
-      defaultValue:
-        "{ externals: [], sourcemap: false, transpilePackages: [] }",
     },
     {
       name: "scorers",
-      type: "Record<string, MastraScorer>",
+      type: "Record<string, Scorer>",
       description:
-        "Scorers to register for scoring traces and overriding default scorers used during agent generation or workflow execution. Structured as a key-value pair, with keys being the scorer name and values being the scorer instance.",
+        "Scorers for evaluating agent responses and workflow outputs",
+      isOptional: true,
+      defaultValue: "{}",
+    },
+    {
+      name: "processors",
+      type: "Record<string, Processor>",
+      description:
+        "Input/output processors for transforming agent inputs and outputs",
       isOptional: true,
       defaultValue: "{}",
     },
@@ -148,5 +155,13 @@ export const mastra = new Mastra({
       isOptional: true,
       defaultValue: "{}",
     },
+    {
+      name: "memory",
+      type: "Record<string, MastraMemory>",
+      description:
+        "Memory instances to register. These can be referenced by stored agents and resolved at runtime. Structured as a key-value pair, with keys being the registry key and values being memory instances.",
+      isOptional: true,
+      defaultValue: "{}",
+    },
   ]}
 />

package/.docs/raw/reference/core/mastra-model-gateway.mdx

@@ -1,6 +1,8 @@
 ---
 title: "Reference: MastraModelGateway | Core"
 description: "Base class for creating custom model gateways"
+packages:
+  - "@mastra/core"
 ---
 
 # MastraModelGateway

package/.docs/raw/reference/core/setLogger.mdx

@@ -1,6 +1,8 @@
 ---
 title: "Reference: Mastra.setLogger() | Core"
 description: "Documentation for the `Mastra.setLogger()` method in Mastra, which sets the logger for all components (agents, workflows, etc.)."
+packages:
+  - "@mastra/core"
 ---
 
 # Mastra.setLogger()
@@ -9,7 +11,7 @@ The `.setLogger()` method is used to set the logger for all components (agents,
 
 ## Usage example
 
-```typescript copy
+```typescript
 mastra.setLogger({ logger: new PinoLogger({ name: "testLogger" }) });
 ```
 

package/.docs/raw/reference/core/setStorage.mdx

@@ -1,15 +1,17 @@
 ---
 title: "Reference: Mastra.setStorage() | Core"
 description: "Documentation for the `Mastra.setStorage()` method in Mastra, which sets the storage instance for the Mastra instance."
+packages:
+  - "@mastra/core"
 ---
 
 # Mastra.setStorage()
 
-The `.setStorage()` method is used to set the storage instance for the Mastra instance. This method accepts a single `MastraStorage` parameter.
+The `.setStorage()` method is used to set the storage instance for the Mastra instance. This method accepts a single `MastraCompositeStore` parameter.
 
 ## Usage example
 
-```typescript copy
+```typescript
 mastra.setStorage(
   new LibSQLStore({
     id: 'mastra-storage',
@@ -24,7 +26,7 @@ mastra.setStorage(
   content={[
     {
       name: "storage",
-      type: "MastraStorage",
+      type: "MastraCompositeStore",
       description: "The storage instance to set for the Mastra instance.",
     },
   ]}
@@ -36,5 +38,5 @@ This method does not return a value.
 
 ## Related
 
-- [Storage overview](/docs/v1/server-db/storage)
+- [Storage overview](/reference/v1/storage/overview)
 - [Storage reference](/reference/v1/storage/libsql)

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

@@ -1,6 +1,9 @@
 ---
 title: "Reference: CloudflareDeployer | Deployer"
 description: "Documentation for the CloudflareDeployer class, which deploys Mastra applications to Cloudflare Workers."
+packages:
+  - "@mastra/core"
+  - "@mastra/deployer-cloudflare"
 ---
 
 # CloudflareDeployer
@@ -9,14 +12,13 @@ The `CloudflareDeployer` class handles deployment of standalone Mastra applicati
 
 ## Usage example
 
-```typescript title="src/mastra/index.ts" showLineNumbers copy
+```typescript title="src/mastra/index.ts"
 import { Mastra } from "@mastra/core";
 import { CloudflareDeployer } from "@mastra/deployer-cloudflare";
 
 export const mastra = new Mastra({
-  // ...
   deployer: new CloudflareDeployer({
-    projectName: "hello-mastra",
+    name: "hello-mastra",
     routes: [
       {
         pattern: "example.com/*",
@@ -24,12 +26,11 @@ export const mastra = new Mastra({
         custom_domain: true
       }
     ],
-    workerNamespace: "my-namespace",
-    env: {
+    vars: {
       NODE_ENV: "production",
       API_KEY: "<api-key>"
     },
-    d1Databases: [
+    d1_databases: [
       {
         binding: "DB",
         database_name: "my-database",
@@ -37,59 +38,27 @@ export const mastra = new Mastra({
         preview_database_id: "your-preview-database-id"
       }
     ],
-    kvNamespaces: [
+    kv_namespaces: [
       {
         binding: "CACHE",
         id: "kv-namespace-id"
       }
     ]
+  })
 });
 ```
 
-## Parameters
+## Constructor options
 
-<PropertiesTable
-  content={[
-    {
-      name: "projectName",
-      type: "string",
-      description: "Name of your worker project.",
-      isOptional: true,
-      defaultValue: "'mastra'",
-    },
-    {
-      name: "routes",
-      type: "CFRoute[]",
-      description:
-        "Array of route configurations for your worker. Each route requires: pattern (string), zone_name (string), custom_domain (boolean, optional).",
-      isOptional: true,
-    },
-    {
-      name: "workerNamespace",
-      type: "string",
-      description: "Namespace for your worker.",
-      isOptional: true,
-    },
-    {
-      name: "env",
-      type: "Record<string, any>",
-      description:
-        "Environment variables to be included in the worker configuration.",
-      isOptional: true,
-    },
-    {
-      name: "d1Databases",
-      type: "D1DatabaseBinding[]",
-      description:
-        "Array of D1 database bindings. Each binding requires: binding (string), database_name (string), database_id (string), preview_database_id (string, optional).",
-      isOptional: true,
-    },
-    {
-      name: "kvNamespaces",
-      type: "KVNamespaceBinding[]",
-      description:
-        "Array of KV namespace bindings. Each binding requires: binding (string), id (string).",
-      isOptional: true,
-    },
-  ]}
-/>
+The `CloudflareDeployer` constructor accepts the same configuration options as `wrangler.json`. See the [Wrangler configuration documentation](https://developers.cloudflare.com/workers/wrangler/configuration/) for all available options.
+
+### Migrating from earlier versions
+
+The following fields are deprecated and should be replaced with their standard `wrangler.json` equivalents:
+
+| Deprecated | Use instead |
+|------------|-------------|
+| `projectName` | `name` |
+| `d1Databases` | `d1_databases` |
+| `kvNamespaces` | `kv_namespaces` |
+| `workerNamespace` | *(removed, no longer used)* |

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

@@ -2,6 +2,8 @@
 title: "Reference: Deployer | Deployer"
 description: Documentation for the Deployer abstract class, which handles packaging and deployment of Mastra applications.
 asIndexPage: true
+packages:
+  - "@mastra/deployer"
 ---
 
 # Deployer
@@ -28,7 +30,6 @@ class CustomDeployer extends Deployer {
     await this._bundle("server.ts", "mastra.ts", outputDirectory);
 
     // Custom deployment logic
-    // ...
   }
 }
 ```

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

@@ -1,6 +1,9 @@
 ---
 title: "Reference: NetlifyDeployer | Deployer"
 description: "Documentation for the NetlifyDeployer class, which deploys Mastra applications to Netlify Functions."
+packages:
+  - "@mastra/core"
+  - "@mastra/deployer-netlify"
 ---
 
 # NetlifyDeployer
@@ -9,7 +12,7 @@ The `NetlifyDeployer` class handles deployment of standalone Mastra applications
 
 ## Usage example
 
-```typescript title="src/mastra/index.ts" copy
+```typescript title="src/mastra/index.ts"
 import { Mastra } from "@mastra/core";
 import { NetlifyDeployer } from "@mastra/deployer-netlify";
 

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

@@ -1,6 +1,9 @@
 ---
 title: "Reference: VercelDeployer | Deployer"
 description: "Documentation for the VercelDeployer class, which deploys Mastra applications to Vercel."
+packages:
+  - "@mastra/core"
+  - "@mastra/deployer-vercel"
 ---
 
 # VercelDeployer
@@ -9,12 +12,11 @@ The `VercelDeployer` class handles deployment of standalone Mastra applications
 
 ## Usage example
 
-```typescript title="src/mastra/index.ts" showLineNumbers copy
+```typescript title="src/mastra/index.ts"
 import { Mastra } from "@mastra/core";
 import { VercelDeployer } from "@mastra/deployer-vercel";
 
 export const mastra = new Mastra({
-  // ...
   deployer: new VercelDeployer(),
 });
 ```
@@ -31,12 +33,11 @@ These options are merged into `.vercel/output/functions/index.func/.vc-config.js
 
 ### Example with overrides
 
-```typescript title="src/mastra/index.ts" showLineNumbers copy
+```typescript title="src/mastra/index.ts"
 import { Mastra } from "@mastra/core";
 import { VercelDeployer } from "@mastra/deployer-vercel";
 
 export const mastra = new Mastra({
-  // ...
   deployer: new VercelDeployer({
     maxDuration: 600,
     memory: 1536,

package/.docs/raw/reference/evals/answer-relevancy.mdx

@@ -1,6 +1,9 @@
 ---
 title: "Reference: Answer Relevancy Scorer | Evals"
 description: Documentation for the Answer Relevancy Scorer in Mastra, which evaluates how well LLM outputs address the input query.
+packages:
+  - "@mastra/core"
+  - "@mastra/evals"
 ---
 
 # Answer Relevancy Scorer
@@ -116,7 +119,7 @@ A relevancy score between 0 and 1:
 
 Evaluate agent responses for relevancy across different scenarios:
 
-```typescript title="src/example-answer-relevancy.ts" showLineNumbers copy
+```typescript title="src/example-answer-relevancy.ts"
 import { runEvals } from "@mastra/core/evals";
 import { createAnswerRelevancyScorer } from "@mastra/evals/scorers/prebuilt";
 import { myAgent } from "./agent";

package/.docs/raw/reference/evals/answer-similarity.mdx

@@ -1,6 +1,9 @@
 ---
 title: "Reference: Answer Similarity Scorer | Evals"
 description: Documentation for the Answer Similarity Scorer in Mastra, which compares agent outputs against ground truth answers for CI/CD testing.
+packages:
+  - "@mastra/core"
+  - "@mastra/evals"
 ---
 
 # Answer Similarity Scorer
@@ -153,7 +156,7 @@ Score calculation: `max(0, base_score - contradiction_penalty - missing_penalty
 
 Evaluate agent responses for similarity to ground truth across different scenarios:
 
-```typescript title="src/example-answer-similarity.ts" showLineNumbers copy
+```typescript title="src/example-answer-similarity.ts"
 import { runEvals } from "@mastra/core/evals";
 import { createAnswerSimilarityScorer } from "@mastra/evals/scorers/prebuilt";
 import { myAgent } from "./agent";