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

package/.docs/models/providers/zhipuai.md

@@ -44,9 +44,9 @@ for await (const chunk of stream) {
 | `zhipuai/glm-4.7-flash` | 200K    |       |           |       |       |       | —          | —           |
 | `zhipuai/glm-5`         | 205K    |       |           |       |       |       | $1         | $3          |
 
-## Advanced Configuration
+## Advanced configuration
 
-### Custom Headers
+### Custom headers
 
 ```typescript
 const agent = new Agent({
@@ -63,7 +63,7 @@ const agent = new Agent({
 });
 ```
 
-### Dynamic Model Selection
+### Dynamic model selection
 
 ```typescript
 const agent = new Agent({

package/.docs/reference/agents/agent.md

@@ -1,4 +1,4 @@
-# Agent Class
+# Agent class
 
 The `Agent` class is the foundation for creating AI agents in Mastra. It provides methods for generating responses, streaming interactions, and handling voice capabilities.
 
@@ -40,7 +40,7 @@ export const agent3 = new Agent({
 })
 ```
 
-### Single CoreSystemMessage
+### Single `CoreSystemMessage`
 
 Use CoreSystemMessage format to access additional properties like `providerOptions` for provider-specific configurations:
 
@@ -63,7 +63,7 @@ export const agent = new Agent({
 })
 ```
 
-### Multiple CoreSystemMessages
+### Multiple `CoreSystemMessages`
 
 ```typescript
 import { Agent } from '@mastra/core/agent'

package/.docs/reference/agents/generateLegacy.md

@@ -126,7 +126,7 @@ await agent.generateLegacy('message for agent')
 
 **toolCalls.args** (`any`): The arguments passed to the tool.
 
-## Migration to New API
+## Migration to new API
 
 > **Info:** The new `.generate()` method offers enhanced capabilities including AI SDK v5+ compatibility, better structured output handling, and improved streaming support. See the [migration guide](https://mastra.ai/guides/migrations/vnext-to-standard-apis) for detailed migration instructions.
 

package/.docs/reference/agents/network.md

@@ -132,7 +132,7 @@ await agent.network(`
 
 **objectStream** (`ReadableStream<Partial<OUTPUT>>`): A stream of partial objects during structured output generation. Useful for streaming partial results as they're being generated.
 
-## Structured Output
+## Structured output
 
 When you need typed, validated results from your network, use the `structuredOutput` option. The network will generate a response matching your schema after task completion.
 
@@ -188,7 +188,7 @@ When using structured output, additional chunk types are emitted:
 - `network-object`: Emitted with partial objects during streaming
 - `network-object-result`: Emitted with the final structured object
 
-## Aborting a Network
+## Aborting a network
 
 Use `abortSignal` to cancel a running network. When aborted, the network stops routing, cancels any in-progress sub-agent, tool, or workflow execution, and doesn't save partial results to memory.
 

package/.docs/reference/ai-sdk/to-ai-sdk-stream.md

@@ -152,7 +152,7 @@ export async function POST(req: Request) {
 }
 ```
 
-### Using messageMetadata
+### Using `messageMetadata`
 
 ```typescript
 import { mastra } from '../../mastra'

package/.docs/reference/auth/auth0.md

@@ -1,4 +1,4 @@
-# MastraAuthAuth0 Class
+# MastraAuthAuth0 class
 
 The `MastraAuthAuth0` class provides authentication for Mastra using Auth0. It verifies incoming requests using Auth0-issued JWT tokens and integrates with the Mastra server using the `auth` option.
 
@@ -30,7 +30,7 @@ export const mastra = new Mastra({
 
 **authorizeUser** (`(user: Auth0User) => Promise<boolean> | boolean`): Custom authorization function to determine if a user should be granted access. Called after token verification. By default, allows all authenticated users with valid tokens.
 
-## Environment Variables
+## Environment variables
 
 The following environment variables are automatically used when constructor options aren't provided:
 
@@ -38,7 +38,7 @@ The following environment variables are automatically used when constructor opti
 
 **AUTH0\_AUDIENCE** (`string`): Your Auth0 API identifier. This is the identifier you set when creating an API in your Auth0 Dashboard.
 
-## Default Authorization Behavior
+## Default authorization behavior
 
 By default, `MastraAuthAuth0` validates Auth0 JWT tokens and allows access to all authenticated users:
 
@@ -50,7 +50,7 @@ By default, `MastraAuthAuth0` validates Auth0 JWT tokens and allows access to al
 
 If all validations pass, the user is considered authorized. To implement custom authorization logic (e.g., role-based access control), provide a custom `authorizeUser` function.
 
-## Auth0 User Type
+## Auth0 user type
 
 The `Auth0User` type used in the `authorizeUser` function corresponds to the decoded JWT token payload, which typically includes:
 

package/.docs/reference/auth/better-auth.md

@@ -1,4 +1,4 @@
-# MastraAuthBetterAuth Class
+# MastraAuthBetterAuth class
 
 The `MastraAuthBetterAuth` class provides authentication for Mastra applications using Better Auth. It verifies incoming requests with Better Auth sessions and integrates with the Mastra server using the `auth` option.
 
@@ -43,7 +43,7 @@ export const mastra = new Mastra({
 
 **protected** (`Array<string | RegExp | [string, Methods | Methods[]]>`): Protected routes that require authentication. Supports exact paths, wildcards, and path params.
 
-## BetterAuthUser Type
+## `BetterAuthUser` type
 
 The `BetterAuthUser` type contains the session and user information returned by Better Auth:
 

package/.docs/reference/auth/clerk.md

@@ -1,4 +1,4 @@
-# MastraAuthClerk Class
+# MastraAuthClerk class
 
 The `MastraAuthClerk` class provides authentication for Mastra applications using Clerk. It verifies incoming requests with Clerk-issued JWT tokens and integrates with the Mastra server using the `auth` option.
 

package/.docs/reference/auth/firebase.md

@@ -1,4 +1,4 @@
-# MastraAuthFirebase Class
+# MastraAuthFirebase class
 
 The `MastraAuthFirebase` class provides authentication for Mastra using Firebase Authentication. It verifies incoming requests using Firebase ID tokens and integrates with the Mastra server using the `auth` option.
 
@@ -44,7 +44,7 @@ export const mastra = new Mastra({
 
 **authorizeUser** (`(user: FirebaseUser) => Promise<boolean> | boolean`): Custom authorization function to determine if a user should be granted access. Called after token verification. By default, checks for the presence of a document in the 'user\_access' collection keyed by the user's UID.
 
-## Environment Variables
+## Environment variables
 
 The following environment variables are automatically used when constructor options aren't provided:
 
@@ -54,7 +54,7 @@ The following environment variables are automatically used when constructor opti
 
 **FIREBASE\_DATABASE\_ID** (`string`): Alternative environment variable for Firestore database ID. Used if FIRESTORE\_DATABASE\_ID is not set.
 
-## Default Authorization Behavior
+## Default authorization behavior
 
 By default, `MastraAuthFirebase` uses Firestore to manage user access:
 
@@ -63,7 +63,7 @@ By default, `MastraAuthFirebase` uses Firestore to manage user access:
 3. If the document exists, the user is authorized; otherwise, access is denied
 4. The Firestore database used is determined by the `databaseId` parameter or environment variables
 
-## Firebase User Type
+## Firebase user type
 
 The `FirebaseUser` type used in the `authorizeUser` function corresponds to Firebase's `DecodedIdToken` interface, which includes:
 

package/.docs/reference/auth/jwt.md

@@ -1,4 +1,4 @@
-# MastraJwtAuth Class
+# MastraJwtAuth class
 
 The `MastraJwtAuth` class provides a lightweight authentication mechanism for Mastra using JSON Web Tokens (JWTs). It verifies incoming requests based on a shared secret and integrates with the Mastra server using the `auth` option.
 

package/.docs/reference/auth/supabase.md

@@ -1,4 +1,4 @@
-# MastraAuthSupabase Class
+# MastraAuthSupabase class
 
 The `MastraAuthSupabase` class provides authentication for Mastra using Supabase Auth. It verifies incoming requests using Supabase's authentication system and integrates with the Mastra server using the `auth` option.
 

package/.docs/reference/auth/workos.md

@@ -1,4 +1,4 @@
-# MastraAuthWorkos Class
+# MastraAuthWorkos class
 
 The `MastraAuthWorkos` class provides authentication for Mastra using WorkOS. It verifies incoming requests using WorkOS access tokens and integrates with the Mastra server using the `auth` option.
 
@@ -30,7 +30,7 @@ export const mastra = new Mastra({
 
 **authorizeUser** (`(user: WorkosUser) => Promise<boolean> | boolean`): Custom authorization function to determine if a user should be granted access. Called after token verification. By default, checks if the user has an 'admin' role in any organization membership.
 
-## Environment Variables
+## Environment variables
 
 The following environment variables are automatically used when constructor options aren't provided:
 
@@ -38,7 +38,7 @@ The following environment variables are automatically used when constructor opti
 
 **WORKOS\_CLIENT\_ID** (`string`): Your WorkOS Client ID. Can be found in your WorkOS Dashboard under Applications.
 
-## Default Authorization Behavior
+## Default authorization behavior
 
 By default, `MastraAuthWorkos` implements role-based authorization that checks for admin access:
 
@@ -53,7 +53,7 @@ This means that by default, only users with admin privileges in at least one org
 
 To implement custom authorization logic (e.g., allow all authenticated users, check for specific roles, or implement custom business logic), provide a custom `authorizeUser` function.
 
-## WorkOS User Type
+## WorkOS user type
 
 The `WorkosUser` type used in the `authorizeUser` function corresponds to the JWT token payload returned by WorkOS. WorkOS allows administrators to set up custom JWT templates, so the exact structure may vary based on your configuration. Here's an example of what the user object might look like:
 

package/.docs/reference/cli/mastra.md

@@ -1,4 +1,4 @@
-# CLI Commands
+# CLI commands
 
 You can use the Command-Line Interface (CLI) provided by Mastra to develop, build, and start your Mastra project.
 

package/.docs/reference/client-js/agents.md

@@ -2,7 +2,7 @@
 
 The Agents API provides methods to interact with Mastra AI agents, including generating responses, streaming interactions, and managing agent tools.
 
-## Getting All Agents
+## Getting all agents
 
 Retrieve a list of all available agents:
 
@@ -12,7 +12,7 @@ const agents = await mastraClient.listAgents()
 
 Returns a record of agent IDs to their serialized agent configurations.
 
-## Working with a Specific Agent
+## Working with a specific agent
 
 Get an instance of a specific agent by its ID:
 
@@ -26,9 +26,9 @@ export const myAgent = new Agent({
 const agent = mastraClient.getAgent('my-agent')
 ```
 
-## Agent Methods
+## Agent methods
 
-### details()
+### `details()`
 
 Retrieve detailed information about an agent:
 
@@ -36,7 +36,7 @@ Retrieve detailed information about an agent:
 const details = await agent.details()
 ```
 
-### generate()
+### `generate()`
 
 Generate a response from the agent:
 
@@ -69,7 +69,7 @@ const response = await agent.generate('Hello, how are you?', {
 })
 ```
 
-### stream()
+### `stream()`
 
 Stream responses from the agent for real-time interactions:
 
@@ -151,7 +151,7 @@ for await (const part of uiMessageStream) {
 }
 ```
 
-### getTool()
+### `getTool()`
 
 Retrieve information about a specific tool available to the agent:
 
@@ -159,7 +159,7 @@ Retrieve information about a specific tool available to the agent:
 const tool = await agent.getTool('tool-id')
 ```
 
-### executeTool()
+### `executeTool()`
 
 Execute a specific tool for the agent:
 
@@ -169,7 +169,7 @@ const result = await agent.executeTool('tool-id', {
 })
 ```
 
-### network()
+### `network()`
 
 Stream responses from an agent network for multi-agent interactions:
 
@@ -183,7 +183,7 @@ response.processDataStream({
 })
 ```
 
-### approveToolCall()
+### `approveToolCall()`
 
 Approve a pending tool call that requires human confirmation:
 
@@ -200,7 +200,7 @@ response.processDataStream({
 })
 ```
 
-### declineToolCall()
+### `declineToolCall()`
 
 Decline a pending tool call that requires human confirmation:
 
@@ -217,7 +217,7 @@ response.processDataStream({
 })
 ```
 
-### approveToolCallGenerate()
+### `approveToolCallGenerate()`
 
 Approve a pending tool call when using `generate()` (non-streaming). Returns the complete response:
 
@@ -236,7 +236,7 @@ if (output.finishReason === 'suspended') {
 }
 ```
 
-### declineToolCallGenerate()
+### `declineToolCallGenerate()`
 
 Decline a pending tool call when using `generate()` (non-streaming). Returns the complete response:
 
@@ -255,7 +255,7 @@ if (output.finishReason === 'suspended') {
 }
 ```
 
-## Client Tools
+## Client tools
 
 Client-side tools allow you to execute custom functions on the client side when the agent requests them.
 
@@ -306,11 +306,11 @@ response.processDataStream({
 })
 ```
 
-## Stored Agents
+## Stored agents
 
 Stored agents are agent configurations stored in a database that can be created, updated, and deleted at runtime. They reference primitives (tools, workflows, other agents, memory, scorers) by key, which are resolved from the Mastra registry when the agent is instantiated.
 
-### listStoredAgents()
+### `listStoredAgents()`
 
 Retrieve a paginated list of all stored agents:
 
@@ -333,7 +333,7 @@ const result = await mastraClient.listStoredAgents({
 })
 ```
 
-### createStoredAgent()
+### `createStoredAgent()`
 
 Create a new stored agent:
 
@@ -380,7 +380,7 @@ const agent = await mastraClient.createStoredAgent({
 })
 ```
 
-### getStoredAgent()
+### `getStoredAgent()`
 
 Get an instance of a specific stored agent:
 
@@ -388,9 +388,9 @@ Get an instance of a specific stored agent:
 const storedAgent = mastraClient.getStoredAgent('my-agent')
 ```
 
-## Stored Agent Methods
+## Stored agent methods
 
-### details()
+### `details()`
 
 Retrieve the stored agent configuration:
 
@@ -401,7 +401,7 @@ console.log(details.instructions)
 console.log(details.model)
 ```
 
-### update()
+### `update()`
 
 Update specific fields of a stored agent. All fields are optional:
 
@@ -427,7 +427,7 @@ await storedAgent.update({
 })
 ```
 
-### delete()
+### `delete()`
 
 Delete a stored agent:
 

package/.docs/reference/client-js/error-handling.md

@@ -1,8 +1,8 @@
-# Error Handling
+# Error handling
 
 The Mastra Client SDK includes built-in retry mechanism and error handling capabilities.
 
-## Error Handling
+## Error handling
 
 All API methods can throw errors that you can catch and handle:
 

package/.docs/reference/client-js/logs.md

@@ -2,7 +2,7 @@
 
 The Logs API provides methods to access and query system logs and debugging information in Mastra.
 
-## Getting Logs
+## Getting logs
 
 Retrieve system logs with optional filtering:
 
@@ -12,7 +12,7 @@ const logs = await mastraClient.listLogs({
 })
 ```
 
-## Getting Logs for a Specific Run
+## Getting logs for a specific run
 
 Retrieve logs for a specific execution run:
 

package/.docs/reference/client-js/mastra-client.md

@@ -1,4 +1,4 @@
-# Mastra Client SDK
+# Mastra client SDK
 
 The Mastra Client SDK provides a type-safe interface for interacting with your [Mastra Server](https://mastra.ai/docs/deployment/mastra-server) from your client environment.
 

package/.docs/reference/client-js/memory.md

@@ -2,7 +2,7 @@
 
 The Memory API provides methods to manage conversation threads and message history in Mastra.
 
-## Get All Threads
+## Get all threads
 
 Retrieve all memory threads for a specific resource:
 
@@ -15,7 +15,7 @@ const threads = await mastraClient.getMemoryThreads({
 
 When `agentId` is omitted and storage is configured on the server, threads will be retrieved using storage directly. This is useful when multiple agents share the same threads (e.g., in workflows with multiple agent steps).
 
-## Create a New Thread
+## Create a new thread
 
 Create a new memory thread:
 
@@ -28,7 +28,7 @@ const thread = await mastraClient.createMemoryThread({
 })
 ```
 
-## Working with a Specific Thread
+## Working with a specific thread
 
 Get an instance of a specific memory thread:
 
@@ -36,7 +36,7 @@ Get an instance of a specific memory thread:
 const thread = mastraClient.getMemoryThread({ threadId: 'thread-id', agentId: 'agent-id' })
 ```
 
-## Thread Methods
+## Thread methods
 
 ### Get Thread Details
 
@@ -105,7 +105,7 @@ The clone response includes:
 - `thread`: The newly created cloned thread with clone metadata
 - `clonedMessages`: Array of the cloned messages with new IDs
 
-## Message Operations
+## Message operations
 
 ### Save Messages
 
@@ -168,7 +168,7 @@ const result = await thread.deleteMessages(['message-1', 'message-2', 'message-3
 // Returns: { success: true, message: "Message deleted successfully" }
 ```
 
-## Working Memory
+## Working memory
 
 Working memory allows agents to maintain persistent information about users across interactions. It can be scoped to either a specific thread or across all threads for a resource (user).
 

package/.docs/reference/client-js/observability.md

@@ -2,7 +2,7 @@
 
 The Observability API provides methods to retrieve traces, monitor your application's performance, and score traces for evaluation. This helps you understand how your AI agents and workflows are performing.
 
-## Getting a Specific Trace
+## Getting a specific trace
 
 Retrieve a specific trace by its ID, including all its spans and details:
 
@@ -10,7 +10,7 @@ Retrieve a specific trace by its ID, including all its spans and details:
 const trace = await mastraClient.getTrace('trace-id-123')
 ```
 
-## Getting Traces with Filtering
+## Getting traces with filtering
 
 Retrieve a paginated list of trace root spans with optional filtering:
 
@@ -39,7 +39,7 @@ console.log(`Total pages: ${traces.pagination.totalPages}`)
 const completeTrace = await mastraClient.getTrace(traces.spans[0].traceId)
 ```
 
-## Scoring Traces
+## Scoring traces
 
 Score specific traces using registered scorers for evaluation:
 
@@ -53,7 +53,7 @@ const result = await mastraClient.score({
 })
 ```
 
-## Getting Scores by Span
+## Getting scores by span
 
 Retrieve scores for a specific span within a trace:
 

package/.docs/reference/client-js/telemetry.md

@@ -2,7 +2,7 @@
 
 The Telemetry API provides methods to retrieve and analyze traces from your Mastra application. This helps you monitor and debug your application's behavior and performance.
 
-## Getting Traces
+## Getting traces
 
 Retrieve traces with optional filtering and pagination:
 

package/.docs/reference/client-js/tools.md

@@ -2,7 +2,7 @@
 
 The Tools API provides methods to interact with and execute tools available in the Mastra platform.
 
-## Getting All Tools
+## Getting all tools
 
 Retrieve a list of all available tools:
 
@@ -10,7 +10,7 @@ Retrieve a list of all available tools:
 const tools = await mastraClient.listTools()
 ```
 
-## Working with a Specific Tool
+## Working with a specific tool
 
 Get an instance of a specific tool:
 
@@ -18,7 +18,7 @@ Get an instance of a specific tool:
 const tool = mastraClient.getTool('tool-id')
 ```
 
-## Tool Methods
+## Tool methods
 
 ### Get Tool Details
 

package/.docs/reference/client-js/vectors.md

@@ -2,7 +2,7 @@
 
 The Vectors API provides methods to work with vector embeddings for semantic search and similarity matching in Mastra.
 
-## Working with Vectors
+## Working with vectors
 
 Get an instance of a vector store:
 
@@ -10,7 +10,7 @@ Get an instance of a vector store:
 const vector = mastraClient.getVector('vector-name')
 ```
 
-## Vector Methods
+## Vector methods
 
 ### Get Vector Index Details