@mastra/core 1.7.0 → 1.8.0

package/dist/docs/references/reference-workspace-sandbox.md

@@ -0,0 +1,87 @@
+# WorkspaceSandbox
+
+**Added in:** `@mastra/core@1.1.0`
+
+The `WorkspaceSandbox` interface defines how workspaces execute commands.
+
+## Methods
+
+### `start()`
+
+Start the sandbox. Called automatically by `workspace.init()` or on first `executeCommand()` call.
+
+```typescript
+await sandbox.start()
+```
+
+This method prepares the sandbox for command execution.
+
+### `stop()`
+
+Stop the sandbox.
+
+```typescript
+await sandbox.stop?.()
+```
+
+### `destroy()`
+
+Clean up sandbox resources. Called by `workspace.destroy()`.
+
+```typescript
+await sandbox.destroy()
+```
+
+### `executeCommand(command, args?, options?)`
+
+Execute a shell command.
+
+```typescript
+const result = await sandbox.executeCommand('ls', ['-la', '/docs'])
+const result = await sandbox.executeCommand('npm', ['install', 'lodash'])
+```
+
+**Parameters:**
+
+**command:** (`string`): Command to execute
+
+**args?:** (`string[]`): Command arguments
+
+**options.timeout?:** (`number`): Execution timeout in milliseconds
+
+**options.cwd?:** (`string`): Working directory for the command
+
+**options.env?:** (`Record<string, string>`): Additional environment variables
+
+**options.onStdout?:** (`(data: string) => void`): Callback for stdout streaming
+
+**options.onStderr?:** (`(data: string) => void`): Callback for stderr streaming
+
+### `getInfo()`
+
+Get sandbox status and resource information.
+
+```typescript
+const info = await sandbox.getInfo()
+// { status: 'running', resources: { memoryMB: 512, cpuPercent: 5 } }
+```
+
+### `getInstructions(opts?)`
+
+Returns a description of how this sandbox works. Injected into the agent's system message when the workspace is assigned to an agent.
+
+```typescript
+const instructions = sandbox.getInstructions?.()
+// 'Local command execution. Working directory: "/workspace".'
+```
+
+**Parameters:**
+
+**opts.requestContext?:** (`RequestContext`): Forwarded to the \`instructions\` function if one was provided in the constructor.
+
+**Returns:** `string`
+
+## Related
+
+- [Workspace Class](https://mastra.ai/reference/workspace/workspace-class)
+- [Filesystem Interface](https://mastra.ai/reference/workspace/filesystem)

package/dist/docs/references/reference-workspace-workspace-class.md

@@ -0,0 +1,244 @@
+# Workspace Class
+
+**Added in:** `@mastra/core@1.1.0`
+
+The `Workspace` class combines a filesystem and sandbox to provide agents with file storage and command execution capabilities. It also supports BM25 and vector search for indexed content.
+
+## Usage Example
+
+```typescript
+import { Workspace, LocalFilesystem, LocalSandbox } from '@mastra/core/workspace'
+
+const workspace = new Workspace({
+  id: 'my-workspace',
+  name: 'My Workspace',
+  filesystem: new LocalFilesystem({
+    basePath: './workspace',
+  }),
+  sandbox: new LocalSandbox({
+    workingDirectory: './workspace',
+  }),
+  bm25: true,
+  autoIndexPaths: ['/docs'],
+})
+```
+
+## Constructor parameters
+
+**id?:** (`string`): Unique identifier for the workspace (Default: `Auto-generated`)
+
+**name?:** (`string`): Human-readable name (Default: `workspace-{id}`)
+
+**filesystem?:** (`WorkspaceFilesystem`): Filesystem provider instance (e.g., LocalFilesystem)
+
+**sandbox?:** (`WorkspaceSandbox`): Sandbox provider instance (e.g., LocalSandbox)
+
+**bm25?:** (`boolean | BM25Config`): Enable BM25 keyword search. Pass true for defaults or a config object. (Default: `undefined`)
+
+**vectorStore?:** (`MastraVector`): Vector store for semantic search
+
+**embedder?:** (`(text: string) => Promise<number[]>`): Embedder function for generating vectors. Required when vectorStore is provided.
+
+**autoIndexPaths?:** (`string[]`): Paths or glob patterns to auto-index on init(). Supports glob patterns like '\*\*/\*.md' for selective indexing.
+
+**skills?:** (`string[] | ((context: SkillsContext) => string[] | Promise<string[]>)`): Paths where SKILL.md files are located. This can be a static array or an async function that resolves paths dynamically. Supports glob patterns like './\*\*/skills' for discovery.
+
+**skillSource?:** (`SkillSource`): Custom skill source for skill discovery. When provided, this source is used instead of the workspace filesystem. Use VersionedSkillSource to serve published skill versions from a content-addressable blob store.
+
+**onMount?:** (`OnMountHook`): Pre-mount hook called for each filesystem before mounting into a sandbox. Return false to skip mounting, or return { success: true } if the hook handled the mount. Return undefined to use the default mount behavior.
+
+**searchIndexName?:** (`string`): Custom index name for the vector store. Must be a valid SQL identifier (start with a letter or underscore, contain only letters, numbers, or underscores, max 63 characters). Defaults to a sanitized version of '{id}\_search'.
+
+**tools?:** (`WorkspaceToolsConfig`): Per-tool configuration for enabling tools and setting safety options
+
+**operationTimeout?:** (`number`): Timeout for operations in milliseconds
+
+## Tool configuration
+
+The `tools` option accepts a `WorkspaceToolsConfig` object that controls which workspace tools are enabled and their safety settings.
+
+```typescript
+import { WORKSPACE_TOOLS } from '@mastra/core/workspace';
+
+tools: {
+  // Global defaults (apply to all tools)
+  enabled: true,
+  requireApproval: false,
+
+  // Per-tool overrides using WORKSPACE_TOOLS constants
+  [WORKSPACE_TOOLS.FILESYSTEM.WRITE_FILE]: {
+    requireApproval: true,
+  },
+}
+```
+
+The config object has two parts:
+
+- **Global defaults** (`enabled`, `requireApproval`) - Apply to all tools unless overridden
+- **Per-tool overrides** - Use `WORKSPACE_TOOLS` constants as keys to configure individual tools
+
+See [workspace overview](https://mastra.ai/docs/workspace/overview) for more examples.
+
+### Per-tool options
+
+Each tool can be configured with these options:
+
+**enabled?:** (`boolean`): Whether the tool is available to agents (Default: `true`)
+
+**requireApproval?:** (`boolean`): Whether the tool requires user approval before execution (Default: `false`)
+
+**requireReadBeforeWrite?:** (`boolean`): For write tools: require reading the file first to prevent overwrites (Default: `false`)
+
+## Properties
+
+**id:** (`string`): Workspace identifier
+
+**name:** (`string`): Workspace name
+
+**status:** (`WorkspaceStatus`): 'pending' | 'initializing' | 'ready' | 'paused' | 'error' | 'destroying' | 'destroyed'
+
+**filesystem:** (`WorkspaceFilesystem | undefined`): The filesystem provider
+
+**sandbox:** (`WorkspaceSandbox | undefined`): The sandbox provider
+
+**skills:** (`WorkspaceSkills | undefined`): Skills interface for accessing SKILL.md files
+
+**canBM25:** (`boolean`): Whether BM25 search is available
+
+**canVector:** (`boolean`): Whether vector search is available
+
+**canHybrid:** (`boolean`): Whether hybrid search is available
+
+## Methods
+
+### Lifecycle
+
+#### `init()`
+
+Initialize the workspace and prepare resources.
+
+```typescript
+await workspace.init()
+```
+
+Calling `init()` is optional in most cases:
+
+- **Sandbox**: Auto-starts on first `executeCommand()` call. Use `init()` to avoid first-command latency.
+- **Filesystem**: Creates the base directory and runs any provider-specific setup. Some providers auto-create the directory on first operation.
+- **Search**: Required only if using `autoIndexPaths` for auto-indexing.
+
+Initialization performs:
+
+- Starts the filesystem provider (creates base directory if needed)
+- Starts the sandbox provider (creates working directory, sets up isolation if configured)
+- Indexes files from `autoIndexPaths` for search
+
+#### `destroy()`
+
+Destroy the workspace and clean up resources.
+
+```typescript
+await workspace.destroy()
+```
+
+### Search operations
+
+#### `index(path, content, options?)`
+
+Index content for search.
+
+```typescript
+await workspace.index('/docs/guide.md', 'Guide content...')
+```
+
+#### `search(query, options?)`
+
+Search indexed content.
+
+```typescript
+const results = await workspace.search('password reset', {
+  topK: 10,
+  mode: 'hybrid',
+})
+```
+
+### Utility
+
+#### `getInfo()`
+
+Get workspace information.
+
+```typescript
+const info = await workspace.getInfo()
+// { id, name, status, createdAt, lastAccessedAt, filesystem?, sandbox? }
+```
+
+#### `getInstructions(opts?)`
+
+Returns combined instructions from the filesystem and sandbox providers. Injected into the agent's system message to help it understand the execution context.
+
+```typescript
+const instructions = workspace.getInstructions()
+```
+
+Pass `requestContext` to enable per-request customization when a provider's `instructions` option is a function:
+
+```typescript
+const instructions = workspace.getInstructions({ requestContext })
+```
+
+**Parameters:**
+
+**opts.requestContext?:** (`RequestContext`): Forwarded to the \`instructions\` function on the filesystem or sandbox provider, if one is configured.
+
+**Returns:** `string`
+
+To override the default output, pass an `instructions` option to [LocalFilesystem](https://mastra.ai/reference/workspace/local-filesystem) or [LocalSandbox](https://mastra.ai/reference/workspace/local-sandbox).
+
+#### `getToolsConfig()`
+
+Get the tools configuration.
+
+```typescript
+const config = workspace.getToolsConfig()
+```
+
+## Agent tools
+
+A workspace provides tools to agents based on what is configured.
+
+### Filesystem tools
+
+Added when a filesystem is configured:
+
+| Tool                          | Description                                                                                                         |
+| ----------------------------- | ------------------------------------------------------------------------------------------------------------------- |
+| `mastra_workspace_read_file`  | Read file contents. Supports optional line range for reading specific portions of large files.                      |
+| `mastra_workspace_write_file` | Create or overwrite a file with new content. Creates parent directories automatically.                              |
+| `mastra_workspace_edit_file`  | Edit an existing file by finding and replacing text. Useful for targeted changes without rewriting the entire file. |
+| `mastra_workspace_list_files` | List directory contents as a tree structure. Supports recursive listing with depth limits.                          |
+| `mastra_workspace_delete`     | Delete a file or directory. Supports recursive deletion for directories.                                            |
+| `mastra_workspace_file_stat`  | Get metadata about a file or directory including size, type, and modification time.                                 |
+| `mastra_workspace_mkdir`      | Create a directory. Creates parent directories automatically if they don't exist.                                   |
+| `mastra_workspace_grep`       | Search file contents using regex patterns. Supports glob filtering, context lines, and case-insensitive search.     |
+
+Write tools (`write_file`, `edit_file`, `delete`, `mkdir`) are excluded when the filesystem is in read-only mode.
+
+### Sandbox tools
+
+Added when a sandbox is configured:
+
+| Tool                               | Description                                                                                                            |
+| ---------------------------------- | ---------------------------------------------------------------------------------------------------------------------- |
+| `mastra_workspace_execute_command` | Execute a shell command with arguments. Returns stdout, stderr, and exit code. Supports timeouts and streaming output. |
+
+### Search tools
+
+Added when BM25 or vector search is configured:
+
+| Tool                      | Description                                                                                                           |
+| ------------------------- | --------------------------------------------------------------------------------------------------------------------- |
+| `mastra_workspace_search` | Search indexed content using keyword (BM25), semantic (vector), or hybrid search. Returns ranked results with scores. |
+| `mastra_workspace_index`  | Index content for search. Associates content with a path for later retrieval.                                         |
+
+The `index` tool is excluded when the filesystem is in read-only mode.

package/dist/docs/references/reference.md

@@ -0,0 +1,277 @@
+# Reference
+
+The Reference section provides documentation of Mastra's API, including parameters, types and usage examples.
+
+- [Agent Class](https://mastra.ai/reference/agents/agent)
+- [.generate()](https://mastra.ai/reference/agents/generate)
+- [.generateLegacy()](https://mastra.ai/reference/agents/generateLegacy)
+- [.getDefaultGenerateOptionsLegacy()](https://mastra.ai/reference/agents/getDefaultGenerateOptions)
+- [.getDefaultOptions()](https://mastra.ai/reference/agents/getDefaultOptions)
+- [.getDefaultStreamOptionsLegacy()](https://mastra.ai/reference/agents/getDefaultStreamOptions)
+- [.getDescription()](https://mastra.ai/reference/agents/getDescription)
+- [.getInstructions()](https://mastra.ai/reference/agents/getInstructions)
+- [.getLLM()](https://mastra.ai/reference/agents/getLLM)
+- [.getMemory()](https://mastra.ai/reference/agents/getMemory)
+- [.getModel()](https://mastra.ai/reference/agents/getModel)
+- [.getTools()](https://mastra.ai/reference/agents/getTools)
+- [.getVoice()](https://mastra.ai/reference/agents/getVoice)
+- [.listAgents()](https://mastra.ai/reference/agents/listAgents)
+- [.listScorers()](https://mastra.ai/reference/agents/listScorers)
+- [.listTools()](https://mastra.ai/reference/agents/listTools)
+- [.listWorkflows()](https://mastra.ai/reference/agents/listWorkflows)
+- [.network()](https://mastra.ai/reference/agents/network)
+- [chatRoute()](https://mastra.ai/reference/ai-sdk/chat-route)
+- [handleChatStream()](https://mastra.ai/reference/ai-sdk/handle-chat-stream)
+- [handleNetworkStream()](https://mastra.ai/reference/ai-sdk/handle-network-stream)
+- [handleWorkflowStream()](https://mastra.ai/reference/ai-sdk/handle-workflow-stream)
+- [networkRoute()](https://mastra.ai/reference/ai-sdk/network-route)
+- [toAISdkStream()](https://mastra.ai/reference/ai-sdk/to-ai-sdk-stream)
+- [toAISdkV4Messages()](https://mastra.ai/reference/ai-sdk/to-ai-sdk-v4-messages)
+- [toAISdkV5Messages()](https://mastra.ai/reference/ai-sdk/to-ai-sdk-v5-messages)
+- [withMastra()](https://mastra.ai/reference/ai-sdk/with-mastra)
+- [workflowRoute()](https://mastra.ai/reference/ai-sdk/workflow-route)
+- [Auth0](https://mastra.ai/reference/auth/auth0)
+- [Better Auth](https://mastra.ai/reference/auth/better-auth)
+- [Clerk](https://mastra.ai/reference/auth/clerk)
+- [Firebase](https://mastra.ai/reference/auth/firebase)
+- [JSON Web Token](https://mastra.ai/reference/auth/jwt)
+- [Supabase](https://mastra.ai/reference/auth/supabase)
+- [WorkOS](https://mastra.ai/reference/auth/workos)
+- [create-mastra](https://mastra.ai/reference/cli/create-mastra)
+- [mastra](https://mastra.ai/reference/cli/mastra)
+- [Agents API](https://mastra.ai/reference/client-js/agents)
+- [Error Handling](https://mastra.ai/reference/client-js/error-handling)
+- [Logs API](https://mastra.ai/reference/client-js/logs)
+- [Mastra Client SDK](https://mastra.ai/reference/client-js/mastra-client)
+- [Memory API](https://mastra.ai/reference/client-js/memory)
+- [Observability API](https://mastra.ai/reference/client-js/observability)
+- [Telemetry API](https://mastra.ai/reference/client-js/telemetry)
+- [Tools API](https://mastra.ai/reference/client-js/tools)
+- [Vectors API](https://mastra.ai/reference/client-js/vectors)
+- [Workflows API](https://mastra.ai/reference/client-js/workflows)
+- [Mastra Class](https://mastra.ai/reference/core/mastra-class)
+- [MastraModelGateway](https://mastra.ai/reference/core/mastra-model-gateway)
+- [.addGateway()](https://mastra.ai/reference/core/addGateway)
+- [.getAgent()](https://mastra.ai/reference/core/getAgent)
+- [.getAgentById()](https://mastra.ai/reference/core/getAgentById)
+- [.getDeployer()](https://mastra.ai/reference/core/getDeployer)
+- [.getGateway()](https://mastra.ai/reference/core/getGateway)
+- [.getGatewayById()](https://mastra.ai/reference/core/getGatewayById)
+- [.getLogger()](https://mastra.ai/reference/core/getLogger)
+- [.getMCPServer()](https://mastra.ai/reference/core/getMCPServer)
+- [.getMCPServerById()](https://mastra.ai/reference/core/getMCPServerById)
+- [.getMemory()](https://mastra.ai/reference/core/getMemory)
+- [.getScorer()](https://mastra.ai/reference/core/getScorer)
+- [.getScorerById()](https://mastra.ai/reference/core/getScorerById)
+- [.getServer()](https://mastra.ai/reference/core/getServer)
+- [.getStorage()](https://mastra.ai/reference/core/getStorage)
+- [.getStoredAgentById()](https://mastra.ai/reference/core/getStoredAgentById)
+- [.getTelemetry()](https://mastra.ai/reference/core/getTelemetry)
+- [.getVector()](https://mastra.ai/reference/core/getVector)
+- [.getWorkflow()](https://mastra.ai/reference/core/getWorkflow)
+- [.listAgents()](https://mastra.ai/reference/core/listAgents)
+- [.listGateways()](https://mastra.ai/reference/core/listGateways)
+- [.listLogs()](https://mastra.ai/reference/core/listLogs)
+- [.listLogsByRunId()](https://mastra.ai/reference/core/listLogsByRunId)
+- [.listMCPServers()](https://mastra.ai/reference/core/listMCPServers)
+- [.listMemory()](https://mastra.ai/reference/core/listMemory)
+- [.listScorers()](https://mastra.ai/reference/core/listScorers)
+- [.listStoredAgents()](https://mastra.ai/reference/core/listStoredAgents)
+- [.listVectors()](https://mastra.ai/reference/core/listVectors)
+- [.listWorkflows()](https://mastra.ai/reference/core/listWorkflows)
+- [.setLogger()](https://mastra.ai/reference/core/setLogger)
+- [.setStorage()](https://mastra.ai/reference/core/setStorage)
+- [Cloudflare](https://mastra.ai/reference/deployer/cloudflare)
+- [Deployer](https://mastra.ai/reference/deployer)
+- [Netlify](https://mastra.ai/reference/deployer/netlify)
+- [Vercel](https://mastra.ai/reference/deployer/vercel)
+- [Answer Relevancy Scorer](https://mastra.ai/reference/evals/answer-relevancy)
+- [Answer Similarity Scorer](https://mastra.ai/reference/evals/answer-similarity)
+- [Bias](https://mastra.ai/reference/evals/bias)
+- [Completeness](https://mastra.ai/reference/evals/completeness)
+- [Content Similarity Scorer](https://mastra.ai/reference/evals/content-similarity)
+- [Context Precision Scorer](https://mastra.ai/reference/evals/context-precision)
+- [Context Relevance Scorer](https://mastra.ai/reference/evals/context-relevance)
+- [createScorer()](https://mastra.ai/reference/evals/create-scorer)
+- [Faithfulness](https://mastra.ai/reference/evals/faithfulness)
+- [Hallucination](https://mastra.ai/reference/evals/hallucination)
+- [Keyword Coverage Scorer](https://mastra.ai/reference/evals/keyword-coverage)
+- [MastraScorer](https://mastra.ai/reference/evals/mastra-scorer)
+- [Noise Sensitivity Scorer](https://mastra.ai/reference/evals/noise-sensitivity)
+- [Prompt Alignment Scorer](https://mastra.ai/reference/evals/prompt-alignment)
+- [runEvals()](https://mastra.ai/reference/evals/run-evals)
+- [Scorer Utils](https://mastra.ai/reference/evals/scorer-utils)
+- [Textual Difference Scorer](https://mastra.ai/reference/evals/textual-difference)
+- [Tone Consistency Scorer](https://mastra.ai/reference/evals/tone-consistency)
+- [Tool Call Accuracy Scorers](https://mastra.ai/reference/evals/tool-call-accuracy)
+- [Toxicity](https://mastra.ai/reference/evals/toxicity)
+- [Harness Class](https://mastra.ai/reference/harness/harness-class)
+- [createMastraCode()](https://mastra.ai/reference/mastra-code/createMastraCode)
+- [Cloned Thread Utilities](https://mastra.ai/reference/memory/clone-utilities)
+- [Memory Class](https://mastra.ai/reference/memory/memory-class)
+- [Observational Memory](https://mastra.ai/reference/memory/observational-memory)
+- [.cloneThread()](https://mastra.ai/reference/memory/cloneThread)
+- [.createThread()](https://mastra.ai/reference/memory/createThread)
+- [.deleteMessages()](https://mastra.ai/reference/memory/deleteMessages)
+- [.getThreadById()](https://mastra.ai/reference/memory/getThreadById)
+- [.listThreads()](https://mastra.ai/reference/memory/listThreads)
+- [.recall()](https://mastra.ai/reference/memory/recall)
+- [Dataset Class](https://mastra.ai/reference/datasets/dataset)
+- [DatasetsManager Class](https://mastra.ai/reference/datasets/datasets-manager)
+- [.addItem()](https://mastra.ai/reference/datasets/addItem)
+- [.addItems()](https://mastra.ai/reference/datasets/addItems)
+- [.compareExperiments()](https://mastra.ai/reference/datasets/compareExperiments)
+- [.create()](https://mastra.ai/reference/datasets/create)
+- [.delete()](https://mastra.ai/reference/datasets/delete)
+- [.deleteExperiment()](https://mastra.ai/reference/datasets/deleteExperiment)
+- [.deleteItem()](https://mastra.ai/reference/datasets/deleteItem)
+- [.deleteItems()](https://mastra.ai/reference/datasets/deleteItems)
+- [.get()](https://mastra.ai/reference/datasets/get)
+- [.getDetails()](https://mastra.ai/reference/datasets/getDetails)
+- [.getExperiment()](https://mastra.ai/reference/datasets/getExperiment)
+- [.getItem()](https://mastra.ai/reference/datasets/getItem)
+- [.getItemHistory()](https://mastra.ai/reference/datasets/getItemHistory)
+- [.list()](https://mastra.ai/reference/datasets/list)
+- [.listExperimentResults()](https://mastra.ai/reference/datasets/listExperimentResults)
+- [.listExperiments()](https://mastra.ai/reference/datasets/listExperiments)
+- [.listItems()](https://mastra.ai/reference/datasets/listItems)
+- [.listVersions()](https://mastra.ai/reference/datasets/listVersions)
+- [.startExperiment()](https://mastra.ai/reference/datasets/startExperiment)
+- [.startExperimentAsync()](https://mastra.ai/reference/datasets/startExperimentAsync)
+- [.update()](https://mastra.ai/reference/datasets/update)
+- [.updateItem()](https://mastra.ai/reference/datasets/updateItem)
+- [PinoLogger](https://mastra.ai/reference/logging/pino-logger)
+- [Configuration](https://mastra.ai/reference/observability/tracing/configuration)
+- [Instances](https://mastra.ai/reference/observability/tracing/instances)
+- [Interfaces](https://mastra.ai/reference/observability/tracing/interfaces)
+- [Spans](https://mastra.ai/reference/observability/tracing/spans)
+- [BatchPartsProcessor](https://mastra.ai/reference/processors/batch-parts-processor)
+- [LanguageDetector](https://mastra.ai/reference/processors/language-detector)
+- [MessageHistory](https://mastra.ai/reference/processors/message-history-processor)
+- [ModerationProcessor](https://mastra.ai/reference/processors/moderation-processor)
+- [PIIDetector](https://mastra.ai/reference/processors/pii-detector)
+- [Processor Interface](https://mastra.ai/reference/processors/processor-interface)
+- [PromptInjectionDetector](https://mastra.ai/reference/processors/prompt-injection-detector)
+- [SemanticRecall](https://mastra.ai/reference/processors/semantic-recall-processor)
+- [SystemPromptScrubber](https://mastra.ai/reference/processors/system-prompt-scrubber)
+- [TokenLimiterProcessor](https://mastra.ai/reference/processors/token-limiter-processor)
+- [ToolCallFilter](https://mastra.ai/reference/processors/tool-call-filter)
+- [ToolSearchProcessor](https://mastra.ai/reference/processors/tool-search-processor)
+- [UnicodeNormalizer](https://mastra.ai/reference/processors/unicode-normalizer)
+- [WorkingMemory](https://mastra.ai/reference/processors/working-memory-processor)
+- [DatabaseConfig](https://mastra.ai/reference/rag/database-config)
+- [Embed](https://mastra.ai/reference/rag/embeddings)
+- [ExtractParams](https://mastra.ai/reference/rag/extract-params)
+- [GraphRAG](https://mastra.ai/reference/rag/graph-rag)
+- [MDocument](https://mastra.ai/reference/rag/document)
+- [Metadata Filters](https://mastra.ai/reference/rag/metadata-filters)
+- [rerank()](https://mastra.ai/reference/rag/rerank)
+- [rerankWithScorer()](https://mastra.ai/reference/rag/rerankWithScorer)
+- [.chunk()](https://mastra.ai/reference/rag/chunk)
+- [createRoute()](https://mastra.ai/reference/server/create-route)
+- [Express Adapter](https://mastra.ai/reference/server/express-adapter)
+- [Fastify Adapter](https://mastra.ai/reference/server/fastify-adapter)
+- [Hono Adapter](https://mastra.ai/reference/server/hono-adapter)
+- [Koa Adapter](https://mastra.ai/reference/server/koa-adapter)
+- [MastraServer](https://mastra.ai/reference/server/mastra-server)
+- [registerApiRoute()](https://mastra.ai/reference/server/register-api-route)
+- [Server Routes](https://mastra.ai/reference/server/routes)
+- [Overview](https://mastra.ai/reference/storage/overview)
+- [Cloudflare D1 Storage](https://mastra.ai/reference/storage/cloudflare-d1)
+- [Cloudflare KV Storage](https://mastra.ai/reference/storage/cloudflare)
+- [Composite Storage](https://mastra.ai/reference/storage/composite)
+- [Convex Storage](https://mastra.ai/reference/storage/convex)
+- [DynamoDB Storage](https://mastra.ai/reference/storage/dynamodb)
+- [LanceDB Storage](https://mastra.ai/reference/storage/lance)
+- [libSQL Storage](https://mastra.ai/reference/storage/libsql)
+- [MongoDB Storage](https://mastra.ai/reference/storage/mongodb)
+- [MSSQL Storage](https://mastra.ai/reference/storage/mssql)
+- [PostgreSQL Storage](https://mastra.ai/reference/storage/postgresql)
+- [Upstash Storage](https://mastra.ai/reference/storage/upstash)
+- [ChunkType](https://mastra.ai/reference/streaming/ChunkType)
+- [MastraModelOutput](https://mastra.ai/reference/streaming/agents/MastraModelOutput)
+- [.stream()](https://mastra.ai/reference/streaming/agents/stream)
+- [.streamLegacy()](https://mastra.ai/reference/streaming/agents/streamLegacy)
+- [.observeStream()](https://mastra.ai/reference/streaming/workflows/observeStream)
+- [.resumeStream()](https://mastra.ai/reference/streaming/workflows/resumeStream)
+- [.stream()](https://mastra.ai/reference/streaming/workflows/stream)
+- [.timeTravelStream()](https://mastra.ai/reference/streaming/workflows/timeTravelStream)
+- [Overview](https://mastra.ai/reference/templates/overview)
+- [createDocumentChunkerTool()](https://mastra.ai/reference/tools/document-chunker-tool)
+- [createGraphRAGTool()](https://mastra.ai/reference/tools/graph-rag-tool)
+- [createTool()](https://mastra.ai/reference/tools/create-tool)
+- [createVectorQueryTool()](https://mastra.ai/reference/tools/vector-query-tool)
+- [MCPClient](https://mastra.ai/reference/tools/mcp-client)
+- [MCPServer](https://mastra.ai/reference/tools/mcp-server)
+- [Amazon S3 Vector Store](https://mastra.ai/reference/vectors/s3vectors)
+- [Astra Vector Store](https://mastra.ai/reference/vectors/astra)
+- [Chroma Vector Store](https://mastra.ai/reference/vectors/chroma)
+- [Cloudflare Vector Store](https://mastra.ai/reference/vectors/vectorize)
+- [Convex Vector Store](https://mastra.ai/reference/vectors/convex)
+- [Couchbase Vector Store](https://mastra.ai/reference/vectors/couchbase)
+- [DuckDB Vector Store](https://mastra.ai/reference/vectors/duckdb)
+- [ElasticSearch Vector Store](https://mastra.ai/reference/vectors/elasticsearch)
+- [Lance Vector Store](https://mastra.ai/reference/vectors/lance)
+- [libSQL Vector Store](https://mastra.ai/reference/vectors/libsql)
+- [MongoDB Vector Store](https://mastra.ai/reference/vectors/mongodb)
+- [OpenSearch Vector Store](https://mastra.ai/reference/vectors/opensearch)
+- [PG Vector Store](https://mastra.ai/reference/vectors/pg)
+- [Pinecone Vector Store](https://mastra.ai/reference/vectors/pinecone)
+- [Qdrant Vector Store](https://mastra.ai/reference/vectors/qdrant)
+- [Turbopuffer Vector Store](https://mastra.ai/reference/vectors/turbopuffer)
+- [Upstash Vector Store](https://mastra.ai/reference/vectors/upstash)
+- [Azure](https://mastra.ai/reference/voice/azure)
+- [Cloudflare](https://mastra.ai/reference/voice/cloudflare)
+- [Composite Voice](https://mastra.ai/reference/voice/composite-voice)
+- [Deepgram](https://mastra.ai/reference/voice/deepgram)
+- [ElevenLabs](https://mastra.ai/reference/voice/elevenlabs)
+- [Events](https://mastra.ai/reference/voice/voice.events)
+- [Google](https://mastra.ai/reference/voice/google)
+- [Google Gemini Live](https://mastra.ai/reference/voice/google-gemini-live)
+- [Mastra Voice](https://mastra.ai/reference/voice/mastra-voice)
+- [Murf](https://mastra.ai/reference/voice/murf)
+- [OpenAI](https://mastra.ai/reference/voice/openai)
+- [OpenAI Realtime](https://mastra.ai/reference/voice/openai-realtime)
+- [PlayAI](https://mastra.ai/reference/voice/playai)
+- [Sarvam](https://mastra.ai/reference/voice/sarvam)
+- [Speechify](https://mastra.ai/reference/voice/speechify)
+- [.addInstructions()](https://mastra.ai/reference/voice/voice.addInstructions)
+- [.addTools()](https://mastra.ai/reference/voice/voice.addTools)
+- [.answer()](https://mastra.ai/reference/voice/voice.answer)
+- [.close()](https://mastra.ai/reference/voice/voice.close)
+- [.connect()](https://mastra.ai/reference/voice/voice.connect)
+- [.getSpeakers()](https://mastra.ai/reference/voice/voice.getSpeakers)
+- [.listen()](https://mastra.ai/reference/voice/voice.listen)
+- [.off()](https://mastra.ai/reference/voice/voice.off)
+- [.on()](https://mastra.ai/reference/voice/voice.on)
+- [.send()](https://mastra.ai/reference/voice/voice.send)
+- [.speak()](https://mastra.ai/reference/voice/voice.speak)
+- [.updateConfig()](https://mastra.ai/reference/voice/voice.updateConfig)
+- [Run Class](https://mastra.ai/reference/workflows/run)
+- [Step Class](https://mastra.ai/reference/workflows/step)
+- [Workflow Class](https://mastra.ai/reference/workflows/workflow)
+- [.branch()](https://mastra.ai/reference/workflows/workflow-methods/branch)
+- [.commit()](https://mastra.ai/reference/workflows/workflow-methods/commit)
+- [.createRun()](https://mastra.ai/reference/workflows/workflow-methods/create-run)
+- [.dountil()](https://mastra.ai/reference/workflows/workflow-methods/dountil)
+- [.dowhile()](https://mastra.ai/reference/workflows/workflow-methods/dowhile)
+- [.foreach()](https://mastra.ai/reference/workflows/workflow-methods/foreach)
+- [.map()](https://mastra.ai/reference/workflows/workflow-methods/map)
+- [.parallel()](https://mastra.ai/reference/workflows/workflow-methods/parallel)
+- [.sleep()](https://mastra.ai/reference/workflows/workflow-methods/sleep)
+- [.sleepUntil()](https://mastra.ai/reference/workflows/workflow-methods/sleepUntil)
+- [.then()](https://mastra.ai/reference/workflows/workflow-methods/then)
+- [.cancel()](https://mastra.ai/reference/workflows/run-methods/cancel)
+- [.restart()](https://mastra.ai/reference/workflows/run-methods/restart)
+- [.resume()](https://mastra.ai/reference/workflows/run-methods/resume)
+- [.start()](https://mastra.ai/reference/workflows/run-methods/start)
+- [.startAsync()](https://mastra.ai/reference/workflows/run-methods/startAsync)
+- [.timeTravel()](https://mastra.ai/reference/workflows/run-methods/timeTravel)
+- [E2BSandbox](https://mastra.ai/reference/workspace/e2b-sandbox)
+- [GCSFilesystem](https://mastra.ai/reference/workspace/gcs-filesystem)
+- [LocalFilesystem](https://mastra.ai/reference/workspace/local-filesystem)
+- [LocalSandbox](https://mastra.ai/reference/workspace/local-sandbox)
+- [S3Filesystem](https://mastra.ai/reference/workspace/s3-filesystem)
+- [Workspace Class](https://mastra.ai/reference/workspace/workspace-class)
+- [WorkspaceFilesystem](https://mastra.ai/reference/workspace/filesystem)
+- [WorkspaceSandbox](https://mastra.ai/reference/workspace/sandbox)