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

package/.docs/raw/reference/client-js/error-handling.mdx

@@ -1,6 +1,8 @@
 ---
 title: "Reference: Error Handling | Client SDK"
 description: Learn about the built-in retry mechanism and error handling capabilities in the Mastra client-js SDK.
+packages:
+  - "@mastra/client-js"
 ---
 
 # Error Handling
@@ -14,9 +16,7 @@ All API methods can throw errors that you can catch and handle:
 ```typescript
 try {
   const agent = mastraClient.getAgent("agent-id");
-  const response = await agent.generate({
-    messages: [{ role: "user", content: "Hello" }],
-  });
+  const response = await agent.generate("Hello");
 } catch (error) {
   console.error("An error occurred:", error.message);
 }

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

@@ -1,6 +1,8 @@
 ---
 title: "Reference: Logs API | Client SDK"
 description: Learn how to access and query system logs and debugging information in Mastra using the client-js SDK.
+packages:
+  - "@mastra/client-js"
 ---
 
 # Logs API

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

@@ -1,15 +1,17 @@
 ---
 title: "Reference: Mastra Client SDK | Client SDK"
 description: Learn how to interact with Mastra using the client-js SDK.
+packages:
+  - "@mastra/client-js"
 ---
 
 # Mastra Client SDK
 
-The Mastra Client SDK provides a simple and type-safe interface for interacting with your [Mastra Server](/docs/v1/deployment/building-mastra) from your client environment.
+The Mastra Client SDK provides a simple and type-safe interface for interacting with your [Mastra Server](/docs/v1/deployment/mastra-server) from your client environment.
 
 ## Usage example
 
-```typescript title="lib/mastra/mastra-client.ts" showLineNumbers copy
+```typescript title="lib/mastra/mastra-client.ts"
 import { MastraClient } from "@mastra/client-js";
 
 export const mastraClient = new MastraClient({
@@ -101,8 +103,8 @@ export const mastraClient = new MastraClient({
     },
     {
       name: "saveMessageToMemory(params)",
-      type: "Promise<void>",
-      description: "Saves one or more messages to the memory system.",
+      type: "Promise<{ messages: (MastraMessageV1 | MastraDBMessage)[] }>",
+      description: "Saves one or more messages to the memory system. Returns the saved messages.",
     },
     {
       name: "getMemoryStatus()",

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

@@ -1,6 +1,8 @@
 ---
 title: "Reference: Memory API | Client SDK"
 description: Learn how to manage conversation threads and message history in Mastra using the client-js SDK.
+packages:
+  - "@mastra/client-js"
 ---
 
 # Memory API
@@ -14,10 +16,12 @@ Retrieve all memory threads for a specific resource:
 ```typescript
 const threads = await mastraClient.getMemoryThreads({
   resourceId: "resource-1",
-  agentId: "agent-1",
+  agentId: "agent-1", // Optional - can be omitted if storage is configured
 });
 ```
 
+When `agentId` is omitted and storage is configured on the server, threads will be retrieved using storage directly. This is useful when multiple agents share the same threads (e.g., in workflows with multiple agent steps).
+
 ### Create a New Thread
 
 Create a new memory thread:
@@ -69,6 +73,44 @@ Delete a thread and its messages:
 await thread.delete();
 ```
 
+### Clone Thread
+
+Create a copy of a thread with all its messages:
+
+```typescript
+const { thread: clonedThread, clonedMessages } = await thread.clone();
+```
+
+Clone with options:
+
+```typescript
+const { thread: clonedThread, clonedMessages } = await thread.clone({
+  newThreadId: "custom-clone-id",
+  title: "Cloned Conversation",
+  metadata: { branch: "experiment-1" },
+  options: {
+    messageLimit: 10, // Only clone last 10 messages
+  },
+});
+```
+
+Clone with message filtering:
+
+```typescript
+const { thread: clonedThread } = await thread.clone({
+  options: {
+    messageFilter: {
+      startDate: new Date("2024-01-01"),
+      endDate: new Date("2024-01-31"),
+    },
+  },
+});
+```
+
+The clone response includes:
+- `thread`: The newly created cloned thread with clone metadata
+- `clonedMessages`: Array of the cloned messages with new IDs
+
 ## Message Operations
 
 ### Save Messages
@@ -76,7 +118,7 @@ await thread.delete();
 Save messages to memory:
 
 ```typescript
-const savedMessages = await mastraClient.saveMessageToMemory({
+const result = await mastraClient.saveMessageToMemory({
   messages: [
     {
       role: "user",
@@ -90,6 +132,9 @@ const savedMessages = await mastraClient.saveMessageToMemory({
   ],
   agentId: "agent-1",
 });
+
+// result.messages contains the saved messages
+console.log(result.messages);
 ```
 
 ### Retrieve Thread Messages

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

@@ -1,6 +1,8 @@
 ---
 title: "Reference: Observability API | Client SDK"
 description: Learn how to retrieve traces, monitor application performance, and score traces using the client-js SDK.
+packages:
+  - "@mastra/client-js"
 ---
 
 # Observability API

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

@@ -1,6 +1,8 @@
 ---
 title: "Reference: Telemetry API | Client SDK"
 description: Learn how to retrieve and analyze traces from your Mastra application for monitoring and debugging using the client-js SDK.
+packages:
+  - "@mastra/client-js"
 ---
 
 # Telemetry API

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

@@ -1,6 +1,8 @@
 ---
 title: "Reference: Tools API | Client SDK"
 description: Learn how to interact with and execute tools available in the Mastra platform using the client-js SDK.
+packages:
+  - "@mastra/client-js"
 ---
 
 # Tools API

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

@@ -1,6 +1,8 @@
 ---
 title: "Reference: Vectors API | Client SDK"
 description: Learn how to work with vector embeddings for semantic search and similarity matching in Mastra using the client-js SDK.
+packages:
+  - "@mastra/client-js"
 ---
 
 # Vectors API

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

@@ -1,6 +1,8 @@
 ---
 title: "Reference: Workflows API | Client SDK"
 description: Learn how to interact with and execute automated workflows in Mastra using the client-js SDK.
+packages:
+  - "@mastra/client-js"
 ---
 
 # Workflows API
@@ -48,8 +50,16 @@ const run = await workflow.createRun();
 
 // Or with an existing runId
 const run = await workflow.createRun({ runId: "existing-run-id" });
+
+// Or with a resourceId to associate the run with a specific resource
+const run = await workflow.createRun({
+  runId: "my-run-id",
+  resourceId: "user-123"
+});
 ```
 
+The `resourceId` parameter associates the workflow run with a specific resource (e.g., user ID, tenant ID). This value is persisted with the run and can be used for filtering and querying runs later.
+
 ### startAsync()
 
 Start a workflow run and await the full result:
@@ -80,6 +90,18 @@ const result = await run.startAsync({
 
 The `initialState` object should match the structure defined in the workflow's `stateSchema`. See [Workflow State](/docs/v1/workflows/workflow-state) for more details.
 
+To associate a run with a specific resource, pass `resourceId` to `createRun()`:
+
+```typescript
+const run = await workflow.createRun({ resourceId: "user-123" });
+
+const result = await run.startAsync({
+  inputData: {
+    city: "New York",
+  },
+});
+```
+
 ### start()
 
 Start a workflow run without waiting for completion:
@@ -94,7 +116,7 @@ await run.start({
 });
 
 // Poll for results later
-const result = await workflow.runExecutionResult(run.runId);
+const result = await workflow.runById(run.runId);
 ```
 
 This is useful for long-running workflows where you want to start execution and check results later.
@@ -125,6 +147,21 @@ await run.resume({
 });
 ```
 
+### cancel()
+
+Cancel a running workflow:
+
+```typescript
+const run = await workflow.createRun({ runId: existingRunId });
+
+const result = await run.cancel();
+// Returns: { message: 'Workflow run canceled' }
+```
+
+This method stops any running steps and prevents subsequent steps from executing. Steps that check the `abortSignal` parameter can respond to cancellation by cleaning up resources (timeouts, network requests, etc.).
+
+See the [Run.cancel()](/reference/v1/workflows/run-methods/cancel) reference for detailed information about how cancellation works and how to write steps that respond to cancellation.
+
 ### stream()
 
 Stream workflow execution for real-time updates:
@@ -143,12 +180,19 @@ for await (const chunk of stream) {
 }
 ```
 
-### runExecutionResult()
+### runById()
 
 Get the execution result for a workflow run:
 
 ```typescript
-const result = await workflow.runExecutionResult(runId);
+const result = await workflow.runById(runId);
+
+// Or with options for performance optimization:
+const result = await workflow.runById(runId, {
+  fields: ['status', 'result'],  // Only fetch specific fields
+  withNestedWorkflows: false,    // Skip expensive nested workflow data
+  requestContext: { userId: 'user-123' }, // Optional request context
+});
 ```
 
 <h3>Run result format</h3>