@mastra/mcp-docs-server 0.0.0-error-handler-fix-20251020202607 → 0.0.0-execa-dynamic-import-20260304221256

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

@@ -1,84 +0,0 @@
----
-title: Mastra Client Vectors API
-description: Learn how to work with vector embeddings for semantic search and similarity matching in Mastra using the client-js SDK.
----
-
-# Vectors API
-
-The Vectors API provides methods to work with vector embeddings for semantic search and similarity matching in Mastra.
-
-## Working with Vectors
-
-Get an instance of a vector store:
-
-```typescript
-const vector = mastraClient.getVector("vector-name");
-```
-
-## Vector Methods
-
-### Get Vector Index Details
-
-Retrieve information about a specific vector index:
-
-```typescript
-const details = await vector.details("index-name");
-```
-
-### Create Vector Index
-
-Create a new vector index:
-
-```typescript
-const result = await vector.createIndex({
-  indexName: "new-index",
-  dimension: 128,
-  metric: "cosine", // 'cosine', 'euclidean', or 'dotproduct'
-});
-```
-
-### Upsert Vectors
-
-Add or update vectors in an index:
-
-```typescript
-const ids = await vector.upsert({
-  indexName: "my-index",
-  vectors: [
-    [0.1, 0.2, 0.3], // First vector
-    [0.4, 0.5, 0.6], // Second vector
-  ],
-  metadata: [{ label: "first" }, { label: "second" }],
-  ids: ["id1", "id2"], // Optional: Custom IDs
-});
-```
-
-### Query Vectors
-
-Search for similar vectors:
-
-```typescript
-const results = await vector.query({
-  indexName: "my-index",
-  queryVector: [0.1, 0.2, 0.3],
-  topK: 10,
-  filter: { label: "first" }, // Optional: Metadata filter
-  includeVector: true, // Optional: Include vectors in results
-});
-```
-
-### Get All Indexes
-
-List all available indexes:
-
-```typescript
-const indexes = await vector.getIndexes();
-```
-
-### Delete Index
-
-Delete a vector index:
-
-```typescript
-const result = await vector.delete("index-name");
-```

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

@@ -1,143 +0,0 @@
----
-title: Mastra Client Workflows (Legacy) API
-description: Learn how to interact with and execute automated legacy workflows in Mastra using the client-js SDK.
----
-
-# Workflows (Legacy) API
-
-The Workflows (Legacy) API provides methods to interact with and execute automated legacy workflows in Mastra.
-
-## Getting All Legacy Workflows
-
-Retrieve a list of all available legacy workflows:
-
-```typescript
-const workflows = await mastraClient.getLegacyWorkflows();
-```
-
-## Working with a Specific Legacy Workflow
-
-Get an instance of a specific legacy workflow:
-
-```typescript
-const workflow = mastraClient.getLegacyWorkflow("workflow-id");
-```
-
-## Legacy Workflow Methods
-
-### Get Legacy Workflow Details
-
-Retrieve detailed information about a legacy workflow:
-
-```typescript
-const details = await workflow.details();
-```
-
-### Start Legacy Workflow run asynchronously
-
-Start a legacy workflow run with triggerData and await full run results:
-
-```typescript
-const { runId } = workflow.createRun();
-
-const result = await workflow.startAsync({
-  runId,
-  triggerData: {
-    param1: "value1",
-    param2: "value2",
-  },
-});
-```
-
-### Resume Legacy Workflow run asynchronously
-
-Resume a suspended legacy workflow step and await full run result:
-
-```typescript
-const { runId } = createRun({ runId: prevRunId });
-
-const result = await workflow.resumeAsync({
-  runId,
-  stepId: "step-id",
-  contextData: { key: "value" },
-});
-```
-
-### Watch Legacy Workflow
-
-Watch legacy workflow transitions
-
-```typescript
-try {
-  // Get workflow instance
-  const workflow = mastraClient.getLegacyWorkflow("workflow-id");
-
-  // Create a workflow run
-  const { runId } = workflow.createRun();
-
-  // Watch workflow run
-  workflow.watch({ runId }, (record) => {
-    // Every new record is the latest transition state of the workflow run
-
-    console.log({
-      activePaths: record.activePaths,
-      results: record.results,
-      timestamp: record.timestamp,
-      runId: record.runId,
-    });
-  });
-
-  // Start workflow run
-  workflow.start({
-    runId,
-    triggerData: {
-      city: "New York",
-    },
-  });
-} catch (e) {
-  console.error(e);
-}
-```
-
-### Resume Legacy Workflow
-
-Resume legacy workflow run and watch legacy workflow step transitions
-
-```typescript
-try {
-  //To resume a workflow run, when a step is suspended
-  const { run } = createRun({ runId: prevRunId });
-
-  //Watch run
-  workflow.watch({ runId }, (record) => {
-    // Every new record is the latest transition state of the workflow run
-
-    console.log({
-      activePaths: record.activePaths,
-      results: record.results,
-      timestamp: record.timestamp,
-      runId: record.runId,
-    });
-  });
-
-  //resume run
-  workflow.resume({
-    runId,
-    stepId: "step-id",
-    contextData: { key: "value" },
-  });
-} catch (e) {
-  console.error(e);
-}
-```
-
-### Legacy Workflow run result
-
-A legacy workflow run result yields the following:
-
-| Field         | Type                                                                           | Description                                                        |
-| ------------- | ------------------------------------------------------------------------------ | ------------------------------------------------------------------ |
-| `activePaths` | `Record<string, { status: string; suspendPayload?: any; stepPath: string[] }>` | Currently active paths in the workflow with their execution status |
-| `results`     | `LegacyWorkflowRunResult<any, any, any>['results']`                            | Results from the workflow execution                                |
-| `timestamp`   | `number`                                                                       | Unix timestamp of when this transition occurred                    |
-| `runId`       | `string`                                                                       | Unique identifier for this workflow run instance                   |

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

@@ -1,175 +0,0 @@
----
-title: Mastra Client Workflows API
-description: Learn how to interact with and execute automated workflows in Mastra using the client-js SDK.
----
-
-# Workflows API
-
-The Workflows API provides methods to interact with and execute automated workflows in Mastra.
-
-## Getting All Workflows
-
-Retrieve a list of all available workflows:
-
-```typescript
-const workflows = await mastraClient.getWorkflows();
-```
-
-## Working with a Specific Workflow
-
-Get an instance of a specific workflow as defined by the const name:
-
-```typescript filename="src/mastra/workflows/test-workflow.ts"
-export const testWorkflow = createWorkflow({
-  id: 'city-workflow'
-})
-```
-
-```typescript
-const workflow = mastraClient.getWorkflow("testWorkflow");
-```
-
-## Workflow Methods
-
-### Get Workflow Details
-
-Retrieve detailed information about a workflow:
-
-```typescript
-const details = await workflow.details();
-```
-
-### Start workflow run asynchronously
-
-Start a workflow run with inputData and await full run results:
-
-```typescript
-const run = await workflow.createRunAsync();
-
-const result = await run.startAsync({
-  inputData: {
-    city: "New York",
-  },
-});
-```
-
-### Resume Workflow run asynchronously
-
-Resume a suspended workflow step and await full run result:
-
-```typescript
-const run = await workflow.createRunAsync();
-
-const result = await run.resumeAsync({
-  step: "step-id",
-  resumeData: { key: "value" },
-});
-```
-
-### Watch Workflow
-
-Watch workflow transitions:
-
-```typescript
-try {
-  const workflow = mastraClient.getWorkflow("testWorkflow");
-
-  const run = await workflow.createRunAsync();
-
-  run.watch((record) => {
-    console.log(record);
-  });
-
-  const result = await run.start({
-    inputData: {
-      city: "New York",
-    },
-  });
-} catch (e) {
-  console.error(e);
-}
-```
-
-### Resume Workflow
-
-Resume workflow run and watch workflow step transitions:
-
-```typescript
-try {
-  const workflow = mastraClient.getWorkflow("testWorkflow");
-
-  const run = await workflow.createRunAsync({ runId: prevRunId });
-
-  run.watch((record) => {
-    console.log(record);
-  });
-
-  run.resume({
-    step: "step-id",
-    resumeData: { key: "value" },
-  });
-} catch (e) {
-  console.error(e);
-}
-```
-
-### Stream Workflow
-
-Stream workflow execution for real-time updates:
-
-```typescript
-try {
-  const workflow = mastraClient.getWorkflow("testWorkflow");
-
-  const run = await workflow.createRunAsync();
-
-  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);
-}
-```
-
-### Get Workflow Run result
-
-Get the result of a workflow run:
-
-```typescript
-try  {
-  const workflow = mastraClient.getWorkflow("testWorkflow");
-
-  const run = await workflow.createRunAsync();
-
-  // 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);
-}
-```
-
-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:
-
-| 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 |

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

@@ -1,43 +0,0 @@
----
-title: "Reference: Agent.getAgent() | Agents | Mastra Docs"
-description: "Documentation for the `Agent.getAgent()` method in Mastra, which retrieves an agent by name."
----
-
-# Mastra.getAgent()
-
-The `.getAgent()` method is used to retrieve an agent. The method accepts a single `string` parameter for the agent's name.
-
-## Usage example
-
-```typescript copy
-mastra.getAgent("testAgent");
-```
-
-## Parameters
-
-<PropertiesTable
-  content={[
-    {
-      name: "name",
-      type: "TAgentName extends keyof TAgents",
-      description: "The name of the agent to retrieve. Must be a valid agent name that exists in the Mastra configuration.",
-    },
-  ]}
-/>
-
-## Returns
-
-<PropertiesTable
-  content={[
-    {
-      name: "agent",
-      type: "TAgents[TAgentName]",
-      description: "The agent instance with the specified name. Throws an error if the agent is not found.",
-    },
-  ]}
-/>
-
-## Related
-
-- [Agents overview](../../docs/agents/overview.mdx)
-- [Dynamic agents](../../docs/agents/dynamic-agents.mdx)

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

@@ -1,43 +0,0 @@
----
-title: "Reference: Mastra.getAgentById() | Core | Mastra Docs"
-description: "Documentation for the `Mastra.getAgentById()` method in Mastra, which retrieves an agent by its ID."
----
-
-# Mastra.getAgentById()
-
-The `.getAgentById()` method is used to retrieve an agent by its ID. The method accepts a single `string` parameter for the agent's ID.
-
-## Usage example
-
-```typescript copy
-mastra.getAgentById("test-agent-123");
-```
-
-## Parameters
-
-<PropertiesTable
-  content={[
-    {
-      name: "id",
-      type: "string",
-      description: "The ID of the agent to retrieve. The method will first search for an agent with this ID, and if not found, will attempt to use it as a name to call getAgent().",
-    },
-  ]}
-/>
-
-## Returns
-
-<PropertiesTable
-  content={[
-    {
-      name: "agent",
-      type: "Agent",
-      description: "The agent instance with the specified ID. Throws an error if the agent is not found.",
-    },
-  ]}
-/>
-
-## Related
-
-- [Agents overview](../../docs/agents/overview.mdx)
-- [Dynamic agents](../../docs/agents/dynamic-agents.mdx)

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

@@ -1,35 +0,0 @@
----
-title: "Reference: Mastra.getAgents() | Core | Mastra Docs"
-description: "Documentation for the `Mastra.getAgents()` method in Mastra, which retrieves all configured agents."
----
-
-# Mastra.getAgents()
-
-The `.getAgents()` method is used to retrieve all agents that have been configured in the Mastra instance.
-
-## Usage example
-
-```typescript copy
-mastra.getAgents();
-```
-
-## Parameters
-
-This method does not accept any parameters.
-
-## Returns
-
-<PropertiesTable
-  content={[
-    {
-      name: "agents",
-      type: "TAgents",
-      description: "A record of all configured agents, where keys are agent names and values are agent instances.",
-    },
-  ]}
-/>
-
-## Related
-
-- [Agents overview](../../docs/agents/overview.mdx)
-- [Dynamic agents](../../docs/agents/dynamic-agents.mdx)

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

@@ -1,35 +0,0 @@
----
-title: "Reference: Mastra.getDeployer() | Core | Mastra Docs"
-description: "Documentation for the `Mastra.getDeployer()` method in Mastra, which retrieves the configured deployer instance."
----
-
-# Mastra.getDeployer()
-
-The `.getDeployer()` method is used to retrieve the deployer instance that has been configured in the Mastra instance.
-
-## Usage example
-
-```typescript copy
-mastra.getDeployer();
-```
-
-## Parameters
-
-This method does not accept any parameters.
-
-## Returns
-
-<PropertiesTable
-  content={[
-    {
-      name: "deployer",
-      type: "MastraDeployer | undefined",
-      description: "The configured deployer instance, or undefined if no deployer has been configured.",
-    },
-  ]}
-/>
-
-## Related
-
-- [Deployment overview](../../docs/deployment/overview.mdx)
-- [Deployer reference](../../reference/deployer/deployer.mdx)

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

@@ -1,35 +0,0 @@
----
-title: "Reference: Mastra.getLogger() | Core | Mastra Docs"
-description: "Documentation for the `Mastra.getLogger()` method in Mastra, which retrieves the configured logger instance."
----
-
-# Mastra.getLogger()
-
-The `.getLogger()` method is used to retrieve the logger instance that has been configured in the Mastra instance.
-
-## Usage example
-
-```typescript copy
-mastra.getLogger();
-```
-
-## Parameters
-
-This method does not accept any parameters.
-
-## Returns
-
-<PropertiesTable
-  content={[
-    {
-      name: "logger",
-      type: "TLogger",
-      description: "The configured logger instance used for logging across all components (agents, workflows, etc.).",
-    },
-  ]}
-/>
-
-## Related
-
-- [Logging overview](../../docs/observability/logging.mdx)
-- [Logger reference](../../reference/observability/logger.mdx)

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

@@ -1,92 +0,0 @@
----
-title: "Reference: Mastra.getLogs() | Core | Mastra Docs"
-description: "Documentation for the `Mastra.getLogs()` method in Mastra, which retrieves all logs for a specific transport ID."
----
-
-# Mastra.getLogs()
-
-The `.getLogs()` method is used to retrieve all logs for a specific transport ID. This method requires a configured logger that supports the `getLogs` operation.
-
-## Usage example
-
-```typescript copy
-mastra.getLogs("456");
-```
-
-## Parameters
-
-<PropertiesTable
-  content={[
-    {
-      name: "transportId",
-      type: "string",
-      description: "The transport ID to retrieve logs from.",
-    },
-    {
-      name: "options",
-      type: "object",
-      description: "Optional parameters for filtering and pagination. See Options section below for details.",
-      optional: true,
-    },
-  ]}
-/>
-
-### Options
-
-<PropertiesTable
-  content={[
-    {
-      name: "fromDate",
-      type: "Date",
-      description: "Optional start date for filtering logs. e.g., new Date('2024-01-01').",
-      optional: true,
-    },
-    {
-      name: "toDate",
-      type: "Date",
-      description: "Optional end date for filtering logs. e.g., new Date('2024-01-31').",
-      optional: true,
-    },
-    {
-      name: "logLevel",
-      type: "LogLevel",
-      description: "Optional log level to filter by.",
-      optional: true,
-    },
-    {
-      name: "filters",
-      type: "Record<string, any>",
-      description: "Optional additional filters to apply to the log query.",
-      optional: true,
-    },
-    {
-      name: "page",
-      type: "number",
-      description: "Optional page number for pagination.",
-      optional: true,
-    },
-    {
-      name: "perPage",
-      type: "number",
-      description: "Optional number of logs per page for pagination.",
-      optional: true,
-    },
-  ]}
-/>
-
-## Returns
-
-<PropertiesTable
-  content={[
-    {
-      name: "logs",
-      type: "Promise<any>",
-      description: "A promise that resolves to the logs for the specified transport ID.",
-    },
-  ]}
-/>
-
-## Related
-
-- [Logging overview](../../docs/observability/logging.mdx)
-- [Logger reference](../../reference/observability/logger.mdx)