@mastra/mcp-docs-server 1.0.0-beta.1 → 1.0.0-beta.11

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

@@ -1,5 +1,5 @@
 ---
-title: "Reference: Workflows API | Client SDK | Mastra Docs"
+title: "Reference: Workflows API | Client SDK"
 description: Learn how to interact with and execute automated workflows in Mastra using the client-js SDK.
 ---
 
@@ -17,7 +17,7 @@ const workflows = await mastraClient.listWorkflows();
 
 ## Working with a Specific Workflow
 
-Get an instance of a specific workflow as defined by the const name:
+Get an instance of a specific workflow by its ID:
 
 ```typescript title="src/mastra/workflows/test-workflow.ts"
 export const testWorkflow = createWorkflow({
@@ -26,12 +26,12 @@ export const testWorkflow = createWorkflow({
 ```
 
 ```typescript
-const workflow = mastraClient.getWorkflow("testWorkflow");
+const workflow = mastraClient.getWorkflow("city-workflow");
 ```
 
 ## Workflow Methods
 
-### Get Workflow Details
+### details()
 
 Retrieve detailed information about a workflow:
 
@@ -39,109 +39,138 @@ Retrieve detailed information about a workflow:
 const details = await workflow.details();
 ```
 
-### Start workflow run asynchronously
+### createRun()
 
-Start a workflow run with inputData and await full run results:
+Create a new workflow run instance:
 
 ```typescript
 const run = await workflow.createRun();
 
+// Or with an existing runId
+const run = await workflow.createRun({ runId: "existing-run-id" });
+```
+
+### startAsync()
+
+Start a workflow run and await the full result:
+
+```typescript
+const run = await workflow.createRun();
+
+const result = await run.startAsync({
+  inputData: {
+    city: "New York",
+  },
+});
+```
+
+You can also pass `initialState` to set the starting values for the workflow's state:
+
+```typescript
 const result = await run.startAsync({
   inputData: {
     city: "New York",
   },
+  initialState: {
+    count: 0,
+    items: [],
+  },
 });
 ```
 
-### Resume Workflow run asynchronously
+The `initialState` object should match the structure defined in the workflow's `stateSchema`. See [Workflow State](/docs/v1/workflows/workflow-state) for more details.
 
-Resume a suspended workflow step and await full run result:
+### start()
+
+Start a workflow run without waiting for completion:
 
 ```typescript
 const run = await workflow.createRun();
 
+await run.start({
+  inputData: {
+    city: "New York",
+  },
+});
+
+// Poll for results later
+const result = await workflow.runExecutionResult(run.runId);
+```
+
+This is useful for long-running workflows where you want to start execution and check results later.
+
+### resumeAsync()
+
+Resume a suspended workflow step and await the full result:
+
+```typescript
+const run = await workflow.createRun({ runId: prevRunId });
+
 const result = await run.resumeAsync({
   step: "step-id",
   resumeData: { key: "value" },
 });
 ```
 
-### Resume Workflow
+### resume()
 
-Resume workflow run:
+Resume a suspended workflow step without waiting for completion:
 
 ```typescript
-try {
-  const workflow = mastraClient.getWorkflow("testWorkflow");
+const run = await workflow.createRun({ runId: prevRunId });
 
-  const run = await workflow.createRun({ runId: prevRunId });
-
-  run.resume({
-    step: "step-id",
-    resumeData: { key: "value" },
-  });
-} catch (e) {
-  console.error(e);
-}
+await run.resume({
+  step: "step-id",
+  resumeData: { key: "value" },
+});
 ```
 
-### Stream Workflow
+### stream()
 
 Stream workflow execution for real-time updates:
 
 ```typescript
-try {
-  const workflow = mastraClient.getWorkflow("testWorkflow");
-
-  const run = await workflow.createRun();
+const run = await workflow.createRun();
 
-  const stream = await run.stream({
-    inputData: {
-      city: "New York",
-    },
-  });
+const stream = await run.stream({
+  inputData: {
+    city: "New York",
+  },
+});
 
-  for await (const chunk of stream) {
-    console.log(JSON.stringify(chunk, null, 2));
-  }
-} catch (e) {
-  console.error("Workflow error:", e);
+for await (const chunk of stream) {
+  console.log(JSON.stringify(chunk, null, 2));
 }
 ```
 
-### Get Workflow Run result
+### runExecutionResult()
 
-Get the result of a workflow run:
+Get the execution result for a workflow run:
 
 ```typescript
-try {
-  const workflow = mastraClient.getWorkflow("testWorkflow");
-
-  const run = await workflow.createRun();
-
-  // start the workflow run
-  const startResult = await run.start({
-    inputData: {
-      city: "New York",
-    },
-  });
-
-  const result = await workflow.runExecutionResult(run.runId);
-
-  console.log(result);
-} catch (e) {
-  console.error(e);
-}
+const result = await workflow.runExecutionResult(runId);
 ```
 
-This is useful when dealing with long running workflows. You can use this to poll the result of the workflow run.
-
-### Workflow run result
+<h3>Run result format</h3>
 
 A workflow run result yields the following:
 
-| Field            | Type                                                                                                                                                                                                                                               | Description                                      |
-| ---------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------ |
-| `payload`        | `{currentStep?: {id: string, status: string, output?: Record<string, any>, payload?: Record<string, any>}, workflowState: {status: string, steps: Record<string, {status: string, output?: Record<string, any>, payload?: Record<string, any>}>}}` | The current step and workflow state of the run   |
-| `eventTimestamp` | `Date`                                                                                                                                                                                                                                             | The timestamp of the event                       |
-| `runId`          | `string`                                                                                                                                                                                                                                           | Unique identifier for this workflow run instance |
+<PropertiesTable
+  content={[
+    {
+      name: "runId",
+      type: "string",
+      description: "Unique identifier for this workflow run instance",
+    },
+    {
+      name: "eventTimestamp",
+      type: "Date",
+      description: "The timestamp of the event",
+    },
+    {
+      name: "payload",
+      type: "object",
+      description: "Contains currentStep (id, status, output, payload) and workflowState (status, steps record)",
+    },
+  ]}
+/>

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

@@ -0,0 +1,59 @@
+---
+title: "Reference: Mastra.addGateway() | Core"
+description: "Add a gateway to the Mastra instance"
+---
+
+# Mastra.addGateway()
+
+Dynamically adds a gateway to the Mastra instance. Can be used during or after initialization.
+
+## Usage example
+
+```typescript
+import { Mastra } from '@mastra/core';
+
+const mastra = new Mastra();
+
+// Add with explicit key
+mastra.addGateway(new MyCustomGateway(), 'myGateway');
+
+// Add using gateway's ID as the key
+mastra.addGateway(new MyCustomGateway());
+// Stored with key 'my-custom-gateway' (the gateway's id)
+```
+
+## Parameters
+
+<PropertiesTable
+  content={[
+    {
+      name: 'gateway',
+      type: 'MastraModelGateway',
+      description: 'The gateway instance to add',
+    },
+    {
+      name: 'key',
+      type: 'string',
+      isOptional: true,
+      description: 'Optional registration key. If not provided, uses gateway.getId()',
+    },
+  ]}
+/>
+
+## Returns
+
+Void. The gateway is added to the internal registry.
+
+## Behavior
+
+- If a gateway with the same key already exists, the addition is skipped
+- In development mode (`MASTRA_DEV=true`), automatically triggers type generation for custom gateways
+- The gateway becomes available immediately for model resolution
+
+## Related
+
+- [Mastra.getGateway()](/reference/v1/core/getGateway) - Get gateway by registration key
+- [Mastra.getGatewayById()](/reference/v1/core/getGatewayById) - Get gateway by ID
+- [Mastra.listGateways()](/reference/v1/core/listGateways) - List all gateways
+- [MastraModelGateway](/reference/v1/core/mastra-model-gateway) - Gateway base class
+- [Custom Gateways Guide](/models/v1/gateways/custom-gateways) - Creating custom gateways

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

@@ -1,5 +1,5 @@
 ---
-title: "Reference: Mastra.getAgent() | Core | Mastra Docs"
+title: "Reference: Mastra.getAgent() | Core"
 description: "Documentation for the `Agent.getAgent()` method in Mastra, which retrieves an agent by name."
 ---
 

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

@@ -1,5 +1,5 @@
 ---
-title: "Reference: Mastra.getAgentById() | Core | Mastra Docs"
+title: "Reference: Mastra.getAgentById() | Core"
 description: "Documentation for the `Mastra.getAgentById()` method in Mastra, which retrieves an agent by its ID."
 ---
 

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

@@ -1,5 +1,5 @@
 ---
-title: "Reference: Mastra.getDeployer() | Core | Mastra Docs"
+title: "Reference: Mastra.getDeployer() | Core"
 description: "Documentation for the `Mastra.getDeployer()` method in Mastra, which retrieves the configured deployer instance."
 ---
 

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

@@ -0,0 +1,59 @@
+---
+title: "Reference: Mastra.getGateway() | Core"
+description: "Retrieve a registered gateway by its registration key"
+---
+
+# Mastra.getGateway()
+
+Retrieves a gateway by its registration key (the key used when adding the gateway to Mastra).
+
+## Usage example
+
+```typescript
+import { Mastra } from '@mastra/core';
+
+const mastra = new Mastra({
+  gateways: {
+    myGateway: new MyCustomGateway(),
+  },
+});
+
+const gateway = mastra.getGateway('myGateway');
+console.log(gateway.name); // 'My Custom Gateway'
+```
+
+## Parameters
+
+<PropertiesTable
+  content={[
+    {
+      name: 'key',
+      type: 'string',
+      description: 'The registration key of the gateway',
+    },
+  ]}
+/>
+
+## Returns
+
+<PropertiesTable
+  content={[
+    {
+      name: 'gateway',
+      type: 'MastraModelGateway',
+      description: 'The gateway instance',
+    },
+  ]}
+/>
+
+## Throws
+
+Throws an error if no gateway is found with the specified key.
+
+## Related
+
+- [Mastra.getGatewayById()](/reference/v1/core/getGatewayById) - Get gateway by ID
+- [Mastra.listGateways()](/reference/v1/core/listGateways) - List all gateways
+- [Mastra.addGateway()](/reference/v1/core/addGateway) - Add a gateway
+- [MastraModelGateway](/reference/v1/core/mastra-model-gateway) - Gateway base class
+- [Custom Gateways Guide](/models/v1/gateways/custom-gateways) - Creating custom gateways

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

@@ -0,0 +1,62 @@
+---
+title: "Reference: Mastra.getGatewayById() | Core"
+description: "Retrieve a registered gateway by its unique ID"
+---
+
+# Mastra.getGatewayById()
+
+Retrieves a gateway by its unique ID (the `id` property of the gateway instance). This is useful when you need to find a gateway by its intrinsic identifier rather than its registration key.
+
+## Usage example
+
+```typescript
+import { Mastra } from '@mastra/core';
+
+const mastra = new Mastra({
+  gateways: {
+    customKey: new MyCustomGateway(), // id = 'my-custom-gateway'
+  },
+});
+
+// Retrieve by ID (not registration key)
+const gateway = mastra.getGatewayById('my-custom-gateway');
+console.log(gateway.name); // 'My Custom Gateway'
+```
+
+## Use Cases
+
+- Gateway versioning: Different versions with unique IDs (`'gateway-v1'`, `'gateway-v2'`)
+- Finding gateways when registration keys are unknown
+- Identifying gateways across different Mastra instances
+
+## Parameters
+
+<PropertiesTable
+  content={[
+    {
+      name: 'id',
+      type: 'string',
+      description: 'The unique ID of the gateway (gateway.id property)',
+    },
+  ]}
+/>
+
+## Returns
+
+<PropertiesTable
+  content={[
+    {
+      name: 'gateway',
+      type: 'MastraModelGateway | undefined',
+      description: 'The gateway instance, or undefined if not found',
+    },
+  ]}
+/>
+
+## Related
+
+- [Mastra.getGateway()](/reference/v1/core/getGateway) - Get gateway by registration key
+- [Mastra.listGateways()](/reference/v1/core/listGateways) - List all gateways
+- [Mastra.addGateway()](/reference/v1/core/addGateway) - Add a gateway
+- [MastraModelGateway](/reference/v1/core/mastra-model-gateway) - Gateway base class
+- [Custom Gateways Guide](/models/v1/gateways/custom-gateways) - Creating custom gateways

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

@@ -1,5 +1,5 @@
 ---
-title: "Reference: Mastra.getLogger() | Core | Mastra Docs"
+title: "Reference: Mastra.getLogger() | Core"
 description: "Documentation for the `Mastra.getLogger()` method in Mastra, which retrieves the configured logger instance."
 ---
 
@@ -32,5 +32,5 @@ This method does not accept any parameters.
 
 ## Related
 
-- [Logging overview](/docs/v1/logging)
+- [Logging overview](/docs/v1/observability/logging)
 - [Logger reference](/reference/v1/logging/pino-logger)

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

@@ -1,5 +1,5 @@
 ---
-title: "Reference: Mastra.getMCPServer() | Core | Mastra Docs"
+title: "Reference: Mastra.getMCPServer() | Core"
 description: "Documentation for the `Mastra.getMCPServer()` method in Mastra, which retrieves a specific MCP server instance by ID and optional version."
 ---
 
@@ -64,5 +64,5 @@ const serverById = mastra.getMCPServerById('my-mcp-server');
 
 ## See Also
 
-- [MCP overview](/docs/v1/tools-mcp/mcp-overview)
+- [MCP overview](/docs/v1/mcp/overview)
 - [MCP server reference](/reference/v1/tools/mcp-server)

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

@@ -1,5 +1,5 @@
 ---
-title: "Reference: Mastra.getMCPServerById() | Core | Mastra Docs"
+title: "Reference: Mastra.getMCPServerById() | Core"
 description: "Documentation for the `Mastra.getMCPServerById()` method in Mastra, which retrieves a specific MCP server instance by its intrinsic id property."
 ---
 
@@ -77,5 +77,5 @@ const serverByKey = mastra.getMCPServer('customKey');
 
 ## See Also
 
-- [MCP overview](/docs/v1/tools-mcp/mcp-overview)
+- [MCP overview](/docs/v1/mcp/overview)
 - [MCP server reference](/reference/v1/tools/mcp-server)

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

@@ -0,0 +1,73 @@
+---
+title: "Reference: Mastra.getMemory() | Core"
+description: "Documentation for the `Mastra.getMemory()` method in Mastra, which retrieves a registered memory instance by its registry key."
+---
+
+# Mastra.getMemory()
+
+The `.getMemory()` method retrieves a memory instance from the Mastra registry by its key. Memory instances are registered in the Mastra constructor and can be referenced by stored agents.
+
+## Usage example
+
+```typescript copy
+const memory = mastra.getMemory("conversationMemory");
+
+// Use the memory instance
+const thread = await memory.createThread({
+  resourceId: "user-123",
+  title: "New Conversation",
+});
+```
+
+## Parameters
+
+<PropertiesTable
+  content={[
+    {
+      name: "key",
+      type: "TMemoryKey extends keyof TMemory",
+      description:
+        "The registry key of the memory instance to retrieve. Must match a key used when registering memory in the Mastra constructor.",
+    },
+  ]}
+/>
+
+## Returns
+
+<PropertiesTable
+  content={[
+    {
+      name: "memory",
+      type: "TMemory[TMemoryKey]",
+      description:
+        "The memory instance with the specified key. Throws an error if the memory is not found.",
+    },
+  ]}
+/>
+
+## Example: Registering and Retrieving Memory
+
+```typescript copy
+import { Mastra } from "@mastra/core";
+import { Memory } from "@mastra/memory";
+import { LibSQLStore } from "@mastra/libsql";
+
+const conversationMemory = new Memory({
+  storage: new LibSQLStore({ url: ":memory:" }),
+});
+
+const mastra = new Mastra({
+  memory: {
+    conversationMemory,
+  },
+});
+
+// Later, retrieve the memory instance
+const memory = mastra.getMemory("conversationMemory");
+```
+
+## Related
+
+- [Mastra.listMemory()](/reference/v1/core/listMemory)
+- [Memory overview](/docs/v1/memory/overview)
+- [Agent Memory](/docs/v1/agents/agent-memory)

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

@@ -1,5 +1,5 @@
 ---
-title: "Reference: getScorer() | Core | Mastra Docs"
+title: "Reference: getScorer() | Core"
 description: "Documentation for the `getScorer()` method in Mastra, which retrieves a specific scorer by its registration key."
 ---
 

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

@@ -1,5 +1,5 @@
 ---
-title: "Reference: getScorerById() | Core | Mastra Docs"
+title: "Reference: getScorerById() | Core"
 description: "Documentation for the `getScorerById()` method in Mastra, which retrieves a scorer by its id property rather than registration key."
 ---
 

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

@@ -1,5 +1,5 @@
 ---
-title: "Reference: Mastra.getServer() | Core | Mastra Docs"
+title: "Reference: Mastra.getServer() | Core"
 description: "Documentation for the `Mastra.getServer()` method in Mastra, which retrieves the configured server configuration."
 ---
 
@@ -25,12 +25,12 @@ This method does not accept any parameters.
       name: "server",
       type: "ServerConfig | undefined",
       description:
-        "The configured server configuration including port, timeout, API routes, middleware, CORS settings, and build options, or undefined if no server has been configured.",
+        "The configured server configuration including port, host, studioBase, timeout, API routes, middleware, CORS settings, and build options, or undefined if no server has been configured.",
     },
   ]}
 />
 
 ## Related
 
-- [Server deployment](/docs/v1/deployment/server-deployment)
+- [Server deployment](/docs/v1/deployment/building-mastra)
 - [Server configuration](/docs/v1/server-db/custom-api-routes)

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

@@ -1,5 +1,5 @@
 ---
-title: "Reference: Mastra.getStorage() | Core | Mastra Docs"
+title: "Reference: Mastra.getStorage() | Core"
 description: "Documentation for the `Mastra.getStorage()` method in Mastra, which retrieves the configured storage instance."
 ---