@mastra/mcp-docs-server 1.2.4-alpha.1 → 1.2.4-alpha.6

package/.docs/reference/agents/generate.md

@@ -1,10 +1,10 @@
+> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
+
 # Agent.generate()
 
 The `.generate()` method enables non-streaming response generation from an agent with enhanced capabilities. It accepts messages and optional generation options.
 
-## Usage examples
-
-### Basic usage
+## Usage example
 
 Call the agent with a message to generate a response:
 
@@ -12,94 +12,6 @@ Call the agent with a message to generate a response:
 const result = await agent.generate('message for agent')
 ```
 
-### With model settings
-
-Example of limiting output tokens and setting temperature:
-
-```ts
-const limitedResult = await agent.generate('Write a short poem about coding', {
-  modelSettings: {
-    maxOutputTokens: 50,
-    temperature: 0.7,
-  },
-})
-```
-
-### With memory
-
-Give your agent access to conversation history and persistence by configuring memory options. This allows the agent to remember previous interactions and maintain context across messages.
-
-```ts
-const memoryResult = await agent.generate('Remember my favorite color is blue', {
-  memory: {
-    thread: 'user-123-thread',
-    resource: 'user-123',
-  },
-})
-```
-
-### Accessing response headers
-
-Some model providers return useful information in response headers, such as remaining token counts or rate limit status. You can access these headers from the result object after generation completes.
-
-```ts
-const result = await agent.generate('Hello!')
-const remainingRequests = result.response?.headers?.['anthropic-ratelimit-requests-remaining']
-const remainingTokens = result.response?.headers?.['x-ratelimit-remaining-tokens']
-console.log(`Remaining requests: ${remainingRequests}, Remaining tokens: ${remainingTokens}`)
-```
-
-### Analyzing images
-
-Agents can analyze and describe images by processing both the visual content and any text within them. To enable image analysis, pass an object with `type: 'image'` and the image URL in the `content` array. You can combine image content with text prompts to guide the agent's analysis.
-
-```typescript
-const response = await agent.generate([
-  {
-    role: 'user',
-    content: [
-      {
-        type: 'image',
-        image: 'https://placebear.com/cache/395-205.jpg',
-        mimeType: 'image/jpeg',
-      },
-      {
-        type: 'text',
-        text: 'Describe the image in detail, and extract all the text in the image.',
-      },
-    ],
-  },
-])
-
-console.log(response.text)
-```
-
-### Using `maxSteps`
-
-The `maxSteps` parameter controls the maximum number of sequential LLM calls an agent can make. Each step includes generating a response, executing any tool calls, and processing the result. Limiting steps helps prevent infinite loops, reduce latency, and control token usage for agents that use tools. The default is 5, but can be increased:
-
-```typescript
-const response = await agent.generate('Help me organize my day', {
-  maxSteps: 10,
-})
-
-console.log(response.text)
-```
-
-### Using `onStepFinish`
-
-You can monitor the progress of multi-step operations using the `onStepFinish` callback. This is useful for debugging or providing progress updates to users.
-
-`onStepFinish` is only available when streaming or generating text without structured output.
-
-```typescript
-const response = await agent.generate('Help me organize my day', {
-  onStepFinish: ({ text, toolCalls, toolResults, finishReason, usage }) => {
-    console.log({ text, toolCalls, toolResults, finishReason, usage })
-  },
-})
-```
-
 ## Parameters
 
 **messages** (`string | string[] | CoreMessage[] | AiMessageType[] | UIMessageWithMetadata[]`): The messages to send to the agent. Can be a single string, array of strings, or structured message objects.
@@ -454,4 +366,94 @@ For the streaming version of the same chunk shape, see the [ChunkType reference]
 
 **tripwire** (`StepTripwireData`): Tripwire data if content was blocked by a processor.
 
-**scoringData** (`object`): Scoring data for evals when \`returnScorerData\` is enabled.
+**scoringData** (`object`): Scoring data for evals when \`returnScorerData\` is enabled.
+
+## More examples
+
+### With model settings
+
+Example of limiting output tokens and setting temperature:
+
+```ts
+const limitedResult = await agent.generate('Write a short poem about coding', {
+  modelSettings: {
+    maxOutputTokens: 50,
+    temperature: 0.7,
+  },
+})
+```
+
+### With memory
+
+Give your agent access to conversation history and persistence by configuring memory options. This allows the agent to remember previous interactions and maintain context across messages.
+
+```ts
+const memoryResult = await agent.generate('Remember my favorite color is blue', {
+  memory: {
+    thread: 'user-123-thread',
+    resource: 'user-123',
+  },
+})
+```
+
+### Accessing response headers
+
+Some model providers return useful information in response headers, such as remaining token counts or rate limit status. You can access these headers from the result object after generation completes.
+
+```ts
+const result = await agent.generate('Hello!')
+const remainingRequests = result.response?.headers?.['anthropic-ratelimit-requests-remaining']
+const remainingTokens = result.response?.headers?.['x-ratelimit-remaining-tokens']
+console.log(`Remaining requests: ${remainingRequests}, Remaining tokens: ${remainingTokens}`)
+```
+
+### Analyzing images
+
+Agents can analyze and describe images by processing both the visual content and any text within them. To enable image analysis, pass an object with `type: 'image'` and the image URL in the `content` array. You can combine image content with text prompts to guide the agent's analysis.
+
+```typescript
+const response = await agent.generate([
+  {
+    role: 'user',
+    content: [
+      {
+        type: 'image',
+        image: 'https://placebear.com/cache/395-205.jpg',
+        mimeType: 'image/jpeg',
+      },
+      {
+        type: 'text',
+        text: 'Describe the image in detail, and extract all the text in the image.',
+      },
+    ],
+  },
+])
+
+console.log(response.text)
+```
+
+### Using `maxSteps`
+
+The `maxSteps` parameter controls the maximum number of sequential LLM calls an agent can make. Each step includes generating a response, executing any tool calls, and processing the result. Limiting steps helps prevent infinite loops, reduce latency, and control token usage for agents that use tools. The default is 5, but can be increased:
+
+```typescript
+const response = await agent.generate('Help me organize my day', {
+  maxSteps: 10,
+})
+
+console.log(response.text)
+```
+
+### Using `onStepFinish`
+
+You can monitor the progress of multi-step operations using the `onStepFinish` callback. This is useful for debugging or providing progress updates to users.
+
+`onStepFinish` is only available when streaming or generating text without structured output.
+
+```typescript
+const response = await agent.generate('Help me organize my day', {
+  onStepFinish: ({ text, toolCalls, toolResults, finishReason, usage }) => {
+    console.log({ text, toolCalls, toolResults, finishReason, usage })
+  },
+})
+```

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

@@ -1,3 +1,5 @@
+> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
+
 # Agent.generateLegacy() (Legacy)
 
 > **Warning:** **Deprecated**: This method is deprecated and only works with V1 models. For V2 models, use the new [`.generate()`](https://mastra.ai/reference/agents/generate) method instead.

package/.docs/reference/agents/getDefaultGenerateOptions.md

@@ -1,3 +1,5 @@
+> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
+
 # Agent.getDefaultGenerateOptionsLegacy()
 
 > **Warning:** **Deprecated**: This method is deprecated and only works with V1 models. For V2 models, use the new [`.getDefaultOptions()`](https://mastra.ai/reference/agents/getDefaultOptions) method instead.

package/.docs/reference/agents/getDefaultOptions.md

@@ -1,3 +1,5 @@
+> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
+
 # Agent.getDefaultOptions()
 
 Agents can be configured with default options for memory usage, output format, and iteration steps. The `.getDefaultOptions()` method returns these defaults, resolving them if they're functions. These options apply to all `stream()` and `generate()` calls unless overridden and are useful for inspecting an agent’s unknown defaults.

package/.docs/reference/agents/getDefaultStreamOptions.md

@@ -1,3 +1,5 @@
+> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
+
 # Agent.getDefaultStreamOptionsLegacy()
 
 > **Warning:** **Deprecated**: This method is deprecated and only works with V1 models. For V2 models, use the new [`.getDefaultOptions()`](https://mastra.ai/reference/agents/getDefaultOptions) method instead.

package/.docs/reference/agents/getDescription.md

@@ -1,3 +1,5 @@
+> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
+
 # Agent.getDescription()
 
 The `.getDescription()` method retrieves the description configured for an agent. This method returns a string description that describes the agent's purpose and capabilities.

package/.docs/reference/agents/getInstructions.md

@@ -1,3 +1,5 @@
+> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
+
 # Agent.getInstructions()
 
 The `.getInstructions()` method retrieves the instructions configured for an agent, resolving them if they're a function. These instructions guide the agent's behavior and define its capabilities and constraints.

package/.docs/reference/agents/getLLM.md

@@ -1,3 +1,5 @@
+> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
+
 # Agent.getLLM()
 
 The `.getLLM()` method retrieves the language model instance configured for an agent, resolving it if it's a function. You can also pass a request-scoped `model` override without mutating the agent's configured model.

package/.docs/reference/agents/getMemory.md

@@ -1,3 +1,5 @@
+> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
+
 # Agent.getMemory()
 
 The `.getMemory()` method retrieves the memory system associated with an agent. This method is used to access the agent's memory capabilities for storing and retrieving information across conversations.

package/.docs/reference/agents/getMetadata.md

@@ -1,3 +1,5 @@
+> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
+
 # Agent.getMetadata()
 
 The `.getMetadata()` method retrieves the metadata configured for an agent, resolving it if it's a function. Use metadata to classify agents in clients without encoding that data in the agent ID or name.

package/.docs/reference/agents/getModel.md

@@ -1,3 +1,5 @@
+> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
+
 # Agent.getModel()
 
 The `.getModel()` method retrieves the language model configured for an agent, resolving it if it's a function. This method is used to access the underlying model that powers the agent's capabilities.

package/.docs/reference/agents/getSkill.md

@@ -1,3 +1,5 @@
+> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
+
 # `.getSkill()`
 
 Retrieves a specific skill by name from the agent's configured skills (both agent-level and workspace skills).

package/.docs/reference/agents/getTools.md

@@ -1,3 +1,5 @@
+> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
+
 # Agent.getTools()
 
 The `.getTools()` 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.

package/.docs/reference/agents/getVoice.md

@@ -1,3 +1,5 @@
+> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
+
 # Agent.getVoice()
 
 The `.getVoice()` method retrieves the voice provider configured for an agent, resolving it if it's a function. This method is used to access the agent's speech capabilities for text-to-speech and speech-to-text functionality.

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

@@ -1,3 +1,5 @@
+> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
+
 # `createInngestAgent()`
 
 `createInngestAgent()` wraps an existing [`Agent`](https://mastra.ai/reference/agents/agent) with [Inngest](https://www.inngest.com/docs)-powered durable execution. Like [`createDurableAgent()`](https://mastra.ai/reference/agents/durable-agent), it streams events over [PubSub](https://mastra.ai/docs/server/pubsub) and supports resumable streams, but runs the agentic loop on Inngest's execution engine instead of in-process. Use it when a run must survive process restarts or run in a distributed environment.

package/.docs/reference/agents/listAgents.md

@@ -1,3 +1,5 @@
+> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
+
 # Agent.listAgents()
 
 The `.listAgents()` method retrieves the subagents configured for an agent, resolving them if they're a function. These subagents enable the agent to access other agents and perform complex actions.

package/.docs/reference/agents/listScorers.md

@@ -1,3 +1,5 @@
+> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
+
 # 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.

package/.docs/reference/agents/listSkills.md

@@ -1,3 +1,5 @@
+> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
+
 # `.listSkills()`
 
 Returns metadata for all skills available to the agent, including both agent-level and workspace skills.

package/.docs/reference/agents/listSuspendedRuns.md

@@ -1,3 +1,5 @@
+> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
+
 # Agent.listSuspendedRuns()
 
 **Added in:** `@mastra/core@1.43.0`

package/.docs/reference/agents/listTools.md

@@ -1,3 +1,5 @@
+> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
+
 # 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.

package/.docs/reference/agents/listWorkflows.md

@@ -1,3 +1,5 @@
+> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
+
 # 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.

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

@@ -1,3 +1,5 @@
+> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
+
 # Agent.network()
 
 The `.network()` method enables multi-agent collaboration and routing. This method accepts messages and optional execution options.

package/.docs/reference/ai-sdk/chat-route.md

@@ -1,3 +1,5 @@
+> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
+
 # chatRoute()
 
 Creates a chat route handler for streaming agent conversations using the AI SDK format. This function registers an HTTP `POST` endpoint that accepts messages, executes an agent, and streams the response back to the client in AI SDK-compatible format. You have to use it inside a [custom API route](https://mastra.ai/docs/server/custom-api-routes).

package/.docs/reference/ai-sdk/handle-chat-stream.md

@@ -1,3 +1,5 @@
+> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
+
 # handleChatStream()
 
 Framework-agnostic handler for streaming agent chat in AI SDK-compatible format. Use this function directly when you need to handle chat streaming outside Hono or Mastra's own [apiRoutes](https://mastra.ai/docs/server/custom-api-routes) feature.

package/.docs/reference/ai-sdk/handle-network-stream.md

@@ -1,3 +1,5 @@
+> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
+
 # handleNetworkStream()
 
 > **Deprecated:** Agent networks are deprecated and will be removed in a future release. Use [supervisor agents](https://mastra.ai/docs/agents/supervisor-agents) with `agent.stream()` or `agent.generate()` instead. See the [migration guide](https://mastra.ai/guides/migrations/network-to-supervisor) to upgrade.

package/.docs/reference/ai-sdk/handle-workflow-stream.md

@@ -1,3 +1,5 @@
+> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
+
 # handleWorkflowStream()
 
 Framework-agnostic handler for streaming workflow execution in AI SDK-compatible format. Use this function directly when you need to handle workflow streaming outside Hono or Mastra's own [apiRoutes](https://mastra.ai/docs/server/custom-api-routes) feature.

package/.docs/reference/ai-sdk/network-route.md

@@ -1,3 +1,5 @@
+> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
+
 # networkRoute()
 
 > **Deprecated:** Agent networks are deprecated and will be removed in a future release. Use [supervisor agents](https://mastra.ai/docs/agents/supervisor-agents) with `agent.stream()` or `agent.generate()` instead. See the [migration guide](https://mastra.ai/guides/migrations/network-to-supervisor) to upgrade.

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

@@ -1,3 +1,5 @@
+> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
+
 # toAISdkMessages()
 
 Converts messages from various input formats to AI SDK UI message format. `toAISdkMessages()` keeps the existing AI SDK v5/default behavior. If your app is typed against AI SDK v6, pass `version: 'v6'`.

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

@@ -1,3 +1,5 @@
+> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
+
 # toAISdkStream()
 
 Converts Mastra streams (agent, network, or workflow) to AI SDK-compatible streams. Use this function when you need to manually transform Mastra streams for use with AI SDK's `createUIMessageStream()` and `createUIMessageStreamResponse()`.

package/.docs/reference/ai-sdk/to-ai-sdk-v4-messages.md

@@ -1,3 +1,5 @@
+> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
+
 # toAISdkV4Messages()
 
 Converts messages from various input formats to AI SDK V4 UI message format. This function accepts messages in multiple formats (strings, AI SDK V4/V5 messages, Mastra DB messages, etc.) and normalizes them to the AI SDK V4 `UIMessage` format, which is suitable for use with AI SDK UI components like `useChat()`.

package/.docs/reference/ai-sdk/to-ai-sdk-v5-messages.md

@@ -1,3 +1,5 @@
+> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
+
 # toAISdkV5Messages()
 
 Converts messages from various input formats to AI SDK V5 (and later) UI message format. This function accepts messages in multiple formats (strings, AI SDK V4/V5 messages, Mastra DB messages, etc.) and normalizes them to the AI SDK V5+ `UIMessage` format, which is suitable for use with AI SDK UI components like `useChat()`.

package/.docs/reference/ai-sdk/with-mastra.md

@@ -1,3 +1,5 @@
+> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
+
 # withMastra()
 
 Wraps an AI SDK model with Mastra processors and/or memory.

package/.docs/reference/ai-sdk/workflow-route.md

@@ -1,3 +1,5 @@
+> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
+
 # workflowRoute()
 
 Creates a workflow route handler for streaming workflow execution using the AI SDK format. This function registers an HTTP `POST` endpoint that accepts input data, executes a workflow, and streams the response back to the client in AI SDK-compatible format. You have to use it inside a [custom API route](https://mastra.ai/docs/server/custom-api-routes).

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

@@ -1,3 +1,5 @@
+> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
+
 # workflowSnapshotToStream()
 
 Converts a `WorkflowState` object (as returned by `workflow.getWorkflowRunById()`) into a `ReadableStream` of AI SDK UIMessage data parts. The stream contains the same `WorkflowDataPart` and `WorkflowStepDataPart` chunks that the live [`workflowRoute()`](https://mastra.ai/reference/ai-sdk/workflow-route) produces.

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

@@ -1,3 +1,5 @@
+> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
+
 # 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.

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

@@ -1,3 +1,5 @@
+> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
+
 # 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.

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

@@ -1,3 +1,5 @@
+> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
+
 # 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,3 +1,5 @@
+> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
+
 # 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.

package/.docs/reference/auth/google.md

@@ -1,3 +1,5 @@
+> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
+
 # MastraAuthGoogle & MastraRBACGoogle class
 
 ## MastraAuthGoogle class

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

@@ -1,3 +1,5 @@
+> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
+
 # 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/okta.md

@@ -1,3 +1,5 @@
+> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
+
 # MastraAuthOkta & MastraRBACOkta class
 
 ## MastraAuthOkta class

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

@@ -1,3 +1,5 @@
+> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
+
 # 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,3 +1,5 @@
+> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
+
 # 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.

package/.docs/reference/browser/agent-browser.md

@@ -1,3 +1,5 @@
+> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
+
 # AgentBrowser class
 
 The `AgentBrowser` class provides deterministic browser automation using the [agent-browser](https://github.com/vercel-labs/agent-browser) library. It uses accessibility tree snapshots and element refs (e.g., `@e5`) for precise, reproducible interactions.

package/.docs/reference/browser/browser-viewer.md

@@ -1,3 +1,5 @@
+> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
+
 # BrowserViewer
 
 The `BrowserViewer` class provides browser automation for CLI-based tools. It launches Chrome via Playwright, exposes a Chrome DevTools Protocol (CDP) URL, and automatically injects it into CLI commands run through workspace tools.

package/.docs/reference/browser/mastra-browser.md

@@ -1,3 +1,5 @@
+> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
+
 # MastraBrowser class
 
 The `MastraBrowser` class is the abstract base class for browser automation providers. It defines the common interface for launching browsers, managing thread isolation, streaming screencasts, and handling input events.

package/.docs/reference/browser/stagehand-browser.md

@@ -1,3 +1,5 @@
+> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
+
 # StagehandBrowser class
 
 The `StagehandBrowser` class provides AI-powered browser automation using [Stagehand](https://github.com/browserbase/stagehand). It uses natural language instructions for interactions instead of element refs.

package/.docs/reference/channels/channel-provider.md

@@ -1,3 +1,5 @@
+> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
+
 # ChannelProvider
 
 `ChannelProvider` is the interface that platform integrations implement to connect agents to a messaging platform. A provider owns the full lifecycle of an integration: app provisioning and OAuth, webhook routing and event handling, adapter creation and agent wiring, and credential management.

package/.docs/reference/channels/slack-provider.md

@@ -1,3 +1,5 @@
+> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
+
 # SlackProvider
 
 `SlackProvider` is the managed path for connecting agents to Slack. Register it on `Mastra.channels` and it provisions Slack apps via the Manifest API, runs the OAuth install flow, rotates configuration tokens, and routes Slack events to your agents. Use it when you want Mastra to own app creation and installation. For the lower-level path where you create the Slack app and configure scopes and webhooks yourself, use [`createSlackAdapter`](https://mastra.ai/docs/agents/channels) on the agent's `channels.adapters` instead.

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

@@ -1,3 +1,5 @@
+> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
+
 # create-mastra
 
 The `create-mastra` command **creates** a new standalone Mastra project. Use this command to scaffold a complete Mastra setup in a dedicated directory. You can run it with additional flags to customize the setup process.

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

@@ -1,3 +1,5 @@
+> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
+
 # 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/agent-builder.md

@@ -1,3 +1,5 @@
+> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
+
 # Agent Builder API
 
 The Agent Builder API provides methods to interact with [Agent Builder](https://mastra.ai/docs/agent-builder/overview) actions on the server. Each action is a workflow exposed under `/agent-builder/:actionId/*`. The Builder must be enabled on the server via `MastraEditor.builder.enabled`, with a valid `MASTRA_EE_LICENSE` in production.

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

@@ -1,3 +1,5 @@
+> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
+
 # Agents API
 
 The Agents API provides methods to interact with Mastra AI agents, including generating responses, streaming interactions, and managing agent tools.

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

@@ -1,3 +1,5 @@
+> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
+
 # OpenAI Responses API Conversations
 
 The OpenAI Responses API Conversations surface gives you the conversation-management side of Mastra Agents as a Responses API. It provides methods to create, retrieve, delete, and inspect thread-backed conversations in Mastra.

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

@@ -1,3 +1,5 @@
+> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
+
 # Error handling
 
 The Mastra Client SDK includes built-in retry mechanism and error handling capabilities.

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

@@ -1,3 +1,5 @@
+> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
+
 # Logs API
 
 The Logs API provides methods to access and query system logs and debugging information in Mastra.

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

@@ -1,3 +1,5 @@
+> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
+
 # 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

@@ -1,3 +1,5 @@
+> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
+
 # Memory API
 
 The Memory API provides methods to manage conversation threads and message history in Mastra.

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

@@ -1,3 +1,5 @@
+> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
+
 # Observability API
 
 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.