@mastra/mcp-docs-server 1.0.0-beta.15 → 1.0.0-beta.17

package/.docs/raw/reference/storage/composite.mdx

@@ -0,0 +1,223 @@
+---
+title: "Reference: Storage Composition | Storage"
+description: Documentation for combining multiple storage backends in Mastra.
+---
+
+# Storage Composition
+
+MastraStorage can compose storage domains from different adapters. Use it when you need different databases for different purposes. For example, use LibSQL for memory and PostgreSQL for workflows.
+
+## Installation
+
+MastraStorage is included in `@mastra/core`:
+
+```bash
+npm install @mastra/core@beta
+```
+
+You'll also need to install the storage adapters you want to compose:
+
+```bash
+npm install @mastra/pg@beta @mastra/libsql@beta
+```
+
+## Usage
+
+### Basic composition
+
+Import domain classes directly from each store package and compose them:
+
+```typescript
+import { MastraStorage } from "@mastra/core/storage";
+import { MemoryPG, WorkflowsPG, ScoresPG } from "@mastra/pg";
+import { MemoryLibSQL } from "@mastra/libsql";
+import { Mastra } from "@mastra/core";
+
+const mastra = new Mastra({
+  storage: new MastraStorage({
+    id: "composite",
+    domains: {
+      memory: new MemoryLibSQL({ url: "file:./local.db" }),
+      workflows: new WorkflowsPG({ connectionString: process.env.DATABASE_URL }),
+      scores: new ScoresPG({ connectionString: process.env.DATABASE_URL }),
+    },
+  }),
+});
+```
+
+### With a default storage
+
+Use `default` to specify a fallback storage, then override specific domains:
+
+```typescript
+import { MastraStorage } from "@mastra/core/storage";
+import { PostgresStore } from "@mastra/pg";
+import { MemoryLibSQL } from "@mastra/libsql";
+import { Mastra } from "@mastra/core";
+
+const pgStore = new PostgresStore({
+  id: "pg",
+  connectionString: process.env.DATABASE_URL,
+});
+
+const mastra = new Mastra({
+  storage: new MastraStorage({
+    id: "composite",
+    default: pgStore,
+    domains: {
+      memory: new MemoryLibSQL({ url: "file:./local.db" }),
+    },
+  }),
+});
+```
+
+## Options
+
+<PropertiesTable
+  content={[
+    {
+      name: "id",
+      type: "string",
+      description: "Unique identifier for this storage instance.",
+      isOptional: false,
+    },
+    {
+      name: "default",
+      type: "MastraStorage",
+      description:
+        "Default storage adapter. Domains not explicitly specified in `domains` will use this storage's domains as fallbacks.",
+      isOptional: true,
+    },
+    {
+      name: "domains",
+      type: "object",
+      description:
+        "Individual domain overrides. Each domain can come from a different storage adapter. These take precedence over the default storage.",
+      isOptional: true,
+    },
+    {
+      name: "domains.memory",
+      type: "MemoryStorage",
+      description: "Storage for threads, messages, and resources.",
+      isOptional: true,
+    },
+    {
+      name: "domains.workflows",
+      type: "WorkflowsStorage",
+      description: "Storage for workflow snapshots.",
+      isOptional: true,
+    },
+    {
+      name: "domains.scores",
+      type: "ScoresStorage",
+      description: "Storage for evaluation scores.",
+      isOptional: true,
+    },
+    {
+      name: "domains.observability",
+      type: "ObservabilityStorage",
+      description: "Storage for traces and spans.",
+      isOptional: true,
+    },
+    {
+      name: "domains.agents",
+      type: "AgentsStorage",
+      description: "Storage for stored agent configurations.",
+      isOptional: true,
+    },
+    {
+      name: "disableInit",
+      type: "boolean",
+      description:
+        "When true, automatic initialization is disabled. You must call init() explicitly.",
+      isOptional: true,
+    },
+  ]}
+/>
+
+## Initialization
+
+MastraStorage initializes each configured domain independently. When passed to the Mastra class, `init()` is called automatically:
+
+```typescript
+import { MastraStorage } from "@mastra/core/storage";
+import { MemoryPG, WorkflowsPG, ScoresPG } from "@mastra/pg";
+import { Mastra } from "@mastra/core";
+
+const storage = new MastraStorage({
+  id: "composite",
+  domains: {
+    memory: new MemoryPG({ connectionString: process.env.DATABASE_URL }),
+    workflows: new WorkflowsPG({ connectionString: process.env.DATABASE_URL }),
+    scores: new ScoresPG({ connectionString: process.env.DATABASE_URL }),
+  },
+});
+
+const mastra = new Mastra({
+  storage, // init() called automatically
+});
+```
+
+If using storage directly, call `init()` explicitly:
+
+```typescript
+const storage = new MastraStorage({
+  id: "composite",
+  domains: {
+    memory: new MemoryPG({ connectionString: process.env.DATABASE_URL }),
+  },
+});
+
+await storage.init();
+
+// Access domain-specific stores via getStore()
+const memoryStore = await storage.getStore("memory");
+const thread = await memoryStore?.getThreadById({ threadId: "..." });
+```
+
+## Use Cases
+
+### Separate databases for different workloads
+
+Use a local database for development while keeping production data in a managed service:
+
+```typescript
+import { MastraStorage } from "@mastra/core/storage";
+import { MemoryPG, WorkflowsPG, ScoresPG } from "@mastra/pg";
+import { MemoryLibSQL } from "@mastra/libsql";
+
+const storage = new MastraStorage({
+  id: "composite",
+  domains: {
+    // Use local SQLite for development, PostgreSQL for production
+    memory:
+      process.env.NODE_ENV === "development"
+        ? new MemoryLibSQL({ url: "file:./dev.db" })
+        : new MemoryPG({ connectionString: process.env.DATABASE_URL }),
+    workflows: new WorkflowsPG({ connectionString: process.env.DATABASE_URL }),
+    scores: new ScoresPG({ connectionString: process.env.DATABASE_URL }),
+  },
+});
+```
+
+### Specialized storage for observability
+
+Use a time-series database for traces while keeping other data in PostgreSQL:
+
+```typescript
+import { MastraStorage } from "@mastra/core/storage";
+import { MemoryPG, WorkflowsPG, ScoresPG } from "@mastra/pg";
+import { ObservabilityStorageClickhouse } from "@mastra/clickhouse";
+
+const storage = new MastraStorage({
+  id: "composite",
+  domains: {
+    memory: new MemoryPG({ connectionString: process.env.DATABASE_URL }),
+    workflows: new WorkflowsPG({ connectionString: process.env.DATABASE_URL }),
+    scores: new ScoresPG({ connectionString: process.env.DATABASE_URL }),
+    observability: new ObservabilityStorageClickhouse({
+      url: process.env.CLICKHOUSE_URL,
+    }),
+  },
+});
+```

package/.docs/raw/reference/tools/mcp-server.mdx

@@ -41,6 +41,8 @@ const server = new MCPServer({
   id: "my-custom-server",
   name: "My Custom Server",
   version: "1.0.0",
+  description: "A server that provides weather data and agent capabilities",
+  instructions: "Use the available tools to help users with weather information and data processing tasks.",
   tools: { weatherTool },
   agents: { myAgent }, // this agent will become tool "ask_myAgent"
   workflows: {
@@ -102,6 +104,13 @@ The constructor accepts an `MCPServerConfig` object with the following propertie
       isOptional: true,
       description: "Optional description of what the MCP server does.",
     },
+    {
+      name: "instructions",
+      type: "string",
+      isOptional: true,
+      description:
+        "Optional instructions describing how to use the server and its features.",
+    },
     {
       name: "repository",
       type: "Repository", // { url: string; source: string; id: string; }

package/.docs/raw/reference/workflows/run-methods/cancel.mdx

@@ -7,12 +7,15 @@ description: Documentation for the `Run.cancel()` method in workflows, which can
 
 The `.cancel()` method cancels a workflow run, stopping execution and cleaning up resources.
 
+This method aborts any running steps and updates the workflow status to 'canceled'. It works for both actively running workflows and suspended/waiting workflows.
+
 ## Usage example
 
 ```typescript
 const run = await workflow.createRun();
 
 await run.cancel();
+// Returns: { message: 'Workflow run canceled' }
 ```
 
 ## Parameters
@@ -34,14 +37,31 @@ await run.cancel();
   content={[
     {
       name: "result",
-      type: "Promise<void>",
+      type: "Promise<{ message: string }>",
       description:
-        "A promise that resolves when the workflow run has been cancelled",
+        "A promise that resolves with { message: 'Workflow run canceled' } when cancellation succeeds",
     },
   ]}
 />
 
-## Extended usage example
+## How cancellation works
+
+When called, the workflow will:
+1. **Trigger the abort signal** - Uses the standard Web API AbortSignal to notify running steps
+2. **Prevent subsequent steps** - No further steps will be executed
+
+## Abort signal behavior
+
+Steps that check the `abortSignal` parameter can respond to cancellation:
+- Steps can listen to the 'abort' event: `abortSignal.addEventListener('abort', callback)`
+- Steps can check if already aborted: `if (abortSignal.aborted) { ... }`
+- Useful for cancelling timeouts, network requests, or long-running operations
+
+**Note:** Steps must actively check the abort signal to be canceled mid-execution. Steps that don't check the signal will run to completion, but subsequent steps won't execute.
+
+## Extended usage examples
+
+### Cancelling a workflow on error
 
 ```typescript
 const run = await workflow.createRun();
@@ -53,6 +73,34 @@ try {
 }
 ```
 
+### Creating a step that responds to cancellation
+
+```typescript
+const step = createStep({
+  id: 'long-running-step',
+  execute: async ({ inputData, abortSignal, abort }) => {
+    const timeout = new Promise((resolve) => {
+      const timer = setTimeout(() => resolve('done'), 10000);
+      
+      // Clean up if canceled
+      abortSignal.addEventListener('abort', () => {
+        clearTimeout(timer);
+        resolve('canceled');
+      });
+    });
+    
+    const result = await timeout;
+    
+    // Check if aborted after async operation
+    if (abortSignal.aborted) {
+      return abort(); // Stop execution
+    }
+    
+    return { result };
+  }
+});
+```
+
 ## Related
 
 - [Workflows overview](/docs/v1/workflows/overview#running-workflows)

package/.docs/raw/reference/workflows/run.mdx

@@ -53,8 +53,8 @@ if (result.status === "suspended") {
     },
     {
       name: "cancel",
-      type: "() => Promise<void>",
-      description: "Cancels the workflow execution",
+      type: "() => Promise<{ message: string }>",
+      description: "Cancels the workflow execution, stopping any running steps and preventing subsequent steps from executing",
       required: true,
     },
     {
@@ -102,6 +102,12 @@ A workflow run's `status` indicates its current execution state. The possible va
       description:
         "Workflow execution is paused waiting for resume, with suspended step information",
     },
+    {
+      name: "canceled",
+      type: "string",
+      description:
+        "Workflow execution was canceled via the cancel() method, stopping any running steps and preventing subsequent steps from executing",
+    },
   ]}
 />
 

package/CHANGELOG.md

@@ -1,5 +1,20 @@
 # @mastra/mcp-docs-server
 
+## 1.0.0-beta.17
+
+### Patch Changes
+
+- Updated dependencies [[`b5dc973`](https://github.com/mastra-ai/mastra/commit/b5dc9733a5158850298dfb103acb3babdba8a318)]:
+  - @mastra/core@1.0.0-beta.17
+
+## 1.0.0-beta.16
+
+### Patch Changes
+
+- Updated dependencies [[`3d93a15`](https://github.com/mastra-ai/mastra/commit/3d93a15796b158c617461c8b98bede476ebb43e2), [`efe406a`](https://github.com/mastra-ai/mastra/commit/efe406a1353c24993280ebc2ed61dd9f65b84b26), [`119e5c6`](https://github.com/mastra-ai/mastra/commit/119e5c65008f3e5cfca954eefc2eb85e3bf40da4), [`74e504a`](https://github.com/mastra-ai/mastra/commit/74e504a3b584eafd2f198001c6a113bbec589fd3), [`e33fdbd`](https://github.com/mastra-ai/mastra/commit/e33fdbd07b33920d81e823122331b0c0bee0bb59), [`929f69c`](https://github.com/mastra-ai/mastra/commit/929f69c3436fa20dd0f0e2f7ebe8270bd82a1529), [`8a73529`](https://github.com/mastra-ai/mastra/commit/8a73529ca01187f604b1f3019d0a725ac63ae55f)]:
+  - @mastra/core@1.0.0-beta.16
+  - @mastra/mcp@1.0.0-beta.7
+
 ## 1.0.0-beta.15
 
 ### Patch Changes

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mastra/mcp-docs-server",
-  "version": "1.0.0-beta.15",
+  "version": "1.0.0-beta.17",
   "description": "MCP server for accessing Mastra.ai documentation, changelogs, and news.",
   "type": "module",
   "main": "dist/index.js",
@@ -28,8 +28,8 @@
     "@modelcontextprotocol/sdk": "^1.17.5",
     "jsdom": "^26.1.0",
     "zod": "^3.25.76",
-    "@mastra/core": "1.0.0-beta.15",
-    "@mastra/mcp": "^1.0.0-beta.6"
+    "@mastra/mcp": "^1.0.0-beta.7",
+    "@mastra/core": "1.0.0-beta.17"
   },
   "devDependencies": {
     "@hono/node-server": "^1.19.6",
@@ -46,7 +46,7 @@
     "typescript": "^5.8.3",
     "vitest": "4.0.12",
     "@internal/lint": "0.0.53",
-    "@mastra/core": "1.0.0-beta.15"
+    "@mastra/core": "1.0.0-beta.17"
   },
   "homepage": "https://mastra.ai",
   "repository": {