@mastra/mcp-docs-server 0.13.39 → 1.0.0-beta.0

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

@@ -0,0 +1,81 @@
+---
+title: "Reference: Mastra.getMCPServerById() | Core | Mastra Docs"
+description: "Documentation for the `Mastra.getMCPServerById()` method in Mastra, which retrieves a specific MCP server instance by its intrinsic id property."
+---
+
+# Mastra.getMCPServerById()
+
+The `.getMCPServerById()` method retrieves an MCP server instance by its intrinsic `id` property. For retrieving by registry key (the key used in configuration), use `.getMCPServer()` instead.
+
+## Usage example
+
+```typescript copy
+// Register an MCP server with a registry key
+const myServer = new MCPServer({
+  id: 'my-mcp-server',
+  name: 'My Server',
+  version: '1.0.0',
+  tools: { /* ... */ },
+});
+
+export const mastra = new Mastra({
+  mcpServers: {
+    customKey: myServer,  // 'customKey' is the registry key
+  },
+});
+
+// Retrieve by intrinsic ID
+const server = mastra.getMCPServerById('my-mcp-server');
+
+// Alternatively, retrieve by registry key
+const serverByKey = mastra.getMCPServer('customKey');
+```
+
+## Parameters
+
+<PropertiesTable
+  content={[
+    {
+      name: "serverId",
+      type: "string",
+      description:
+        "The intrinsic id property of the MCP server (set when the server was instantiated).",
+    },
+    {
+      name: "version",
+      type: "string",
+      description:
+        "Optional. If provided, returns the server only if its version matches.",
+      isOptional: true,
+    },
+  ]}
+/>
+
+## Returns
+
+<PropertiesTable
+  content={[
+    {
+      name: "server",
+      type: "MCPServerBase | undefined",
+      description:
+        "The MCP server instance with the specified id (and version, if provided), or undefined if not found.",
+    },
+  ]}
+/>
+
+## Notes
+
+- The server's `id` is slugified during construction, so `'myMcpServer'` becomes `'my-mcp-server'`
+- If multiple servers have the same `id` but different versions, you must provide the `version` parameter to disambiguate
+- If no `version` is provided and multiple versions exist, the method returns the first match
+
+## Related Methods
+
+- [Mastra.getMCPServer()]/reference/v1/core/getMCPServer) - Retrieve an MCP server by its registry key
+- [Mastra.listMCPServers()]/reference/v1/core/listMCPServers) - List all registered MCP servers
+
+## See Also
+
+- [MCP overview]/docs/v1/tools-mcp/mcp-overview)
+- [MCP server reference]/reference/v1/tools/mcp-server)

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

@@ -73,6 +73,6 @@ try {
 
 ## Related
 
-- [getScorers()](/reference/core/getScorers) - Get all registered scorers
-- [getScorerByName()](/reference/core/getScorerByName) - Get a scorer by its name property
-- [Custom Scorers](/docs/scorers/custom-scorers) - Learn how to create custom scorers
+- [listScorers()](/reference/v1/core/listScorers) - Get all registered scorers
+- [getScorerById()](/reference/v1/core/getScorerById) - Get a scorer by its id property
+- [Custom Scorers](/docs/v1/evals/custom-scorers) - Learn how to create custom scorers

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

@@ -0,0 +1,79 @@
+---
+title: "Reference: getScorerById() | Core | Mastra Docs"
+description: "Documentation for the `getScorerById()` method in Mastra, which retrieves a scorer by its id property rather than registration key."
+---
+
+# getScorerById()
+
+The `getScorerById()` method retrieves a scorer by searching for its `id` property (or `name` property as a fallback) rather than the registration key. This is useful when you know the scorer's id but not necessarily how it was registered in the Mastra instance.
+
+## Usage Example
+
+```typescript
+import { mastra } from "./mastra";
+
+// Get a scorer by its id property
+const relevancyScorer = mastra.getScorerById("answer-relevancy-scorer");
+
+const weatherAgent = mastra.getAgent("weatherAgent");
+
+// Use the scorer to evaluate an AI output
+await weatherAgent.generate("What is the weather in Rome", {
+  scorers: {
+    answerRelevancy: {
+      scorer: relevancyScorer,
+    },
+  },
+});
+```
+
+## Parameters
+
+<PropertiesTable
+  content={[
+    {
+      name: "id",
+      type: "string",
+      description:
+        "The id property of the scorer to retrieve. This should match the 'id' field specified when creating the scorer with createScorer(). The method will also search by 'name' property as a fallback.",
+      isOptional: false,
+    },
+  ]}
+/>
+
+## Returns
+
+<PropertiesTable
+  content={[
+    {
+      name: "scorer",
+      type: "MastraScorer",
+      description:
+        "The MastraScorer instance that has the matching id (or name) property.",
+    },
+  ]}
+/>
+
+## Error Handling
+
+This method throws a `MastraError` if:
+
+- No scorer with the specified id is found
+- No scorers are registered with the Mastra instance
+
+```typescript
+try {
+  const scorer = mastra.getScorerById("non-existent-scorer");
+} catch (error) {
+  if (error.id === "MASTRA_GET_SCORER_BY_ID_NOT_FOUND") {
+    console.log("Scorer with that id not found");
+  }
+}
+```
+
+## Related
+
+- [getScorer()](/reference/v1/core/getScorer) - Get a scorer by its registration key
+- [listScorers()](/reference/v1/core/listScorers) - Get all registered scorers
+- [createScorer()](/reference/v1/evals/create-scorer) - Learn how to create scorers with ids
+

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

@@ -32,5 +32,5 @@ This method does not accept any parameters.
 
 ## Related
 
-- [Server deployment](/docs/deployment/server-deployment)
-- [Server configuration](/docs/server-db/custom-api-routes)
+- [Server deployment](/docs/v1/deployment/server-deployment)
+- [Server configuration](/docs/v1/server-db/custom-api-routes)

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

@@ -32,5 +32,5 @@ This method does not accept any parameters.
 
 ## Related
 
-- [Storage overview](/docs/server-db/storage)
-- [Storage reference](/reference/storage/libsql)
+- [Storage overview](/docs/v1/server-db/storage)
+- [Storage reference](/reference/v1/storage/libsql)

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

@@ -32,5 +32,5 @@ This method does not accept any parameters.
 
 ## Related
 
-- [AI tracing](/docs/observability/ai-tracing/overview)
-- [Telemetry reference](/reference/observability/otel-tracing/otel-config)
+- [Tracing]/docs/v1/observability/tracing/overview)
+- [Observability Configuration]/reference/v1/observability/tracing/configuration)

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

@@ -41,5 +41,5 @@ mastra.getVector("testVectorStore");
 
 ## Related
 
-- [Vector stores overview](/docs/rag/vector-databases)
-- [RAG overview](/docs/rag/overview)
+- [Vector stores overview](/docs/v1/rag/vector-databases)
+- [RAG overview](/docs/v1/rag/overview)

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

@@ -48,4 +48,4 @@ mastra.getWorkflow("testWorkflow");
 
 ## Related
 
-- [Workflows overview](/docs/workflows/overview)
+- [Workflows overview](/docs/v1/workflows/overview)

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

@@ -32,4 +32,4 @@ This method does not accept any parameters.
 
 ## Related
 
-- [Agents overview](/docs/agents/overview)
+- [Agents overview](/docs/v1/agents/overview)

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

@@ -92,5 +92,5 @@ mastra.listLogs("456");
 
 ## Related
 
-- [Logging overview](/docs/observability/logging)
-- [Logger reference](/reference/observability/logging/pino-logger)
+- [Logging overview]/docs/v1/logging)
+- [Logger reference]/reference/v1/logging/pino-logger)

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

@@ -83,5 +83,5 @@ mastra.listLogsByRunId({ runId: "123", transportId: "456" });
 
 ## Related
 
-- [Logging overview](/docs/observability/logging)
-- [Logger reference](/reference/observability/logging/pino-logger)
+- [Logging overview]/docs/v1/logging)
+- [Logger reference]/reference/v1/logging/pino-logger)

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

@@ -0,0 +1,65 @@
+---
+title: "Reference: Mastra.listMCPServers() | Core | Mastra Docs"
+description: "Documentation for the `Mastra.listMCPServers()` method in Mastra, which retrieves all registered MCP server instances."
+---
+
+# Mastra.listMCPServers()
+
+The `.listMCPServers()` method is used to retrieve all MCP server instances that have been registered in the Mastra instance. The returned record uses registry keys (the keys from the `mcpServers` configuration) as keys.
+
+## Usage example
+
+```typescript copy
+// Register MCP servers
+const server1 = new MCPServer({
+  id: 'server-one',
+  name: 'Server One',
+  version: '1.0.0',
+  tools: { /* ... */ },
+});
+
+const server2 = new MCPServer({
+  id: 'server-two',
+  name: 'Server Two',
+  version: '1.0.0',
+  tools: { /* ... */ },
+});
+
+export const mastra = new Mastra({
+  mcpServers: {
+    firstServer: server1,   // Registry key: 'firstServer'
+    secondServer: server2,  // Registry key: 'secondServer'
+  },
+});
+
+// List all registered servers
+const servers = mastra.listMCPServers();
+// Returns: { firstServer: MCPServerBase, secondServer: MCPServerBase }
+```
+
+## 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 the registry keys (from mcpServers configuration) and values are MCPServerBase instances, or undefined if no servers are registered.",
+    },
+  ]}
+/>
+
+## Related Methods
+
+- [Mastra.getMCPServer()]/reference/v1/core/getMCPServer) - Retrieve an MCP server by its registry key
+- [Mastra.getMCPServerById()]/reference/v1/core/getMCPServerById) - Retrieve an MCP server by its intrinsic `id` property
+
+## See Also
+
+- [MCP overview]/docs/v1/tools-mcp/mcp-overview)
+- [MCP server reference]/reference/v1/tools/mcp-server)

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

@@ -38,6 +38,6 @@ This method takes no parameters.
 
 ## Related
 
-- [getScorer()](../../reference/core/getScorer) - Get a specific scorer by key
-- [getScorerByName()](../../reference/core/getScorerByName) - Get a scorer by its name property
-- [Scorers Overview](../../docs/scorers/overview) - Learn about creating and using scorers
+- [getScorer()](/reference/v1/core/getScorer) - Get a specific scorer by key
+- [getScorerById()](/reference/v1/core/getScorerById) - Get a scorer by its id property
+- [Scorers Overview](/docs/v1/evals/overview) - Learn about creating and using scorers

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

@@ -0,0 +1,36 @@
+---
+title: "Reference: Mastra.listVectors() | Core | Mastra Docs"
+description: "Documentation for the `Mastra.listVectors()` method in Mastra, which retrieves all configured vector stores."
+---
+
+# Mastra.listVectors()
+
+The `.listVectors()` method is used to retrieve all vector stores that have been configured in the Mastra instance.
+
+## Usage example
+
+```typescript copy
+mastra.listVectors();
+```
+
+## 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/v1/rag/vector-databases)
+- [RAG overview](/docs/v1/rag/overview)

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

@@ -1,16 +1,16 @@
 ---
-title: "Reference: Mastra.getWorkflows() | Core | Mastra Docs"
-description: "Documentation for the `Mastra.getWorkflows()` method in Mastra, which retrieves all configured workflows."
+title: "Reference: Mastra.listWorkflows() | Core | Mastra Docs"
+description: "Documentation for the `Mastra.listWorkflows()` method in Mastra, which retrieves all configured workflows."
 ---
 
-# Mastra.getWorkflows()
+# Mastra.listWorkflows()
 
-The `.getWorkflows()` method is used to retrieve all workflows that have been configured in the Mastra instance. The method accepts an optional options object.
+The `.listWorkflows()` 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();
+mastra.listWorkflows();
 ```
 
 ## Parameters
@@ -42,4 +42,4 @@ mastra.getWorkflows();
 
 ## Related
 
-- [Workflows overview](/docs/workflows/overview)
+- [Workflows overview](/docs/v1/workflows/overview)

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

@@ -15,7 +15,7 @@ Think of `Mastra` as a top-level registry:
 ## Usage example
 
 ```typescript title="src/mastra/index.ts"
-import { Mastra } from "@mastra/core/mastra";
+import { Mastra } from "@mastra/core";
 import { PinoLogger } from "@mastra/loggers";
 import { LibSQLStore } from "@mastra/libsql";
 import { weatherWorkflow } from "./workflows/weather-workflow";
@@ -25,6 +25,7 @@ export const mastra = new Mastra({
   workflows: { weatherWorkflow },
   agents: { weatherAgent },
   storage: new LibSQLStore({
+    id: 'mastra-storage',
     url: ":memory:",
   }),
   logger: new PinoLogger({
@@ -120,7 +121,7 @@ export const mastra = new Mastra({
       type: "Record<string, MCPServerBase>",
       isOptional: true,
       description:
-        "An object where keys are unique server identifiers and values are instances of MCPServer or classes extending MCPServerBase. This allows Mastra to be aware of and potentially manage these MCP servers.",
+        "An object where keys are registry keys (used for getMCPServer()) and values are instances of MCPServer or classes extending MCPServerBase. Each MCPServer must have an id property. Servers can be retrieved by registry key using getMCPServer() or by their intrinsic id using getMCPServerById().",
     },
     {
       name: "bundler",

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

@@ -45,5 +45,5 @@ This method does not return a value.
 
 ## Related
 
-- [Logging overview](/docs/observability/logging)
-- [Logger reference](/reference/observability/logging/pino-logger)
+- [Logging overview]/docs/v1/logging)
+- [Logger reference]/reference/v1/logging/pino-logger)

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

@@ -12,6 +12,7 @@ The `.setStorage()` method is used to set the storage instance for the Mastra in
 ```typescript copy
 mastra.setStorage(
   new LibSQLStore({
+    id: 'mastra-storage',
     url: ":memory:",
   }),
 );
@@ -35,5 +36,5 @@ This method does not return a value.
 
 ## Related
 
-- [Storage overview](/docs/server-db/storage)
-- [Storage reference](/reference/storage/libsql)
+- [Storage overview](/docs/v1/server-db/storage)
+- [Storage reference](/reference/v1/storage/libsql)

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

@@ -32,5 +32,5 @@ This method does not return a value.
 
 ## Related
 
-- [Logging](/docs/observability/logging)
-- [PinoLogger](/reference/observability/logging/pino-logger)
+- [Logging]/docs/v1/logging)
+- [PinoLogger]/reference/v1/logging/pino-logger)

package/.docs/raw/reference/deployer/cloudflare.mdx

@@ -5,12 +5,12 @@ description: "Documentation for the CloudflareDeployer class, which deploys Mast
 
 # CloudflareDeployer
 
-The `CloudflareDeployer` class handles deployment of standalone Mastra applications to Cloudflare Workers. It manages configuration, deployment, and extends the base [Deployer](/reference/deployer/) class with Cloudflare specific functionality.
+The `CloudflareDeployer` class handles deployment of standalone Mastra applications to Cloudflare Workers. It manages configuration, deployment, and extends the base [Deployer](/reference/v1/deployer/) class with Cloudflare specific functionality.
 
 ## Usage example
 
 ```typescript title="src/mastra/index.ts" showLineNumbers copy
-import { Mastra } from "@mastra/core/mastra";
+import { Mastra } from "@mastra/core";
 import { CloudflareDeployer } from "@mastra/deployer-cloudflare";
 
 export const mastra = new Mastra({

package/.docs/raw/reference/deployer/deployer.mdx

@@ -99,12 +99,6 @@ The Deployer class inherits the following key methods from the Bundler class:
       description:
         "Prepares the output directory by cleaning it and creating necessary subdirectories.",
     },
-    {
-      name: "writeInstrumentationFile",
-      type: "(outputDirectory: string) => Promise<void>",
-      description:
-        "Writes an instrumentation file to the output directory for telemetry purposes.",
-    },
     {
       name: "writePackageJson",
       type: "(outputDirectory: string, dependencies: Map<string, string>) => Promise<void>",

package/.docs/raw/reference/deployer/netlify.mdx

@@ -5,12 +5,12 @@ description: "Documentation for the NetlifyDeployer class, which deploys Mastra
 
 # NetlifyDeployer
 
-The `NetlifyDeployer` class handles deployment of standalone Mastra applications to Netlify. It manages configuration, deployment, and extends the base [Deployer](/reference/deployer/) class with Netlify specific functionality.
+The `NetlifyDeployer` class handles deployment of standalone Mastra applications to Netlify. It manages configuration, deployment, and extends the base [Deployer](/reference/v1/deployer/) class with Netlify specific functionality.
 
 ## Usage example
 
 ```typescript title="src/mastra/index.ts" showLineNumbers copy
-import { Mastra } from "@mastra/core/mastra";
+import { Mastra } from "@mastra/core";
 import { NetlifyDeployer } from "@mastra/deployer-netlify";
 
 export const mastra = new Mastra({

package/.docs/raw/reference/deployer/vercel.mdx

@@ -5,12 +5,12 @@ description: "Documentation for the VercelDeployer class, which deploys Mastra a
 
 # VercelDeployer
 
-The `VercelDeployer` class handles deployment of standalone Mastra applications to Vercel. It manages configuration, deployment, and extends the base [Deployer](/reference/deployer/) class with Vercel specific functionality.
+The `VercelDeployer` class handles deployment of standalone Mastra applications to Vercel. It manages configuration, deployment, and extends the base [Deployer](/reference/v1/deployer/) class with Vercel specific functionality.
 
 ## Usage example
 
 ```typescript title="src/mastra/index.ts" showLineNumbers copy
-import { Mastra } from "@mastra/core/mastra";
+import { Mastra } from "@mastra/core";
 import { VercelDeployer } from "@mastra/deployer-vercel";
 
 export const mastra = new Mastra({
@@ -32,7 +32,7 @@ These options are merged into `.vercel/output/functions/index.func/.vc-config.js
 ### Example with overrides
 
 ```typescript title="src/mastra/index.ts" showLineNumbers copy
-import { Mastra } from "@mastra/core/mastra";
+import { Mastra } from "@mastra/core";
 import { VercelDeployer } from "@mastra/deployer-vercel";
 
 export const mastra = new Mastra({