@mastra/mcp-docs-server 0.13.37 → 0.13.38

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

@@ -1,15 +1,15 @@
 ---
-title: MastraClient
+title: "Reference: Mastra Client SDK | Client SDK | Mastra Docs"
 description: Learn how to interact with Mastra using the client-js SDK.
 ---
 
 # Mastra Client SDK
 
-The Mastra Client SDK provides a simple and type-safe interface for interacting with your [Mastra Server](/docs/deployment/server-deployment.mdx) from your client environment.
+The Mastra Client SDK provides a simple and type-safe interface for interacting with your [Mastra Server](/docs/deployment/server-deployment) from your client environment.
 
 ## Usage example
 
-```typescript filename="lib/mastra/mastra-client.ts" showLineNumbers copy
+```typescript title="lib/mastra/mastra-client.ts" showLineNumbers copy
 import { MastraClient } from "@mastra/client-js";
 
 export const mastraClient = new MastraClient({
@@ -24,40 +24,46 @@ export const mastraClient = new MastraClient({
     {
       name: "baseUrl",
       type: "string",
-      description: "The base URL for the Mastra API. All requests will be sent relative to this URL.",
+      description:
+        "The base URL for the Mastra API. All requests will be sent relative to this URL.",
       isOptional: false,
     },
     {
       name: "retries",
       type: "number",
-      description: "The number of times a request will be retried on failure before throwing an error.",
+      description:
+        "The number of times a request will be retried on failure before throwing an error.",
       isOptional: true,
       defaultValue: "3",
     },
     {
       name: "backoffMs",
       type: "number",
-      description: "The initial delay in milliseconds before retrying a failed request. This value is doubled with each retry (exponential backoff).",
+      description:
+        "The initial delay in milliseconds before retrying a failed request. This value is doubled with each retry (exponential backoff).",
       isOptional: true,
       defaultValue: "300",
     },
     {
       name: "maxBackoffMs",
       type: "number",
-      description: "The maximum backoff time in milliseconds. Prevents retries from waiting too long between attempts.",
+      description:
+        "The maximum backoff time in milliseconds. Prevents retries from waiting too long between attempts.",
       isOptional: true,
       defaultValue: "5000",
     },
     {
       name: "headers",
       type: "Record<string, string>",
-      description: "An object containing custom HTTP headers to include with every request.",
+      description:
+        "An object containing custom HTTP headers to include with every request.",
       isOptional: true,
     },
     {
       name: "credentials",
       type: '"omit" | "same-origin" | "include"',
-      description: "Credentials mode for requests. See https://developer.mozilla.org/en-US/docs/Web/API/Request/credentials for more info.",
+      description:
+        "Credentials mode for requests. See https://developer.mozilla.org/en-US/docs/Web/API/Request/credentials for more info.",
       isOptional: true,
     },
   ]}
@@ -80,7 +86,8 @@ export const mastraClient = new MastraClient({
     {
       name: "getMemoryThreads(params)",
       type: "Promise<StorageThreadType[]>",
-      description: "Retrieves memory threads for the specified resource and agent. Requires a `resourceId` and an `agentId`.",
+      description:
+        "Retrieves memory threads for the specified resource and agent. Requires a `resourceId` and an `agentId`.",
     },
     {
       name: "createMemoryThread(params)",
@@ -145,13 +152,14 @@ export const mastraClient = new MastraClient({
     {
       name: "getAITrace(traceId)",
       type: "Promise<AITraceRecord>",
-      description: "Retrieves a specific AI trace by ID, including all its spans and details.",
+      description:
+        "Retrieves a specific AI trace by ID, including all its spans and details.",
     },
     {
       name: "getAITraces(params)",
       type: "Promise<GetAITracesResponse>",
-      description: "Retrieves paginated list of AI trace root spans with optional filtering. Use getAITrace() to get complete traces with all spans.",
+      description:
+        "Retrieves paginated list of AI trace root spans with optional filtering. Use getAITrace() to get complete traces with all spans.",
     },
   ]}
 />
-

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

@@ -1,5 +1,5 @@
 ---
-title: Mastra Client Memory API
+title: "Reference: Memory API | Client SDK | Mastra Docs"
 description: Learn how to manage conversation threads and message history in Mastra using the client-js SDK.
 ---
 
@@ -117,7 +117,11 @@ const result = await thread.deleteMessage("message-id");
 Delete multiple messages from a thread in a single operation:
 
 ```typescript
-const result = await thread.deleteMessages(["message-1", "message-2", "message-3"]);
+const result = await thread.deleteMessages([
+  "message-1",
+  "message-2",
+  "message-3",
+]);
 // Returns: { success: true, message: "3 messages deleted successfully" }
 ```
 

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

@@ -1,5 +1,5 @@
 ---
-title: Mastra Client Observability API
+title: "Reference: Observability API | Client SDK | Mastra Docs"
 description: Learn how to retrieve AI traces, monitor application performance, and score traces using the client-js SDK.
 ---
 
@@ -25,16 +25,16 @@ const traces = await mastraClient.getAITraces({
     page: 1,
     perPage: 20,
     dateRange: {
-      start: new Date('2024-01-01'),
-      end: new Date('2024-01-31')
-    }
+      start: new Date("2024-01-01"),
+      end: new Date("2024-01-31"),
+    },
   },
   filters: {
     name: "weather-agent", // Filter by trace name
     spanType: "agent", // Filter by span type
     entityId: "weather-agent-id", // Filter by entity ID
-    entityType: "agent" // Filter by entity type
-  }
+    entityType: "agent", // Filter by entity type
+  },
 });
 
 console.log(`Found ${traces.spans.length} root spans`);
@@ -54,7 +54,7 @@ const result = await mastraClient.score({
   targets: [
     { traceId: "trace-1", spanId: "span-1" }, // Score specific span
     { traceId: "trace-2" }, // Score specific span which defaults to the parent span
-  ]
+  ],
 });
 ```
 
@@ -67,10 +67,11 @@ const scores = await mastraClient.getScoresBySpan({
   traceId: "trace-123",
   spanId: "span-456",
   page: 1,
-  perPage: 20
+  perPage: 20,
 });
 ```
+
 ## Related
 
 - [Agents API](./agents) - Learn about agent interactions that generate traces
-- [Workflows API](./workflows) - Understand workflow execution monitoring  
+- [Workflows API](./workflows) - Understand workflow execution monitoring

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

@@ -1,5 +1,5 @@
 ---
-title: Mastra Client Telemetry API
+title: "Reference: Telemetry API | Client SDK | Mastra Docs"
 description: Learn how to retrieve and analyze traces from your Mastra application for monitoring and debugging using the client-js SDK.
 ---
 

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

@@ -1,5 +1,5 @@
 ---
-title: Mastra Client Tools API
+title: "Reference: Tools API | Client SDK | Mastra Docs"
 description: Learn how to interact with and execute tools available in the Mastra platform using the client-js SDK.
 ---
 

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

@@ -1,5 +1,5 @@
 ---
-title: Mastra Client Vectors API
+title: "Reference: Vectors API | Client SDK | Mastra Docs"
 description: Learn how to work with vector embeddings for semantic search and similarity matching in Mastra using the client-js SDK.
 ---
 

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

@@ -1,5 +1,5 @@
 ---
-title: Mastra Client Workflows (Legacy) API
+title: "Reference: Workflows (Legacy) API | Client SDK | Mastra Docs"
 description: Learn how to interact with and execute automated legacy workflows in Mastra using the client-js SDK.
 ---
 

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

@@ -1,5 +1,5 @@
 ---
-title: Mastra Client Workflows API
+title: "Reference: Workflows API | Client SDK | Mastra Docs"
 description: Learn how to interact with and execute automated workflows in Mastra using the client-js SDK.
 ---
 
@@ -19,10 +19,10 @@ const workflows = await mastraClient.getWorkflows();
 
 Get an instance of a specific workflow as defined by the const name:
 
-```typescript filename="src/mastra/workflows/test-workflow.ts"
+```typescript title="src/mastra/workflows/test-workflow.ts"
 export const testWorkflow = createWorkflow({
-  id: 'city-workflow'
-})
+  id: "city-workflow",
+});
 ```
 
 ```typescript
@@ -125,7 +125,7 @@ try {
 
   const stream = await run.stream({
     inputData: {
-      city: 'New York',
+      city: "New York",
     },
   });
 
@@ -133,7 +133,7 @@ try {
     console.log(JSON.stringify(chunk, null, 2));
   }
 } catch (e) {
-  console.error('Workflow error:', e);
+  console.error("Workflow error:", e);
 }
 ```
 
@@ -142,7 +142,7 @@ try {
 Get the result of a workflow run:
 
 ```typescript
-try  {
+try {
   const workflow = mastraClient.getWorkflow("testWorkflow");
 
   const run = await workflow.createRunAsync();

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

@@ -1,5 +1,5 @@
 ---
-title: "Reference: Agent.getAgent() | Agents | Mastra Docs"
+title: "Reference: Mastra.getAgent() | Core | Mastra Docs"
 description: "Documentation for the `Agent.getAgent()` method in Mastra, which retrieves an agent by name."
 ---
 
@@ -20,7 +20,8 @@ mastra.getAgent("testAgent");
     {
       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.",
+      description:
+        "The name of the agent to retrieve. Must be a valid agent name that exists in the Mastra configuration.",
     },
   ]}
 />
@@ -32,12 +33,12 @@ mastra.getAgent("testAgent");
     {
       name: "agent",
       type: "TAgents[TAgentName]",
-      description: "The agent instance with the specified name. Throws an error if the agent is not found.",
+      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)
+- [Agents overview](/docs/agents/overview)

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

@@ -20,7 +20,8 @@ mastra.getAgentById("test-agent-123");
     {
       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().",
+      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().",
     },
   ]}
 />
@@ -32,12 +33,12 @@ mastra.getAgentById("test-agent-123");
     {
       name: "agent",
       type: "Agent",
-      description: "The agent instance with the specified ID. Throws an error if the agent is not found.",
+      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)
+- [Agents overview](/docs/agents/overview)

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

@@ -24,12 +24,12 @@ This method does not accept any parameters.
     {
       name: "agents",
       type: "TAgents",
-      description: "A record of all configured agents, where keys are agent names and values are agent instances.",
+      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)
+- [Agents overview](/docs/agents/overview)

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

@@ -24,12 +24,13 @@ This method does not accept any parameters.
     {
       name: "deployer",
       type: "MastraDeployer | undefined",
-      description: "The configured deployer instance, or undefined if no deployer has been configured.",
+      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)
+- [Deployment overview](/docs/deployment/overview)
+- [Deployer reference](/reference/deployer/)

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

@@ -24,12 +24,13 @@ This method does not accept any parameters.
     {
       name: "logger",
       type: "TLogger",
-      description: "The configured logger instance used for logging across all components (agents, workflows, etc.).",
+      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)
+- [Logging overview](/docs/observability/logging)
+- [Logger reference](/reference/observability/logging/pino-logger)

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

@@ -25,7 +25,8 @@ mastra.getLogs("456");
     {
       name: "options",
       type: "object",
-      description: "Optional parameters for filtering and pagination. See Options section below for details.",
+      description:
+        "Optional parameters for filtering and pagination. See Options section below for details.",
       optional: true,
     },
   ]}
@@ -38,13 +39,15 @@ mastra.getLogs("456");
     {
       name: "fromDate",
       type: "Date",
-      description: "Optional start date for filtering logs. e.g., new Date('2024-01-01').",
+      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').",
+      description:
+        "Optional end date for filtering logs. e.g., new Date('2024-01-31').",
       optional: true,
     },
     {
@@ -81,12 +84,13 @@ mastra.getLogs("456");
     {
       name: "logs",
       type: "Promise<any>",
-      description: "A promise that resolves to the logs for the specified transport ID.",
+      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)
+- [Logging overview](/docs/observability/logging)
+- [Logger reference](/reference/observability/logging/pino-logger)

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

@@ -30,13 +30,15 @@ mastra.getLogsByRunId({ runId: "123", transportId: "456" });
     {
       name: "fromDate",
       type: "Date",
-      description: "Optional start date for filtering logs. e.g., new Date('2024-01-01').",
+      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').",
+      description:
+        "Optional end date for filtering logs. e.g., new Date('2024-01-31').",
       optional: true,
     },
     {
@@ -73,12 +75,13 @@ mastra.getLogsByRunId({ runId: "123", transportId: "456" });
     {
       name: "logs",
       type: "Promise<any>",
-      description: "A promise that resolves to the logs for the specified run ID and transport ID.",
+      description:
+        "A promise that resolves to the logs for the specified run ID and transport ID.",
     },
   ]}
 />
 
 ## Related
 
-- [Logging overview](../../docs/observability/logging.mdx)
-- [Logger reference](../../reference/observability/logger.mdx)
+- [Logging overview](/docs/observability/logging)
+- [Logger reference](/reference/observability/logging/pino-logger)

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

@@ -20,12 +20,14 @@ mastra.getMCPServer("1.2.0");
     {
       name: "serverId",
       type: "string",
-      description: "The logical ID of the MCP server to retrieve. Should match the `id` property of the MCPServer instance.",
+      description:
+        "The logical ID of the MCP server to retrieve. Should match the `id` property of the MCPServer instance.",
     },
     {
       name: "version",
       type: "string",
-      description: "Optional specific version of the MCP server to retrieve. If not provided, returns the server with the most recent releaseDate.",
+      description:
+        "Optional specific version of the MCP server to retrieve. If not provided, returns the server with the most recent releaseDate.",
       optional: true,
     },
   ]}
@@ -38,12 +40,13 @@ mastra.getMCPServer("1.2.0");
     {
       name: "server",
       type: "MCPServerBase | undefined",
-      description: "The MCP server instance with the specified ID and version, or undefined if not found or if the specific version is not found.",
+      description:
+        "The MCP server instance with the specified ID and version, or undefined if not found or if the specific version is not found.",
     },
   ]}
 />
 
 ## Related
 
-- [MCP overview](../../docs/tools-mcp/mcp-overview.mdx)
-- [MCP server reference](../../reference/tools/mcp-server.mdx)
+- [MCP overview](/docs/tools-mcp/mcp-overview)
+- [MCP server reference](/reference/tools/mcp-server)

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

@@ -24,12 +24,13 @@ This method does not accept any parameters.
     {
       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.",
+      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)
+- [MCP overview](/docs/tools-mcp/mcp-overview)
+- [MCP server reference](/reference/tools/mcp-server)

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

@@ -24,12 +24,13 @@ This method does not accept any parameters.
     {
       name: "memory",
       type: "MastraMemory | undefined",
-      description: "The configured memory instance, or undefined if no memory has been configured.",
+      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)
+- [Memory overview](/docs/memory/overview)
+- [Memory reference](/reference/memory/memory-class)

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

@@ -10,15 +10,15 @@ The `getScorer()` method retrieves a specific scorer that was registered with th
 ## Usage Example
 
 ```typescript
-import { mastra } from './mastra';
+import { mastra } from "./mastra";
 
 // Get a specific scorer by key
-const relevancyScorer = mastra.getScorer('relevancyScorer');
+const relevancyScorer = mastra.getScorer("relevancyScorer");
 
-const weatherAgent = mastra.getAgent('weatherAgent')
+const weatherAgent = mastra.getAgent("weatherAgent");
 
 // Use the scorer to evaluate an AI output
-await weatherAgent.generate('What is the weather in Rome', {
+await weatherAgent.generate("What is the weather in Rome", {
   scorers: {
     answerRelevancy: {
       scorer: relevancyScorer,
@@ -34,7 +34,8 @@ await weatherAgent.generate('What is the weather in Rome', {
     {
       name: "key",
       type: "string",
-      description: "The registration key of the scorer to retrieve. This should match a key used when registering scorers in the Mastra constructor.",
+      description:
+        "The registration key of the scorer to retrieve. This should match a key used when registering scorers in the Mastra constructor.",
       isOptional: false,
     },
   ]}
@@ -47,7 +48,8 @@ await weatherAgent.generate('What is the weather in Rome', {
     {
       name: "scorer",
       type: "MastraScorer",
-      description: "The MastraScorer instance associated with the provided key.",
+      description:
+        "The MastraScorer instance associated with the provided key.",
     },
   ]}
 />
@@ -55,21 +57,22 @@ await weatherAgent.generate('What is the weather in Rome', {
 ## Error Handling
 
 This method throws a `MastraError` if:
+
 - The scorer with the specified key is not found
 - No scorers are registered with the Mastra instance
 
 ```typescript
 try {
-  const scorer = mastra.getScorer('nonExistentScorer');
+  const scorer = mastra.getScorer("nonExistentScorer");
 } catch (error) {
-  if (error.id === 'MASTRA_GET_SCORER_NOT_FOUND') {
-    console.log('Scorer not found, using default evaluation');
+  if (error.id === "MASTRA_GET_SCORER_NOT_FOUND") {
+    console.log("Scorer not found, using default evaluation");
   }
 }
 ```
 
 ## Related
 
-- [getScorers()](../../reference/core/getScorers.mdx) - Get all registered scorers
-- [getScorerByName()](../../reference/core/getScorerByName.mdx) - Get a scorer by its name property
-- [Custom Scorers](../../docs/scorers/custom-scorers.mdx) - Learn how to create custom scorers
+- [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

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

@@ -10,15 +10,15 @@ The `getScorerByName()` method retrieves a scorer by searching for its `name` pr
 ## Usage Example
 
 ```typescript
-import { mastra } from './mastra';
+import { mastra } from "./mastra";
 
 // Get a scorer by its name property
-const relevancyScorer = mastra.getScorerByName('Answer Relevancy');
+const relevancyScorer = mastra.getScorerByName("Answer Relevancy");
 
-const weatherAgent = mastra.getAgent('weatherAgent')
+const weatherAgent = mastra.getAgent("weatherAgent");
 
 // Use the scorer to evaluate an AI output
-await weatherAgent.generate('What is the weather in Rome', {
+await weatherAgent.generate("What is the weather in Rome", {
   scorers: {
     answerRelevancy: {
       scorer: relevancyScorer,
@@ -34,7 +34,8 @@ await weatherAgent.generate('What is the weather in Rome', {
     {
       name: "name",
       type: "string",
-      description: "The name property of the scorer to retrieve. This should match the 'name' field specified when creating the scorer with createScorer().",
+      description:
+        "The name property of the scorer to retrieve. This should match the 'name' field specified when creating the scorer with createScorer().",
       isOptional: false,
     },
   ]}
@@ -47,7 +48,8 @@ await weatherAgent.generate('What is the weather in Rome', {
     {
       name: "scorer",
       type: "MastraScorer",
-      description: "The MastraScorer instance that has the matching name property.",
+      description:
+        "The MastraScorer instance that has the matching name property.",
     },
   ]}
 />
@@ -55,15 +57,16 @@ await weatherAgent.generate('What is the weather in Rome', {
 ## Error Handling
 
 This method throws a `MastraError` if:
+
 - No scorer with the specified name is found
 - No scorers are registered with the Mastra instance
 
 ```typescript
 try {
-  const scorer = mastra.getScorerByName('Non-existent Scorer');
+  const scorer = mastra.getScorerByName("Non-existent Scorer");
 } catch (error) {
-  if (error.id === 'MASTRA_GET_SCORER_BY_NAME_NOT_FOUND') {
-    console.log('Scorer with that name not found');
+  if (error.id === "MASTRA_GET_SCORER_BY_NAME_NOT_FOUND") {
+    console.log("Scorer with that name not found");
   }
 }
 ```