@mastra/mcp-docs-server 0.13.38 → 0.13.39

package/.docs/raw/memory/overview.mdx

@@ -69,7 +69,7 @@ To persist and recall information between conversations, memory requires a stora
 
 Supported options include [LibSQL](/docs/memory/storage/memory-with-libsql), [MongoDB](/examples/memory/memory-with-mongodb), [Postgres](/docs/memory/storage/memory-with-pg), and [Upstash](/docs/memory/storage/memory-with-upstash)
 
-We use LibSQL out of the box because it is file-based or in-memory, so it is easy to install and works well with the playground.
+We use LibSQL out of the box because it is file-based or in-memory, so it is easy to install and works well with Studio.
 
 ## Dedicated storage
 

package/.docs/raw/memory/semantic-recall.mdx

@@ -49,7 +49,7 @@ The three main parameters that control semantic recall behavior are:
 
 1. **topK**: How many semantically similar messages to retrieve
 2. **messageRange**: How much surrounding context to include with each match
-3. **scope**: Whether to search within the current thread or across all threads owned by a resource. Using `scope: 'resource'` allows the agent to recall information from any of the user's past conversations.
+3. **scope**: Whether to search within the current thread or across all threads owned by a resource (the default is resource scope).
 
 ```typescript {5-7}
 const agent = new Agent({
@@ -58,15 +58,13 @@ const agent = new Agent({
       semanticRecall: {
         topK: 3, // Retrieve 3 most similar messages
         messageRange: 2, // Include 2 messages before and after each match
-        scope: 'resource', // Search across all threads for this user
+        scope: "resource", // Search across all threads for this user (default setting if omitted)
       },
     },
   }),
 });
 ```
 
-Note: currently, `scope: 'resource'` for semantic recall is supported by the following storage adapters: LibSQL, Postgres, and Upstash.
-
 ### Storage configuration
 
 Semantic recall relies on a [storage and vector db](/reference/memory/memory-class) to store messages and their embeddings.

package/.docs/raw/memory/threads-and-resources.mdx

@@ -27,7 +27,7 @@ Even with memory configured, agents won’t store or recall information unless b
 
 :::
 
-> Mastra Playground sets `thread` and `resource` IDs automatically. In your own application, you must provide them manually as part of each `.generate()` or `.stream()` call.
+> Studio sets `thread` and `resource` IDs automatically. In your own application, you must provide them manually as part of each `.generate()` or `.stream()` call.
 
 ### Thread title generation
 

package/.docs/raw/memory/working-memory.mdx

@@ -3,7 +3,7 @@ title: "Working Memory | Memory | Mastra Docs"
 description: "Learn how to configure working memory in Mastra to store persistent user data, preferences."
 ---
 
-import Youtube from "@site/src/components/YouTube-player";
+import YouTube from "@site/src/components/YouTube-player";
 
 # Working Memory
 

package/.docs/raw/observability/ai-tracing/exporters/default.mdx

@@ -5,7 +5,7 @@ description: "Store traces locally for development and debugging"
 
 # Default Exporter
 
-The `DefaultExporter` persists traces to your configured storage backend, making them accessible through the Mastra Playground. It's automatically enabled when using the default observability configuration and requires no external services.
+The `DefaultExporter` persists traces to your configured storage backend, making them accessible through Studio. It's automatically enabled when using the default observability configuration and requires no external services.
 
 ## When to Use DefaultExporter
 
@@ -14,14 +14,14 @@ DefaultExporter is ideal for:
 - **Local development** - Debug and analyze traces offline
 - **Data ownership** - Complete control over your trace data
 - **Zero dependencies** - No external services required
-- **Playground integration** - View traces in Mastra Playground UI
+- **Studio integration** - View traces in Studio
 
 ## Configuration
 
 ### Prerequisites
 
 1. **Storage Backend**: Configure a storage provider (LibSQL, PostgreSQL, etc.)
-2. **Mastra Playground**: Install for viewing traces locally
+2. **Studio**: Install for viewing traces locally
 
 ### Basic Setup
 
@@ -62,11 +62,11 @@ export const mastra = new Mastra({
 
 ## Viewing Traces
 
-### Mastra Playground
+### Studio
 
-Access your traces through the local Playground:
+Access your traces through Studio:
 
-1. Start the Playground
+1. Start Studio
 2. Navigate to Observability
 3. Filter and search your local traces
 4. Inspect detailed span information

package/.docs/raw/observability/ai-tracing/overview.mdx

@@ -79,7 +79,7 @@ Exporters determine where your AI trace data is sent and how it's stored. Choosi
 
 Mastra provides two built-in exporters that work out of the box:
 
-- **[Default](/docs/observability/ai-tracing/exporters/default)** - Persists traces to local storage for viewing in the Playground
+- **[Default](/docs/observability/ai-tracing/exporters/default)** - Persists traces to local storage for viewing in Studio
 - **[Cloud](/docs/observability/ai-tracing/exporters/cloud)** - Sends traces to Mastra Cloud for production monitoring and collaboration
 
 ### External Exporters
@@ -316,9 +316,9 @@ observability: {
 }
 ```
 
-#### Maintaining Playground and Cloud Access
+#### Maintaining Studio and Cloud Access
 
-When creating a custom config with external exporters, you might lose access to Mastra Playground and Cloud. To maintain access while adding external exporters, include the default exporters in your custom config:
+When creating a custom config with external exporters, you might lose access to Studio and Cloud. To maintain access while adding external exporters, include the default exporters in your custom config:
 
 ```ts title="src/mastra/index.ts" showLineNumbers copy
 import { DefaultExporter, CloudExporter } from "@mastra/core/ai-tracing";
@@ -336,7 +336,7 @@ export const mastra = new Mastra({
             endpoint: process.env.PHOENIX_ENDPOINT,
             apiKey: process.env.PHOENIX_API_KEY,
           }),
-          new DefaultExporter(), // Keep Playground access
+          new DefaultExporter(), // Keep Studio access
           new CloudExporter(), // Keep Cloud access
         ],
       },
@@ -348,7 +348,7 @@ export const mastra = new Mastra({
 This configuration sends traces to all three destinations simultaneously:
 
 - **Arize Phoenix/AX** for external observability
-- **DefaultExporter** for local Playground access
+- **DefaultExporter** for Studio
 - **CloudExporter** for Mastra Cloud dashboard
 
 :::info
@@ -643,7 +643,7 @@ console.log("Trace ID:", finalState.traceId);
 
 Once you have a trace ID, you can:
 
-1. **Look up traces in Mastra Playground**: Navigate to the traces view and search by ID
+1. **Look up traces in Studio**: Navigate to the traces view and search by ID
 2. **Query traces in external platforms**: Use the ID in Langfuse, Braintrust, or your observability platform
 3. **Correlate with logs**: Include the trace ID in your application logs for cross-referencing
 4. **Share for debugging**: Provide trace IDs to support teams or developers for investigation
@@ -778,7 +778,7 @@ Mastra automatically creates spans for:
 
 Traces are available in multiple locations:
 
-- **Mastra Playground** - Local development environment
+- **Studio** - Local development environment
 - **Mastra Cloud** - Production monitoring dashboard
 - **Arize Phoenix / Arize AX** - When using Arize exporter
 - **Braintrust Console** - When using Braintrust exporter

package/.docs/raw/observability/overview.mdx

@@ -58,7 +58,7 @@ export const mastra = new Mastra({
 });
 ```
 
-With this basic setup, you will see Traces and Logs in both the Playground and in Mastra Cloud.
+With this basic setup, you will see Traces and Logs in both Studio and in Mastra Cloud.
 
 We also support various external tracing providers like Langfuse, Braintrust, and any OpenTelemetry-compatible platform (Datadog, New Relic, SigNoz, etc.). See more about this in the [AI Tracing](/docs/observability/ai-tracing/overview) documentation.
 

package/.docs/raw/reference/agents/agent.mdx

@@ -124,8 +124,8 @@ export const agent = new Agent({
       name: "instructions",
       type: "SystemMessage | ({ runtimeContext: RuntimeContext }) => SystemMessage | Promise<SystemMessage>",
       isOptional: false,
-      description: `Instructions that guide the agent's behavior. Can be a string, array of strings, system message object, 
-        array of system messages, or a function that returns any of these types dynamically. 
+      description: `Instructions that guide the agent's behavior. Can be a string, array of strings, system message object,
+        array of system messages, or a function that returns any of these types dynamically.
         SystemMessage types: string | string[] | CoreSystemMessage | CoreSystemMessage[] | SystemModelMessage | SystemModelMessage[]`,
     },
     {

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

@@ -0,0 +1,69 @@
+---
+title: "Reference: Agent.listScorers() | Agents | Mastra Docs"
+description: "Documentation for the `Agent.listScorers()` method in Mastra agents, which retrieves the scoring configuration."
+---
+
+# Agent.listScorers()
+
+The `.listScorers()` method retrieves the scoring configuration configured for an agent, resolving it if it's a function. This method provides access to the scoring system used for evaluating agent responses and performance.
+
+## Usage example
+
+```typescript copy
+await agent.listScorers();
+```
+
+## Parameters
+
+<PropertiesTable
+  content={[
+    {
+      name: "options",
+      type: "{ runtimeContext?: RuntimeContext }",
+      isOptional: true,
+      defaultValue: "{}",
+      description: "Optional configuration object containing request context.",
+    },
+  ]}
+/>
+
+## Returns
+
+<PropertiesTable
+  content={[
+    {
+      name: "scorers",
+      type: "MastraScorers | Promise<MastraScorers>",
+      description:
+        "The scoring configuration configured for the agent, either as a direct object or a promise that resolves to the scorers.",
+    },
+  ]}
+/>
+
+## Extended usage example
+
+```typescript copy
+await agent.listScorers({
+  runtimeContext: new RuntimeContext(),
+});
+```
+
+### Options parameters
+
+<PropertiesTable
+  content={[
+    {
+      name: "runtimeContext",
+      type: "RuntimeContext",
+      isOptional: true,
+      defaultValue: "new RuntimeContext()",
+      description:
+        "Request Context for dependency injection and contextual information.",
+    },
+  ]}
+/>
+
+## Related
+
+- [Agents overview](/docs/agents/overview)
+- [Runtime Context](/docs/server-db/runtime-context)

package/.docs/raw/reference/agents/listTools.mdx

@@ -0,0 +1,69 @@
+---
+title: "Reference: Agent.listTools() | Agents | Mastra Docs"
+description: "Documentation for the `Agent.listTools()` method in Mastra agents, which retrieves the tools that the agent can use."
+---
+
+# Agent.listTools()
+
+The `.listTools()` method retrieves the tools configured for an agent, resolving them if they're a function. These tools extend the agent's capabilities, allowing it to perform specific actions or access external systems.
+
+## Usage example
+
+```typescript copy
+await agent.listTools();
+```
+
+## Parameters
+
+<PropertiesTable
+  content={[
+    {
+      name: "options",
+      type: "{ runtimeContext?: RuntimeContext }",
+      isOptional: true,
+      defaultValue: "{}",
+      description: "Optional configuration object containing request context.",
+    },
+  ]}
+/>
+
+## Returns
+
+<PropertiesTable
+  content={[
+    {
+      name: "tools",
+      type: "TTools | Promise<TTools>",
+      description:
+        "The tools configured for the agent, either as a direct object or a promise that resolves to the tools.",
+    },
+  ]}
+/>
+
+## Extended usage example
+
+```typescript copy
+await agent.listTools({
+  runtimeContext: new RuntimeContext(),
+});
+```
+
+### Options parameters
+
+<PropertiesTable
+  content={[
+    {
+      name: "runtimeContext",
+      type: "RuntimeContext",
+      isOptional: true,
+      defaultValue: "new RuntimeContext()",
+      description:
+        "Request Context for dependency injection and contextual information.",
+    },
+  ]}
+/>
+
+## Related
+
+- [Using tools with agents](/docs/agents/using-tools)
+- [Creating tools](/docs/tools-mcp/overview)

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

@@ -0,0 +1,69 @@
+---
+title: "Reference: Agent.listWorkflows() | Agents | Mastra Docs"
+description: "Documentation for the `Agent.listWorkflows()` method in Mastra agents, which retrieves the workflows that the agent can execute."
+---
+
+# Agent.listWorkflows()
+
+The `.listWorkflows()` method retrieves the workflows configured for an agent, resolving them if they're a function. These workflows enable the agent to execute complex, multi-step processes with defined execution paths.
+
+## Usage example
+
+```typescript copy
+await agent.listWorkflows();
+```
+
+## Parameters
+
+<PropertiesTable
+  content={[
+    {
+      name: "options",
+      type: "{ runtimeContext?: RuntimeContext }",
+      isOptional: true,
+      defaultValue: "{}",
+      description: "Optional configuration object containing request context.",
+    },
+  ]}
+/>
+
+## Returns
+
+<PropertiesTable
+  content={[
+    {
+      name: "workflows",
+      type: "Promise<Record<string, Workflow>>",
+      description:
+        "A promise that resolves to a record of workflow names to their corresponding Workflow instances.",
+    },
+  ]}
+/>
+
+## Extended usage example
+
+```typescript copy
+await agent.listWorkflows({
+  runtimeContext: new RuntimeContext(),
+});
+```
+
+### Options parameters
+
+<PropertiesTable
+  content={[
+    {
+      name: "runtimeContext",
+      type: "RuntimeContext",
+      isOptional: true,
+      defaultValue: "new RuntimeContext()",
+      description:
+        "Request Context for dependency injection and contextual information.",
+    },
+  ]}
+/>
+
+## Related
+
+- [Agents overview](/docs/agents/overview)
+- [Workflows overview](/docs/workflows/overview)

package/.docs/raw/reference/cli/mastra.mdx

@@ -9,7 +9,7 @@ You can use the Command-Line Interface (CLI) provided by Mastra to develop, buil
 
 ## `mastra dev`
 
-Starts a server which exposes a [local dev playground](/docs/getting-started/studio) and REST endpoints for your agents, tools, and workflows. You can visit [http://localhost:4111/swagger-ui](http://localhost:4111/swagger-ui) for an overview of all available endpoints once `mastra dev` is running.
+Starts a server which exposes [Studio](/docs/getting-started/studio) and REST endpoints for your agents, tools, and workflows. You can visit [http://localhost:4111/swagger-ui](http://localhost:4111/swagger-ui) for an overview of all available endpoints once `mastra dev` is running.
 
 You can also [configure the server](/docs/getting-started/studio#configuration).
 

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

@@ -12,7 +12,7 @@ The Agents API provides methods to interact with Mastra AI agents, including gen
 Retrieve a list of all available agents:
 
 ```typescript
-const agents = await mastraClient.getAgents();
+const agents = await mastraClient.listAgents();
 ```
 
 ## Working with a Specific Agent

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

@@ -12,7 +12,7 @@ The Logs API provides methods to access and query system logs and debugging info
 Retrieve system logs with optional filtering:
 
 ```typescript
-const logs = await mastraClient.getLogs({
+const logs = await mastraClient.listLogs({
   transportId: "transport-1",
 });
 ```

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

@@ -74,7 +74,7 @@ export const mastraClient = new MastraClient({
 <PropertiesTable
   content={[
     {
-      name: "getAgents()",
+      name: "listAgents()",
       type: "Promise<Record<string, GetAgentResponse>>",
       description: "Returns all available agent instances.",
     },
@@ -95,8 +95,8 @@ export const mastraClient = new MastraClient({
       description: "Creates a new memory thread with the given parameters.",
     },
     {
-      name: "getMemoryThread(threadId)",
-      type: "Promise<MemoryThread>",
+      name: "getMemoryThread({ threadId, agentId })",
+      type: "MemoryThread",
       description: "Fetches a specific memory thread by ID.",
     },
     {
@@ -110,7 +110,7 @@ export const mastraClient = new MastraClient({
       description: "Returns the current status of the memory system.",
     },
     {
-      name: "getTools()",
+      name: "listTools()",
       type: "Record<string, Tool>",
       description: "Returns all available tools.",
     },
@@ -120,7 +120,7 @@ export const mastraClient = new MastraClient({
       description: "Retrieves a specific tool instance by ID.",
     },
     {
-      name: "getWorkflows()",
+      name: "listWorkflows()",
       type: "Record<string, Workflow>",
       description: "Returns all available workflow instances.",
     },
@@ -135,7 +135,7 @@ export const mastraClient = new MastraClient({
       description: "Returns a vector store instance by name.",
     },
     {
-      name: "getLogs(params)",
+      name: "listLogs(params)",
       type: "Promise<LogEntry[]>",
       description: "Fetches system logs matching the provided filters.",
     },
@@ -145,7 +145,7 @@ export const mastraClient = new MastraClient({
       description: "Retrieves a specific log entry by ID or filter.",
     },
     {
-      name: "getLogTransports()",
+      name: "listLogTransports()",
       type: "string[]",
       description: "Returns the list of configured log transport types.",
     },

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

@@ -36,7 +36,7 @@ const thread = await mastraClient.createMemoryThread({
 Get an instance of a specific memory thread:
 
 ```typescript
-const thread = mastraClient.getMemoryThread("thread-id", "agent-id");
+const thread = mastraClient.getMemoryThread({ threadId: "thread-id", agentId: "agent-id" });
 ```
 
 ## Thread Methods

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

@@ -12,7 +12,7 @@ The Tools API provides methods to interact with and execute tools available in t
 Retrieve a list of all available tools:
 
 ```typescript
-const tools = await mastraClient.getTools();
+const tools = await mastraClient.listTools();
 ```
 
 ## Working with a Specific Tool

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

@@ -12,7 +12,7 @@ The Workflows API provides methods to interact with and execute automated workfl
 Retrieve a list of all available workflows:
 
 ```typescript
-const workflows = await mastraClient.getWorkflows();
+const workflows = await mastraClient.listWorkflows();
 ```
 
 ## Working with a Specific Workflow

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

@@ -74,5 +74,5 @@ try {
 ## Related
 
 - [getScorer()](../../reference/core/getScorer) - Get a scorer by its registration key
-- [getScorers()](../../reference/core/getScorers) - Get all registered scorers
+- [listScorers()](../../reference/core/listScorers) - Get all registered scorers
 - [createScorer()](../../reference/scorers/create-scorer) - Learn how to create scorers with names

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

@@ -0,0 +1,35 @@
+---
+title: "Reference: Mastra.listAgents() | Core | Mastra Docs"
+description: "Documentation for the `Mastra.listAgents()` method in Mastra, which retrieves all configured agents."
+---
+
+# Mastra.listAgents()
+
+The `.listAgents()` method is used to retrieve all agents that have been configured in the Mastra instance.
+
+## Usage example
+
+```typescript copy
+mastra.listAgents();
+```
+
+## 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)

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

@@ -0,0 +1,96 @@
+---
+title: "Reference: Mastra.listLogs() | Core | Mastra Docs"
+description: "Documentation for the `Mastra.listLogs()` method in Mastra, which retrieves all logs for a specific transport ID."
+---
+
+# Mastra.listLogs()
+
+The `.listLogs()` method is used to retrieve all logs for a specific transport ID. This method requires a configured logger that supports the `listLogs` operation.
+
+## Usage example
+
+```typescript copy
+mastra.listLogs("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)
+- [Logger reference](/reference/observability/logging/pino-logger)