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

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

@@ -1,6 +1,8 @@
 ---
 title: "Reference: Mastra.addGateway() | Core"
 description: "Add a gateway to the Mastra instance"
+packages:
+  - "@mastra/core"
 ---
 
 # Mastra.addGateway()

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

@@ -1,6 +1,8 @@
 ---
 title: "Reference: Mastra.getAgent() | Core"
 description: "Documentation for the `Agent.getAgent()` method in Mastra, which retrieves an agent by name."
+packages:
+  - "@mastra/core"
 ---
 
 # Mastra.getAgent()
@@ -9,7 +11,7 @@ The `.getAgent()` method is used to retrieve an agent. The method accepts a sing
 
 ## Usage example
 
-```typescript copy
+```typescript
 mastra.getAgent("testAgent");
 ```
 

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

@@ -1,6 +1,8 @@
 ---
 title: "Reference: Mastra.getAgentById() | Core"
 description: "Documentation for the `Mastra.getAgentById()` method in Mastra, which retrieves an agent by its ID."
+packages:
+  - "@mastra/core"
 ---
 
 # Mastra.getAgentById()
@@ -9,7 +11,7 @@ The `.getAgentById()` method is used to retrieve an agent by its ID. The method
 
 ## Usage example
 
-```typescript copy
+```typescript
 mastra.getAgentById("test-agent-123");
 ```
 

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

@@ -1,6 +1,8 @@
 ---
 title: "Reference: Mastra.getDeployer() | Core"
 description: "Documentation for the `Mastra.getDeployer()` method in Mastra, which retrieves the configured deployer instance."
+packages:
+  - "@mastra/core"
 ---
 
 # Mastra.getDeployer()
@@ -9,7 +11,7 @@ The `.getDeployer()` method is used to retrieve the deployer instance that has b
 
 ## Usage example
 
-```typescript copy
+```typescript
 mastra.getDeployer();
 ```
 

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

@@ -1,6 +1,8 @@
 ---
 title: "Reference: Mastra.getGateway() | Core"
 description: "Retrieve a registered gateway by its registration key"
+packages:
+  - "@mastra/core"
 ---
 
 # Mastra.getGateway()

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

@@ -1,6 +1,8 @@
 ---
 title: "Reference: Mastra.getGatewayById() | Core"
 description: "Retrieve a registered gateway by its unique ID"
+packages:
+  - "@mastra/core"
 ---
 
 # Mastra.getGatewayById()

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

@@ -1,6 +1,8 @@
 ---
 title: "Reference: Mastra.getLogger() | Core"
 description: "Documentation for the `Mastra.getLogger()` method in Mastra, which retrieves the configured logger instance."
+packages:
+  - "@mastra/core"
 ---
 
 # Mastra.getLogger()
@@ -9,7 +11,7 @@ The `.getLogger()` method is used to retrieve the logger instance that has been
 
 ## Usage example
 
-```typescript copy
+```typescript
 mastra.getLogger();
 ```
 

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

@@ -1,6 +1,8 @@
 ---
 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."
+packages:
+  - "@mastra/core"
 ---
 
 # Mastra.getMCPServer()
@@ -9,7 +11,7 @@ The `.getMCPServer()` method retrieves an MCP server instance by its registry ke
 
 ## Usage example
 
-```typescript copy
+```typescript
 // Register an MCP server with a registry key
 const myServer = new MCPServer({
   id: 'my-mcp-server',

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

@@ -1,6 +1,8 @@
 ---
 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."
+packages:
+  - "@mastra/core"
 ---
 
 # Mastra.getMCPServerById()
@@ -9,7 +11,7 @@ The `.getMCPServerById()` method retrieves an MCP server instance by its intrins
 
 ## Usage example
 
-```typescript copy
+```typescript
 // Register an MCP server with a registry key
 const myServer = new MCPServer({
   id: 'my-mcp-server',

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

@@ -0,0 +1,77 @@
+---
+title: "Reference: Mastra.getMemory() | Core"
+description: "Documentation for the `Mastra.getMemory()` method in Mastra, which retrieves a registered memory instance by its registry key."
+packages:
+  - "@mastra/core"
+  - "@mastra/libsql"
+  - "@mastra/memory"
+---
+
+# 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
+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
+import { Mastra } from "@mastra/core";
+import { Memory } from "@mastra/memory";
+import { LibSQLStore } from "@mastra/libsql";
+
+const conversationMemory = new Memory({
+  storage: new LibSQLStore({ id: 'conversation-store', 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,6 +1,8 @@
 ---
 title: "Reference: getScorer() | Core"
 description: "Documentation for the `getScorer()` method in Mastra, which retrieves a specific scorer by its registration key."
+packages:
+  - "@mastra/core"
 ---
 
 # getScorer()

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

@@ -1,6 +1,8 @@
 ---
 title: "Reference: getScorerById() | Core"
 description: "Documentation for the `getScorerById()` method in Mastra, which retrieves a scorer by its id property rather than registration key."
+packages:
+  - "@mastra/core"
 ---
 
 # getScorerById()

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

@@ -1,6 +1,8 @@
 ---
 title: "Reference: Mastra.getServer() | Core"
 description: "Documentation for the `Mastra.getServer()` method in Mastra, which retrieves the configured server configuration."
+packages:
+  - "@mastra/core"
 ---
 
 # Mastra.getServer()
@@ -9,7 +11,7 @@ The `.getServer()` method is used to retrieve the server configuration that has
 
 ## Usage example
 
-```typescript copy
+```typescript
 mastra.getServer();
 ```
 
@@ -25,12 +27,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/building-mastra)
-- [Server configuration](/docs/v1/server-db/custom-api-routes)
+- [Server deployment](/docs/v1/deployment/mastra-server)
+- [Server configuration](/docs/v1/server/custom-api-routes)

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

@@ -1,6 +1,8 @@
 ---
 title: "Reference: Mastra.getStorage() | Core"
 description: "Documentation for the `Mastra.getStorage()` method in Mastra, which retrieves the configured storage instance."
+packages:
+  - "@mastra/core"
 ---
 
 # Mastra.getStorage()
@@ -9,7 +11,7 @@ The `.getStorage()` method is used to retrieve the storage instance that has bee
 
 ## Usage example
 
-```typescript copy
+```typescript
 mastra.getStorage();
 ```
 
@@ -23,7 +25,7 @@ This method does not accept any parameters.
   content={[
     {
       name: "storage",
-      type: "MastraStorage | undefined",
+      type: "MastraCompositeStore | undefined",
       description:
         "The configured storage instance, or undefined if no storage has been configured.",
     },
@@ -32,5 +34,5 @@ This method does not accept any parameters.
 
 ## Related
 
-- [Storage overview](/docs/v1/server-db/storage)
+- [Storage overview](/reference/v1/storage/overview)
 - [Storage reference](/reference/v1/storage/libsql)

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

@@ -0,0 +1,185 @@
+---
+title: "Reference: Mastra.getStoredAgentById() | Core"
+description: "Documentation for the `Mastra.getStoredAgentById()` method in Mastra, which retrieves an agent from storage and creates an executable Agent instance."
+packages:
+  - "@mastra/core"
+---
+
+# Mastra.getStoredAgentById()
+
+The `.getStoredAgentById()` method retrieves an agent configuration from storage by its ID and creates an executable `Agent` instance. Stored agents allow you to persist agent configurations in a database and dynamically load them at runtime.
+
+## Usage example
+
+```typescript
+// Get an Agent instance from storage
+const agent = await mastra.getStoredAgentById("my-stored-agent");
+
+if (agent) {
+  const response = await agent.generate("Hello");
+  console.log(response.text);
+}
+```
+
+```typescript
+// Get the raw storage data instead of an Agent instance
+const storedConfig = await mastra.getStoredAgentById("my-stored-agent", { raw: true });
+
+if (storedConfig) {
+  console.log(storedConfig.instructions);
+  console.log(storedConfig.createdAt);
+}
+```
+
+## Parameters
+
+<PropertiesTable
+  content={[
+    {
+      name: "id",
+      type: "string",
+      description:
+        "The unique identifier of the stored agent to retrieve.",
+    },
+    {
+      name: "options",
+      type: "{ raw?: boolean }",
+      description:
+        "Optional configuration object.",
+      isOptional: true,
+    },
+  ]}
+/>
+
+### Options
+
+<PropertiesTable
+  content={[
+    {
+      name: "raw",
+      type: "boolean",
+      description:
+        "When `true`, returns the raw `StorageAgentType` object from storage instead of creating an `Agent` instance. Useful for inspecting stored configuration or metadata.",
+      isOptional: true,
+      defaultValue: "false",
+    },
+  ]}
+/>
+
+## Returns
+
+<PropertiesTable
+  content={[
+    {
+      name: "result",
+      type: "Agent | StorageAgentType | null",
+      description:
+        "Returns an `Agent` instance by default, or `StorageAgentType` when `raw: true`. Returns `null` if no agent with the given ID exists.",
+    },
+  ]}
+/>
+
+## Primitive Resolution
+
+When creating an `Agent` instance from stored configuration, the method resolves references to registered primitives:
+
+- **Tools**: Resolved from `tools` registered in Mastra config
+- **Workflows**: Resolved from `workflows` registered in Mastra config
+- **Sub-agents**: Resolved from `agents` registered in Mastra config
+- **Memory**: Resolved from `memory` registered in Mastra config
+- **Scorers**: Resolved from `scorers` registered in Mastra config, including sampling configuration
+
+If a referenced primitive is not found in the registry, a warning is logged but the agent is still created.
+
+## StorageAgentType
+
+When using `raw: true`, the returned object has the following structure:
+
+<PropertiesTable
+  content={[
+    {
+      name: "id",
+      type: "string",
+      description: "Unique identifier for the agent.",
+    },
+    {
+      name: "name",
+      type: "string",
+      description: "Display name of the agent.",
+    },
+    {
+      name: "description",
+      type: "string",
+      description: "Optional description of the agent.",
+      isOptional: true,
+    },
+    {
+      name: "instructions",
+      type: "string",
+      description: "System instructions for the agent.",
+    },
+    {
+      name: "model",
+      type: "Record<string, unknown>",
+      description: "Model configuration with provider and name.",
+    },
+    {
+      name: "tools",
+      type: "Record<string, unknown>",
+      description: "Tool references to resolve from registry.",
+      isOptional: true,
+    },
+    {
+      name: "workflows",
+      type: "Record<string, unknown>",
+      description: "Workflow references to resolve from registry.",
+      isOptional: true,
+    },
+    {
+      name: "agents",
+      type: "Record<string, unknown>",
+      description: "Sub-agent references to resolve from registry.",
+      isOptional: true,
+    },
+    {
+      name: "memory",
+      type: "Record<string, unknown>",
+      description: "Memory reference to resolve from registry.",
+      isOptional: true,
+    },
+    {
+      name: "scorers",
+      type: "Record<string, unknown>",
+      description: "Scorer references with optional sampling config.",
+      isOptional: true,
+    },
+    {
+      name: "defaultOptions",
+      type: "Record<string, unknown>",
+      description: "Default options passed to agent execution.",
+      isOptional: true,
+    },
+    {
+      name: "metadata",
+      type: "Record<string, unknown>",
+      description: "Custom metadata stored with the agent.",
+      isOptional: true,
+    },
+    {
+      name: "createdAt",
+      type: "Date",
+      description: "Timestamp when the agent was created.",
+    },
+    {
+      name: "updatedAt",
+      type: "Date",
+      description: "Timestamp when the agent was last updated.",
+    },
+  ]}
+/>
+
+## Related
+
+- [Mastra.listStoredAgents()](/reference/v1/core/listStoredAgents)
+- [Storage overview](/reference/v1/storage/overview)
+- [Agents overview](/docs/v1/agents/overview)

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

@@ -1,6 +1,8 @@
 ---
 title: "Reference: Mastra.getTelemetry() | Core"
 description: "Documentation for the `Mastra.getTelemetry()` method in Mastra, which retrieves the configured telemetry instance."
+packages:
+  - "@mastra/core"
 ---
 
 # Mastra.getTelemetry()
@@ -9,7 +11,7 @@ The `.getTelemetry()` method is used to retrieve the telemetry instance that has
 
 ## Usage example
 
-```typescript copy
+```typescript
 mastra.getTelemetry();
 ```
 

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

@@ -1,6 +1,8 @@
 ---
 title: "Reference: Mastra.getVector() | Core"
 description: "Documentation for the `Mastra.getVector()` method in Mastra, which retrieves a vector store by name."
+packages:
+  - "@mastra/core"
 ---
 
 # Mastra.getVector()
@@ -9,7 +11,7 @@ The `.getVector()` method is used to retrieve a vector store by its name. The me
 
 ## Usage example
 
-```typescript copy
+```typescript
 mastra.getVector("testVectorStore");
 ```
 

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

@@ -1,6 +1,8 @@
 ---
 title: "Reference: Mastra.getWorkflow() | Core"
 description: "Documentation for the `Mastra.getWorkflow()` method in Mastra, which retrieves a workflow by ID."
+packages:
+  - "@mastra/core"
 ---
 
 # Mastra.getWorkflow()
@@ -9,7 +11,7 @@ The `.getWorkflow()` method is used to retrieve a workflow by its ID. The method
 
 ## Usage example
 
-```typescript copy
+```typescript
 mastra.getWorkflow("testWorkflow");
 ```
 

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

@@ -1,6 +1,8 @@
 ---
 title: "Reference: Mastra.listAgents() | Core"
 description: "Documentation for the `Mastra.listAgents()` method in Mastra, which retrieves all configured agents."
+packages:
+  - "@mastra/core"
 ---
 
 # Mastra.listAgents()
@@ -9,7 +11,7 @@ The `.listAgents()` method is used to retrieve all agents that have been configu
 
 ## Usage example
 
-```typescript copy
+```typescript
 mastra.listAgents();
 ```
 

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

@@ -1,6 +1,8 @@
 ---
 title: "Reference: Mastra.listGateways() | Core"
 description: "List all registered gateways"
+packages:
+  - "@mastra/core"
 ---
 
 # Mastra.listGateways()

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

@@ -1,6 +1,8 @@
 ---
 title: "Reference: Mastra.listLogs() | Core"
 description: "Documentation for the `Mastra.listLogs()` method in Mastra, which retrieves all logs for a specific transport ID."
+packages:
+  - "@mastra/core"
 ---
 
 # Mastra.listLogs()
@@ -9,7 +11,7 @@ The `.listLogs()` method is used to retrieve all logs for a specific transport I
 
 ## Usage example
 
-```typescript copy
+```typescript
 mastra.listLogs("456");
 ```
 

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

@@ -1,6 +1,8 @@
 ---
 title: "Reference: Mastra.listLogsByRunId() | Core"
 description: "Documentation for the `Mastra.listLogsByRunId()` method in Mastra, which retrieves logs for a specific run ID and transport ID."
+packages:
+  - "@mastra/core"
 ---
 
 # Mastra.listLogsByRunId()
@@ -9,7 +11,7 @@ The `.listLogsByRunId()` method is used to retrieve logs for a specific run ID a
 
 ## Usage example
 
-```typescript copy
+```typescript
 mastra.listLogsByRunId({ runId: "123", transportId: "456" });
 ```
 

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

@@ -1,6 +1,8 @@
 ---
 title: "Reference: Mastra.listMCPServers() | Core"
 description: "Documentation for the `Mastra.listMCPServers()` method in Mastra, which retrieves all registered MCP server instances."
+packages:
+  - "@mastra/core"
 ---
 
 # Mastra.listMCPServers()
@@ -9,7 +11,7 @@ The `.listMCPServers()` method is used to retrieve all MCP server instances that
 
 ## Usage example
 
-```typescript copy
+```typescript
 // Register MCP servers
 const server1 = new MCPServer({
   id: 'server-one',