@mastra/mcp-docs-server 0.13.19-alpha.0 → 0.13.19-alpha.2

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

@@ -0,0 +1,35 @@
+---
+title: "Reference: Mastra.getMCPServers() | Core | Mastra Docs"
+description: "Documentation for the `Mastra.getMCPServers()` method in Mastra, which retrieves all registered MCP server instances."
+---
+
+# Mastra.getMCPServers()
+
+The `.getMCPServers()` method is used to retrieve all MCP server instances that have been registered in the Mastra instance.
+
+## Usage example
+
+```typescript copy
+mastra.getMCPServers();
+```
+
+## Parameters
+
+This method does not accept any parameters.
+
+## Returns
+
+<PropertiesTable
+  content={[
+    {
+      name: "servers",
+      type: "Record<string, MCPServerBase> | undefined",
+      description: "A record of all registered MCP server instances, where keys are server IDs and values are MCPServerBase instances, or undefined if no servers are registered.",
+    },
+  ]}
+/>
+
+## Related
+
+- [MCP overview](../../docs/tools-mcp/mcp-overview.mdx)
+- [MCP server reference](../../reference/tools/mcp-server.mdx)

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

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

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

@@ -0,0 +1,35 @@
+---
+title: "Reference: Mastra.getServer() | Core | Mastra Docs"
+description: "Documentation for the `Mastra.getServer()` method in Mastra, which retrieves the configured server configuration."
+---
+
+# Mastra.getServer()
+
+The `.getServer()` method is used to retrieve the server configuration that has been configured in the Mastra instance.
+
+## Usage example
+
+```typescript copy
+mastra.getServer();
+```
+
+## Parameters
+
+This method does not accept any parameters.
+
+## Returns
+
+<PropertiesTable
+  content={[
+    {
+      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.",
+    },
+  ]}
+/>
+
+## Related
+
+- [Server deployment](../../docs/deployment/server-deployment.mdx)
+- [Server configuration](../../docs/server-db/custom-api-routes.mdx)

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

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

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

@@ -0,0 +1,35 @@
+---
+title: "Reference: Mastra.getTelemetry() | Core | Mastra Docs"
+description: "Documentation for the `Mastra.getTelemetry()` method in Mastra, which retrieves the configured telemetry instance."
+---
+
+# Mastra.getTelemetry()
+
+The `.getTelemetry()` method is used to retrieve the telemetry instance that has been configured in the Mastra instance.
+
+## Usage example
+
+```typescript copy
+mastra.getTelemetry();
+```
+
+## Parameters
+
+This method does not accept any parameters.
+
+## Returns
+
+<PropertiesTable
+  content={[
+    {
+      name: "telemetry",
+      type: "Telemetry | undefined",
+      description: "The configured telemetry instance used for tracing and observability across all components, or undefined if no telemetry has been configured.",
+    },
+  ]}
+/>
+
+## Related
+
+- [AI tracing](../../docs/observability/ai-tracing.mdx)
+- [Telemetry reference](../../reference/observability/otel-config.mdx)

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

@@ -0,0 +1,43 @@
+---
+title: "Reference: Mastra.getVector() | Core | Mastra Docs"
+description: "Documentation for the `Mastra.getVector()` method in Mastra, which retrieves a vector store by name."
+---
+
+# Mastra.getVector()
+
+The `.getVector()` method is used to retrieve a vector store by its name. The method accepts a single `string` parameter for the vector store's name.
+
+## Usage example
+
+```typescript copy
+mastra.getVector("testVectorStore");
+```
+
+## Parameters
+
+<PropertiesTable
+  content={[
+    {
+      name: "name",
+      type: "TVectorName extends keyof TVectors",
+      description: "The name of the vector store to retrieve. Must be a valid vector store name that exists in the Mastra configuration.",
+    },
+  ]}
+/>
+
+## Returns
+
+<PropertiesTable
+  content={[
+    {
+      name: "vector",
+      type: "TVectors[TVectorName]",
+      description: "The vector store instance with the specified name. Throws an error if the vector store is not found.",
+    },
+  ]}
+/>
+
+## Related
+
+- [Vector stores overview](../../docs/rag/vector-databases.mdx)
+- [RAG overview](../../docs/rag/overview.mdx)

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

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

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

@@ -0,0 +1,49 @@
+---
+title: "Reference: Mastra.getWorkflow() | Core | Mastra Docs"
+description: "Documentation for the `Mastra.getWorkflow()` method in Mastra, which retrieves a workflow by ID."
+---
+
+# Mastra.getWorkflow()
+
+The `.getWorkflow()` method is used to retrieve a workflow by its ID. The method accepts a workflow ID and an optional options object.
+
+## Usage example
+
+```typescript copy
+mastra.getWorkflow("testWorkflow");
+```
+
+## Parameters
+
+<PropertiesTable
+  content={[
+    {
+      name: "id",
+      type: "TWorkflowId extends keyof TWorkflows",
+      description: "The ID of the workflow to retrieve. Must be a valid workflow ID that exists in the Mastra configuration.",
+    },
+    {
+      name: "options",
+      type: "{ serialized?: boolean }",
+      description: "Optional configuration object. When `serialized` is true, returns only the workflow name instead of the full workflow instance.",
+      optional: true,
+    },
+  ]}
+/>
+
+## Returns
+
+<PropertiesTable
+  content={[
+    {
+      name: "workflow",
+      type: "TWorkflows[TWorkflowId]",
+      description: "The workflow instance with the specified ID. Throws an error if the workflow is not found.",
+    },
+  ]}
+/>
+
+## Related
+
+- [Workflows overview](../../docs/workflows/overview.mdx)
+- [Dynamic workflows](../../docs/workflows/dynamic-workflows.mdx)

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

@@ -0,0 +1,44 @@
+---
+title: "Reference: Mastra.getWorkflows() | Core | Mastra Docs"
+description: "Documentation for the `Mastra.getWorkflows()` method in Mastra, which retrieves all configured workflows."
+---
+
+# Mastra.getWorkflows()
+
+The `.getWorkflows()` method is used to retrieve all workflows that have been configured in the Mastra instance. The method accepts an optional options object.
+
+## Usage example
+
+```typescript copy
+mastra.getWorkflows();
+```
+
+## Parameters
+
+<PropertiesTable
+  content={[
+    {
+      name: "options",
+      type: "{ serialized?: boolean }",
+      description: "Optional configuration object. When `serialized` is true, returns simplified workflow objects with only the name property instead of full workflow instances.",
+      optional: true,
+    },
+  ]}
+/>
+
+## Returns
+
+<PropertiesTable
+  content={[
+    {
+      name: "workflows",
+      type: "Record<string, Workflow>",
+      description: "A record of all configured workflows, where keys are workflow IDs and values are workflow instances (or simplified objects if serialized is true).",
+    },
+  ]}
+/>
+
+## Related
+
+- [Workflows overview](../../docs/workflows/overview.mdx)
+- [Dynamic workflows](../../docs/workflows/dynamic-workflows.mdx)

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

@@ -3,7 +3,7 @@ title: "Mastra Core"
 description: Documentation for the Mastra Class, the core entry point for managing agents, workflows, MCP servers, and server endpoints.
 ---
 
-# The Mastra Class
+# 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.
 
@@ -13,42 +13,29 @@ Think of `Mastra` as a top-level registry:
 - **tools** aren’t registered on `Mastra` directly but are associated with agents and discovered automatically.
 
 
-## Importing
+## Usage example
 
-```typescript
-import { Mastra } from "@mastra/core/mastra";
-```
-
-## Constructor
-
-Creates a new `Mastra` instance with the specified configuration.
-
-```typescript
-constructor(config?: Config);
-```
-
-## Initialization
-
-The Mastra class is typically initialized in your `src/mastra/index.ts` file:
-
-```typescript filename="src/mastra/index.ts" showLineNumbers copy
-import { Mastra } from "@mastra/core/mastra";
-import { LibSQLStore } from "@mastra/libsql";
-import { weatherAgent } from "./agents/weather-agent";
+```typescript filename="src/mastra/index.ts"
+import { Mastra } from '@mastra/core/mastra';
+import { PinoLogger } from '@mastra/loggers';
+import { LibSQLStore } from '@mastra/libsql';
+import { weatherWorkflow } from './workflows/weather-workflow';
+import { weatherAgent } from './agents/weather-agent';
 
 export const mastra = new Mastra({
+  workflows: { weatherWorkflow },
   agents: { weatherAgent },
   storage: new LibSQLStore({
     url: ":memory:",
   }),
+  logger: new PinoLogger({
+    name: 'Mastra',
+    level: 'info',
+  }),
 });
 ```
 
-## Configuration Object
-
-The constructor accepts an optional `Config` object to customize its behavior and integrate various Mastra components. All properties on the `Config` object are optional.
-
-### Properties
+## Constructor parameters
 
 <PropertiesTable
   content={[
@@ -145,156 +132,5 @@ The constructor accepts an optional `Config` object to customize its behavior an
   ]}
 />
 
-## Usage
-
-Any of the below methods can be used with the Mastra class, for example:
-
-```typescript {3} filename="example.ts" showLineNumbers
-import { mastra } from "./mastra";
-
-const agent = mastra.getAgent("weatherAgent");
-const result = await agent.generate("What's the weather like in London?");
-```
-
-### Methods
-
-<PropertiesTable
-  content={[
-    {
-      name: "getAgent(name)",
-      type: "Agent",
-      description:
-        "Returns an agent instance by id. Throws if agent not found.",
-      example: 'const agent = mastra.getAgent("agentOne");',
-    },
-    {
-      name: "getAgents()",
-      type: "Record<string, Agent>",
-      description: "Returns all registered agents as a key-value object.",
-      example: "const agents = mastra.getAgents();",
-    },
-    {
-      name: "getWorkflow(id, { serialized })",
-      type: "Workflow",
-      description:
-        "Returns a workflow instance by id. The serialized option (default: false) returns a simplified representation with just the name.",
-      example: 'const workflow = mastra.getWorkflow("myWorkflow");',
-    },
-    {
-      name: "getWorkflows({ serialized })",
-      type: "Record<string, Workflow>",
-      description:
-        "Returns all registered workflows. The serialized option (default: false) returns simplified representations.",
-      example: "const workflows = mastra.getWorkflows();",
-    },
-    {
-      name: "getVector(name)",
-      type: "MastraVector",
-      description:
-        "Returns a vector store instance by name. Throws if not found.",
-      example: 'const vectorStore = mastra.getVector("myVectorStore");',
-    },
-    {
-      name: "getVectors()",
-      type: "Record<string, MastraVector>",
-      description:
-        "Returns all registered vector stores as a key-value object.",
-      example: "const vectorStores = mastra.getVectors();",
-    },
-    {
-      name: "getDeployer()",
-      type: "MastraDeployer | undefined",
-      description: "Returns the configured deployer instance, if any.",
-      example: "const deployer = mastra.getDeployer();",
-    },
-    {
-      name: "getStorage()",
-      type: "MastraStorage | undefined",
-      description: "Returns the configured storage instance.",
-      example: "const storage = mastra.getStorage();",
-    },
-    {
-      name: "getMemory()",
-      type: "MastraMemory | undefined",
-      description:
-        "Returns the configured memory instance. Note: This is deprecated, memory should be added to agents directly.",
-      example: "const memory = mastra.getMemory();",
-    },
-    {
-      name: "getServer()",
-      type: "ServerConfig | undefined",
-      description:
-        "Returns the server configuration including port, timeout, API routes, middleware, CORS settings, and build options.",
-      example: "const serverConfig = mastra.getServer();",
-    },
-    {
-      name: "setStorage(storage)",
-      type: "void",
-      description: "Sets the storage instance for the Mastra instance.",
-      example: "mastra.setStorage(new DefaultStorage());",
-    },
-    {
-      name: "setLogger({ logger })",
-      type: "void",
-      description:
-        "Sets the logger for all components (agents, workflows, etc.).",
-      example:
-        'mastra.setLogger({ logger: new PinoLogger({ name: "MyLogger" }) });',
-    },
-    {
-      name: "setTelemetry(telemetry)",
-      type: "void",
-      description: "Sets the telemetry configuration for all components.",
-      example: 'mastra.setTelemetry({ export: { type: "console" } });',
-    },
-    {
-      name: "getLogger()",
-      type: "Logger",
-      description: "Gets the configured logger instance.",
-      example: "const logger = mastra.getLogger();",
-    },
-    {
-      name: "getTelemetry()",
-      type: "Telemetry | undefined",
-      description: "Gets the configured telemetry instance.",
-      example: "const telemetry = mastra.getTelemetry();",
-    },
-    {
-      name: "getLogsByRunId({ runId, transportId })",
-      type: "Promise<any>",
-      description: "Retrieves logs for a specific run ID and transport ID.",
-      example:
-        'const logs = await mastra.getLogsByRunId({ runId: "123", transportId: "456" });',
-    },
-    {
-      name: "getLogs(transportId)",
-      type: "Promise<any>",
-      description: "Retrieves all logs for a specific transport ID.",
-      example: 'const logs = await mastra.getLogs("transportId");',
-    },
-    {
-      name: "getMCPServers()",
-      type: "Record<string, MCPServerBase> | undefined",
-      description: "Retrieves all registered MCP server instances.",
-      example: "const mcpServers = mastra.getMCPServers();",
-    },
-  ]}
-/>
-
-## Error Handling
-
-The Mastra class methods throw typed errors that can be caught:
 
-```typescript {8} filename="example.ts" showLineNumbers
-import { mastra } from "./mastra";
 
-try {
-  const agent = mastra.getAgent("weatherAgent");
-  const result = await agent.generate("What's the weather like in London?");
-
-} catch (error) {
-  if (error instanceof Error) {
-    console.log(error.message);
-  }
-}
-```

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

@@ -0,0 +1,47 @@
+---
+title: "Reference: Mastra.setLogger() | Core | Mastra Docs"
+description: "Documentation for the `Mastra.setLogger()` method in Mastra, which sets the logger for all components (agents, workflows, etc.)."
+---
+
+# Mastra.setLogger()
+
+The `.setLogger()` method is used to set the logger for all components (agents, workflows, etc.) in the Mastra instance. This method accepts a single object parameter with a logger property.
+
+## Usage example
+
+```typescript copy
+mastra.setLogger({ logger: new PinoLogger({ name: "testLogger" }) });
+```
+
+## Parameters
+
+<PropertiesTable
+  content={[
+    {
+      name: "options",
+      type: "{ logger: TLogger }",
+      description: "An object containing the logger instance to set for all components.",
+    },
+  ]}
+/>
+
+### Options
+
+<PropertiesTable
+  content={[
+    {
+      name: "logger",
+      type: "TLogger",
+      description: "The logger instance to set for all components (agents, workflows, etc.).",
+    },
+  ]}
+/>
+
+## Returns
+
+This method does not return a value.
+
+## Related
+
+- [Logging overview](../../docs/observability/logging.mdx)
+- [Logger reference](../../reference/observability/logger.mdx)

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

@@ -0,0 +1,39 @@
+---
+title: "Reference: Mastra.setStorage() | Core | Mastra Docs"
+description: "Documentation for the `Mastra.setStorage()` method in Mastra, which sets the storage instance for the Mastra instance."
+---
+
+# Mastra.setStorage()
+
+The `.setStorage()` method is used to set the storage instance for the Mastra instance. This method accepts a single `MastraStorage` parameter.
+
+## Usage example
+
+```typescript copy
+mastra.setStorage(
+  new LibSQLStore({
+    url: ":memory:"
+  })
+);
+```
+
+## Parameters
+
+<PropertiesTable
+  content={[
+    {
+      name: "storage",
+      type: "MastraStorage",
+      description: "The storage instance to set for the Mastra instance.",
+    },
+  ]}
+/>
+
+## Returns
+
+This method does not return a value.
+
+## Related
+
+- [Storage overview](../../docs/server-db/storage.mdx)
+- [Storage reference](../../reference/storage/libsql.mdx)

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

@@ -0,0 +1,35 @@
+---
+title: "Reference: Mastra.setTelemetry() | Core | Mastra Docs"
+description: "Documentation for the `Mastra.setTelemetry()` method in Mastra, which sets the telemetry configuration for all components."
+---
+
+# Mastra.setTelemetry()
+
+The `.setTelemetry()` method is used to set the telemetry configuration for all components in the Mastra instance. This method accepts a single telemetry configuration object.
+
+## Usage example
+
+```typescript copy
+mastra.setTelemetry({ export: { type: "console" } });
+```
+
+## Parameters
+
+<PropertiesTable
+  content={[
+    {
+      name: "telemetry",
+      type: "OtelConfig",
+      description: "The telemetry configuration object to set for all components.",
+    },
+  ]}
+/>
+
+## Returns
+
+This method does not return a value.
+
+## Related
+
+- [Telemetry overview](../../docs/observability/telemetry.mdx)
+- [Telemetry reference](../../reference/observability/telemetry.mdx)