@mastra/mcp-docs-server 1.1.7-alpha.0 → 1.1.8-alpha.0

package/.docs/reference/workspace/gcs-filesystem.md

@@ -69,37 +69,37 @@ const filesystem = new GCSFilesystem({
 
 ## Constructor parameters
 
-**bucket:** (`string`): GCS bucket name
+**bucket** (`string`): GCS bucket name
 
-**projectId?:** (`string`): GCS project ID. Required when using service account credentials.
+**projectId** (`string`): GCS project ID. Required when using service account credentials.
 
-**credentials?:** (`object | string`): Service account key JSON object or path to key file. If not provided, uses Application Default Credentials.
+**credentials** (`object | string`): Service account key JSON object or path to key file. If not provided, uses Application Default Credentials.
 
-**prefix?:** (`string`): Optional prefix for all keys (acts like a subdirectory)
+**prefix** (`string`): Optional prefix for all keys (acts like a subdirectory)
 
-**id?:** (`string`): Unique identifier for this filesystem instance (Default: `Auto-generated`)
+**id** (`string`): Unique identifier for this filesystem instance (Default: `Auto-generated`)
 
-**displayName?:** (`string`): Human-friendly display name for the UI
+**displayName** (`string`): Human-friendly display name for the UI
 
-**icon?:** (`FilesystemIcon`): Icon identifier for the UI
+**icon** (`FilesystemIcon`): Icon identifier for the UI
 
-**description?:** (`string`): Short description of this filesystem for the UI
+**description** (`string`): Short description of this filesystem for the UI
 
-**readOnly?:** (`boolean`): When true, all write operations are blocked (Default: `false`)
+**readOnly** (`boolean`): When true, all write operations are blocked (Default: `false`)
 
-**endpoint?:** (`string`): Custom API endpoint URL. Used for local development with emulators.
+**endpoint** (`string`): Custom API endpoint URL. Used for local development with emulators.
 
 ## Properties
 
-**id:** (`string`): Filesystem instance identifier
+**id** (`string`): Filesystem instance identifier
 
-**name:** (`string`): Provider name ('GCSFilesystem')
+**name** (`string`): Provider name ('GCSFilesystem')
 
-**provider:** (`string`): Provider identifier ('gcs')
+**provider** (`string`): Provider identifier ('gcs')
 
-**bucket:** (`string`): The GCS bucket name
+**bucket** (`string`): The GCS bucket name
 
-**readOnly:** (`boolean | undefined`): Whether the filesystem is in read-only mode
+**readOnly** (`boolean | undefined`): Whether the filesystem is in read-only mode
 
 ## Methods
 

package/.docs/reference/workspace/local-filesystem.md

@@ -32,31 +32,31 @@ const response = await agent.generate('List all files in the workspace')
 
 ## Constructor parameters
 
-**basePath:** (`string`): Base directory path on disk. All file paths are resolved relative to this directory.
+**basePath** (`string`): Base directory path on disk. All file paths are resolved relative to this directory.
 
-**id?:** (`string`): Unique identifier for this filesystem instance (Default: `Auto-generated`)
+**id** (`string`): Unique identifier for this filesystem instance (Default: `Auto-generated`)
 
-**contained?:** (`boolean`): When true, all file operations are restricted to stay within basePath. Prevents path traversal attacks and symlink escapes. See \[containment]\(/docs/workspace/filesystem#containment). (Default: `true`)
+**contained** (`boolean`): When true, all file operations are restricted to stay within basePath. Prevents path traversal attacks and symlink escapes. See \[containment]\(/docs/workspace/filesystem#containment). (Default: `true`)
 
-**allowedPaths?:** (`string[]`): Additional absolute paths that are allowed beyond basePath. Useful with \`contained: true\` to grant access to specific directories without disabling containment entirely. Paths are resolved to absolute paths. (Default: `[]`)
+**allowedPaths** (`string[]`): Additional absolute paths that are allowed beyond basePath. Useful with \`contained: true\` to grant access to specific directories without disabling containment entirely. Paths are resolved to absolute paths. (Default: `[]`)
 
-**instructions?:** (`string | ((opts: { defaultInstructions: string; requestContext?: RequestContext }) => string)`): Custom instructions that override the default instructions returned by getInstructions(). Pass a string to fully replace them, or a function to extend them with access to the current requestContext for per-request customization.
+**instructions** (`string | ((opts: { defaultInstructions: string; requestContext?: RequestContext }) => string)`): Custom instructions that override the default instructions returned by getInstructions(). Pass a string to fully replace them, or a function to extend them with access to the current requestContext for per-request customization.
 
-**readOnly?:** (`boolean`): When true, all write operations are blocked. Read operations are still allowed. (Default: `false`)
+**readOnly** (`boolean`): When true, all write operations are blocked. Read operations are still allowed. (Default: `false`)
 
 ## Properties
 
-**id:** (`string`): Filesystem instance identifier
+**id** (`string`): Filesystem instance identifier
 
-**name:** (`string`): Provider name ('LocalFilesystem')
+**name** (`string`): Provider name ('LocalFilesystem')
 
-**provider:** (`string`): Provider identifier ('local')
+**provider** (`string`): Provider identifier ('local')
 
-**basePath:** (`string`): The absolute base path on disk
+**basePath** (`string`): The absolute base path on disk
 
-**readOnly:** (`boolean | undefined`): Whether the filesystem is in read-only mode
+**readOnly** (`boolean | undefined`): Whether the filesystem is in read-only mode
 
-**allowedPaths:** (`readonly string[]`): Current set of additional allowed paths (absolute, resolved). These paths are permitted beyond basePath when containment is enabled.
+**allowedPaths** (`readonly string[]`): Current set of additional allowed paths (absolute, resolved). These paths are permitted beyond basePath when containment is enabled.
 
 ## Methods
 
@@ -101,7 +101,7 @@ filesystem.setAllowedPaths([])
 
 **Parameters:**
 
-**pathsOrUpdater:** (`string[] | ((current: readonly string[]) => string[])`): New allowed paths array or updater function receiving current paths
+**pathsOrUpdater** (`string[] | ((current: readonly string[]) => string[])`): New allowed paths array or updater function receiving current paths
 
 ### `readFile(path, options?)`
 
@@ -114,9 +114,9 @@ const buffer = await filesystem.readFile('/image.png', { encoding: 'binary' })
 
 **Parameters:**
 
-**path:** (`string`): File path relative to basePath
+**path** (`string`): File path relative to basePath
 
-**options.encoding?:** (`'utf-8' | 'binary'`): Text or binary encoding (Default: `'utf-8'`)
+**options.encoding** (`'utf-8' | 'binary'`): Text or binary encoding (Default: `'utf-8'`)
 
 ### `writeFile(path, content, options?)`
 
@@ -129,13 +129,13 @@ await filesystem.writeFile('/nested/path/file.md', content, { recursive: true })
 
 **Parameters:**
 
-**path:** (`string`): File path relative to basePath
+**path** (`string`): File path relative to basePath
 
-**content:** (`string | Buffer`): File content
+**content** (`string | Buffer`): File content
 
-**options.recursive?:** (`boolean`): Create parent directories if they don't exist (Default: `false`)
+**options.recursive** (`boolean`): Create parent directories if they don't exist (Default: `false`)
 
-**options.overwrite?:** (`boolean`): Overwrite existing file (Default: `true`)
+**options.overwrite** (`boolean`): Overwrite existing file (Default: `true`)
 
 ### `appendFile(path, content)`
 
@@ -147,9 +147,9 @@ await filesystem.appendFile('/logs/app.log', 'New log entry\n')
 
 **Parameters:**
 
-**path:** (`string`): File path relative to basePath
+**path** (`string`): File path relative to basePath
 
-**content:** (`string | Buffer`): Content to append
+**content** (`string | Buffer`): Content to append
 
 ### `deleteFile(path, options?)`
 
@@ -162,9 +162,9 @@ await filesystem.deleteFile('/docs/maybe.md', { force: true }) // Don't throw if
 
 **Parameters:**
 
-**path:** (`string`): File path
+**path** (`string`): File path
 
-**options.force?:** (`boolean`): Don't throw error if file doesn't exist (Default: `false`)
+**options.force** (`boolean`): Don't throw error if file doesn't exist (Default: `false`)
 
 ### `copyFile(src, dest, options?)`
 
@@ -177,11 +177,11 @@ await filesystem.copyFile('/src/config.json', '/backup/config.json', { overwrite
 
 **Parameters:**
 
-**src:** (`string`): Source file path
+**src** (`string`): Source file path
 
-**dest:** (`string`): Destination file path
+**dest** (`string`): Destination file path
 
-**options.overwrite?:** (`boolean`): Overwrite destination if it exists (Default: `true`)
+**options.overwrite** (`boolean`): Overwrite destination if it exists (Default: `true`)
 
 ### `moveFile(src, dest, options?)`
 
@@ -194,11 +194,11 @@ await filesystem.moveFile('/temp/upload.txt', '/files/document.txt')
 
 **Parameters:**
 
-**src:** (`string`): Source file path
+**src** (`string`): Source file path
 
-**dest:** (`string`): Destination file path
+**dest** (`string`): Destination file path
 
-**options.overwrite?:** (`boolean`): Overwrite destination if it exists (Default: `true`)
+**options.overwrite** (`boolean`): Overwrite destination if it exists (Default: `true`)
 
 ### `mkdir(path, options?)`
 
@@ -211,9 +211,9 @@ await filesystem.mkdir('/deeply/nested/path', { recursive: true })
 
 **Parameters:**
 
-**path:** (`string`): Directory path
+**path** (`string`): Directory path
 
-**options.recursive?:** (`boolean`): Create parent directories (Default: `false`)
+**options.recursive** (`boolean`): Create parent directories (Default: `false`)
 
 ### `rmdir(path, options?)`
 
@@ -226,11 +226,11 @@ await filesystem.rmdir('/docs/nested', { recursive: true })
 
 **Parameters:**
 
-**path:** (`string`): Directory path
+**path** (`string`): Directory path
 
-**options.recursive?:** (`boolean`): Remove contents recursively (Default: `false`)
+**options.recursive** (`boolean`): Remove contents recursively (Default: `false`)
 
-**options.force?:** (`boolean`): Don't throw if directory doesn't exist (Default: `false`)
+**options.force** (`boolean`): Don't throw if directory doesn't exist (Default: `false`)
 
 ### `readdir(path, options?)`
 
@@ -284,7 +284,7 @@ const instructions = filesystem.getInstructions({ requestContext })
 
 **Parameters:**
 
-**opts.requestContext?:** (`RequestContext`): Forwarded to the \`instructions\` function if one was provided in the constructor.
+**opts.requestContext** (`RequestContext`): Forwarded to the \`instructions\` function if one was provided in the constructor.
 
 **Returns:** `string`
 

package/.docs/reference/workspace/local-sandbox.md

@@ -40,47 +40,47 @@ const response = await agent.generate('Run npm install')
 
 ## Constructor parameters
 
-**id?:** (`string`): Unique identifier for this sandbox instance (Default: `Auto-generated`)
+**id** (`string`): Unique identifier for this sandbox instance (Default: `Auto-generated`)
 
-**workingDirectory?:** (`string`): Directory for command execution. Defaults to .sandbox/ in process.cwd() for isolation from seatbelt profiles. (Default: `process.cwd()/.sandbox/`)
+**workingDirectory** (`string`): Directory for command execution. Defaults to .sandbox/ in process.cwd() for isolation from seatbelt profiles. (Default: `process.cwd()/.sandbox/`)
 
-**env?:** (`NodeJS.ProcessEnv`): Environment variables to set. PATH is included by default unless overridden.
+**env** (`NodeJS.ProcessEnv`): Environment variables to set. PATH is included by default unless overridden.
 
-**timeout?:** (`number`): Default timeout for operations in milliseconds (Default: `30000`)
+**timeout** (`number`): Default timeout for operations in milliseconds (Default: `30000`)
 
-**isolation?:** (`'none' | 'seatbelt' | 'bwrap'`): Native OS sandboxing backend. 'seatbelt' for macOS, 'bwrap' for Linux. (Default: `'none'`)
+**isolation** (`'none' | 'seatbelt' | 'bwrap'`): Native OS sandboxing backend. 'seatbelt' for macOS, 'bwrap' for Linux. (Default: `'none'`)
 
-**instructions?:** (`string | ((opts: { defaultInstructions: string; requestContext?: RequestContext }) => string)`): Custom instructions that override the default instructions returned by getInstructions(). Pass a string to fully replace them, or a function to extend them with access to the current requestContext for per-request customization.
+**instructions** (`string | ((opts: { defaultInstructions: string; requestContext?: RequestContext }) => string)`): Custom instructions that override the default instructions returned by getInstructions(). Pass a string to fully replace them, or a function to extend them with access to the current requestContext for per-request customization.
 
-**nativeSandbox?:** (`NativeSandboxConfig`): Configuration for native sandboxing (see NativeSandboxConfig below).
+**nativeSandbox** (`NativeSandboxConfig`): Configuration for native sandboxing (see NativeSandboxConfig below).
 
 ## NativeSandboxConfig
 
 Configuration options for native OS sandboxing (used with `isolation: 'seatbelt'` or `'bwrap'`).
 
-**allowNetwork?:** (`boolean`): Allow network access from sandboxed commands. (Default: `false`)
+**allowNetwork** (`boolean`): Allow network access from sandboxed commands. (Default: `false`)
 
-**readOnlyPaths?:** (`string[]`): Additional paths to allow read-only access (system paths are always readable).
+**readOnlyPaths** (`string[]`): Additional paths to allow read-only access (system paths are always readable).
 
-**readWritePaths?:** (`string[]`): Additional paths to allow read-write access beyond the workspace directory.
+**readWritePaths** (`string[]`): Additional paths to allow read-write access beyond the workspace directory.
 
-**seatbeltProfilePath?:** (`string`): Path to a custom seatbelt profile file (macOS only). If the file exists, it's used; if not, a default profile is generated and written to this path.
+**seatbeltProfilePath** (`string`): Path to a custom seatbelt profile file (macOS only). If the file exists, it's used; if not, a default profile is generated and written to this path.
 
-**bwrapArgs?:** (`string[]`): Additional arguments to pass to bwrap (Linux only).
+**bwrapArgs** (`string[]`): Additional arguments to pass to bwrap (Linux only).
 
-**allowSystemBinaries?:** (`boolean`): Allow read access to standard system binary paths (/bin, /usr/bin, etc.). (Default: `true`)
+**allowSystemBinaries** (`boolean`): Allow read access to standard system binary paths (/bin, /usr/bin, etc.). (Default: `true`)
 
 ## Properties
 
-**id:** (`string`): Sandbox instance identifier
+**id** (`string`): Sandbox instance identifier
 
-**name:** (`string`): Provider name ('LocalSandbox')
+**name** (`string`): Provider name ('LocalSandbox')
 
-**provider:** (`string`): Provider identifier ('local')
+**provider** (`string`): Provider identifier ('local')
 
-**status:** (`ProviderStatus`): 'starting' | 'running' | 'stopped' | 'error'
+**status** (`ProviderStatus`): 'starting' | 'running' | 'stopped' | 'error'
 
-**workingDirectory:** (`string`): The configured working directory
+**workingDirectory** (`string`): The configured working directory
 
 ## Methods
 
@@ -135,19 +135,19 @@ const installResult = await sandbox.executeCommand('npm', ['install', 'lodash'],
 
 **Parameters:**
 
-**command:** (`string`): Command to execute
+**command** (`string`): Command to execute
 
-**args?:** (`string[]`): Command arguments
+**args** (`string[]`): Command arguments
 
-**options.timeout?:** (`number`): Execution timeout in milliseconds
+**options.timeout** (`number`): Execution timeout in milliseconds
 
-**options.cwd?:** (`string`): Working directory for the command
+**options.cwd** (`string`): Working directory for the command
 
-**options.env?:** (`Record<string, string>`): Additional environment variables
+**options.env** (`Record<string, string>`): Additional environment variables
 
-**options.onStdout?:** (`(data: string) => void`): Callback for stdout streaming
+**options.onStdout** (`(data: string) => void`): Callback for stdout streaming
 
-**options.onStderr?:** (`(data: string) => void`): Callback for stderr streaming
+**options.onStderr** (`(data: string) => void`): Callback for stderr streaming
 
 ### `getInfo()`
 
@@ -175,7 +175,7 @@ const instructions = sandbox.getInstructions({ requestContext })
 
 **Parameters:**
 
-**opts.requestContext?:** (`RequestContext`): Forwarded to the \`instructions\` function if one was provided in the constructor.
+**opts.requestContext** (`RequestContext`): Forwarded to the \`instructions\` function if one was provided in the constructor.
 
 **Returns:** `string`
 

package/.docs/reference/workspace/s3-filesystem.md

@@ -65,43 +65,43 @@ const filesystem = new S3Filesystem({
 
 ## Constructor parameters
 
-**bucket:** (`string`): S3 bucket name
+**bucket** (`string`): S3 bucket name
 
-**region:** (`string`): AWS region (use 'auto' for R2)
+**region** (`string`): AWS region (use 'auto' for R2)
 
-**accessKeyId?:** (`string`): AWS access key ID. Optional for public buckets (read-only access).
+**accessKeyId** (`string`): AWS access key ID. Optional for public buckets (read-only access).
 
-**secretAccessKey?:** (`string`): AWS secret access key. Optional for public buckets (read-only access).
+**secretAccessKey** (`string`): AWS secret access key. Optional for public buckets (read-only access).
 
-**sessionToken?:** (`string`): AWS session token for temporary credentials. Required when using SSO, AssumeRole, container credentials, or any other temporary credential provider.
+**sessionToken** (`string`): AWS session token for temporary credentials. Required when using SSO, AssumeRole, container credentials, or any other temporary credential provider.
 
-**endpoint?:** (`string`): Custom endpoint URL for S3-compatible storage (R2, MinIO, etc.)
+**endpoint** (`string`): Custom endpoint URL for S3-compatible storage (R2, MinIO, etc.)
 
-**forcePathStyle?:** (`boolean`): Force path-style URLs instead of virtual-hosted-style. Required for some S3-compatible services like MinIO. Defaults to true when a custom endpoint is provided. (Default: `true (when endpoint is set)`)
+**forcePathStyle** (`boolean`): Force path-style URLs instead of virtual-hosted-style. Required for some S3-compatible services like MinIO. Defaults to true when a custom endpoint is provided. (Default: `true (when endpoint is set)`)
 
-**prefix?:** (`string`): Optional prefix for all keys (acts like a subdirectory)
+**prefix** (`string`): Optional prefix for all keys (acts like a subdirectory)
 
-**id?:** (`string`): Unique identifier for this filesystem instance (Default: `Auto-generated`)
+**id** (`string`): Unique identifier for this filesystem instance (Default: `Auto-generated`)
 
-**displayName?:** (`string`): Human-friendly display name for the UI
+**displayName** (`string`): Human-friendly display name for the UI
 
-**icon?:** (`FilesystemIcon`): Icon identifier for the UI
+**icon** (`FilesystemIcon`): Icon identifier for the UI
 
-**description?:** (`string`): Short description of this filesystem for the UI
+**description** (`string`): Short description of this filesystem for the UI
 
-**readOnly?:** (`boolean`): When true, all write operations are blocked (Default: `false`)
+**readOnly** (`boolean`): When true, all write operations are blocked (Default: `false`)
 
 ## Properties
 
-**id:** (`string`): Filesystem instance identifier
+**id** (`string`): Filesystem instance identifier
 
-**name:** (`string`): Provider name ('S3Filesystem')
+**name** (`string`): Provider name ('S3Filesystem')
 
-**provider:** (`string`): Provider identifier ('s3')
+**provider** (`string`): Provider identifier ('s3')
 
-**bucket:** (`string`): The S3 bucket name
+**bucket** (`string`): The S3 bucket name
 
-**readOnly:** (`boolean | undefined`): Whether the filesystem is in read-only mode
+**readOnly** (`boolean | undefined`): Whether the filesystem is in read-only mode
 
 ## Methods
 

package/.docs/reference/workspace/sandbox.md

@@ -43,19 +43,19 @@ const result = await sandbox.executeCommand('npm', ['install', 'lodash'])
 
 **Parameters:**
 
-**command:** (`string`): Command to execute
+**command** (`string`): Command to execute
 
-**args?:** (`string[]`): Command arguments
+**args** (`string[]`): Command arguments
 
-**options.timeout?:** (`number`): Execution timeout in milliseconds
+**options.timeout** (`number`): Execution timeout in milliseconds
 
-**options.cwd?:** (`string`): Working directory for the command
+**options.cwd** (`string`): Working directory for the command
 
-**options.env?:** (`Record<string, string>`): Additional environment variables
+**options.env** (`Record<string, string>`): Additional environment variables
 
-**options.onStdout?:** (`(data: string) => void`): Callback for stdout streaming
+**options.onStdout** (`(data: string) => void`): Callback for stdout streaming
 
-**options.onStderr?:** (`(data: string) => void`): Callback for stderr streaming
+**options.onStderr** (`(data: string) => void`): Callback for stderr streaming
 
 ### `getInfo()`
 
@@ -77,7 +77,7 @@ const instructions = sandbox.getInstructions?.()
 
 **Parameters:**
 
-**opts.requestContext?:** (`RequestContext`): Forwarded to the \`instructions\` function if one was provided in the constructor.
+**opts.requestContext** (`RequestContext`): Forwarded to the \`instructions\` function if one was provided in the constructor.
 
 **Returns:** `string`
 

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

@@ -25,33 +25,39 @@ const workspace = new Workspace({
 
 ## Constructor parameters
 
-**id?:** (`string`): Unique identifier for the workspace (Default: `Auto-generated`)
+**id** (`string`): Unique identifier for the workspace (Default: `Auto-generated`)
 
-**name?:** (`string`): Human-readable name (Default: `workspace-{id}`)
+**name** (`string`): Human-readable name (Default: `workspace-{id}`)
 
-**filesystem?:** (`WorkspaceFilesystem`): Filesystem provider instance (e.g., LocalFilesystem)
+**filesystem** (`WorkspaceFilesystem`): Filesystem provider instance (e.g., LocalFilesystem)
 
-**sandbox?:** (`WorkspaceSandbox`): Sandbox provider instance (e.g., LocalSandbox)
+**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`)
+**bm25** (`boolean | BM25Config`): Enable BM25 keyword search. Pass true for defaults or a config object. (Default: `undefined`)
 
-**vectorStore?:** (`MastraVector`): Vector store for semantic search
+**vectorStore** (`MastraVector`): Vector store for semantic search
 
-**embedder?:** (`(text: string) => Promise<number[]>`): Embedder function for generating vectors. Required when vectorStore is provided.
+**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.
+**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.
+**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.
+**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.
+**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'.
+**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
+**tools** (`WorkspaceToolsConfig`): Per-tool configuration for enabling tools and setting safety options
 
-**operationTimeout?:** (`number`): Timeout for operations in milliseconds
+**tools.enabled** (`boolean`): Whether the tool is available to agents
+
+**tools.requireApproval** (`boolean`): Whether the tool requires user approval before execution
+
+**tools.requireReadBeforeWrite** (`boolean`): For write tools: require reading the file first to prevent overwrites
+
+**operationTimeout** (`number`): Timeout for operations in milliseconds
 
 ## Tool configuration
 
@@ -79,35 +85,25 @@ The config object has two parts:
 
 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
+**id** (`string`): Workspace identifier
 
-**name:** (`string`): Workspace name
+**name** (`string`): Workspace name
 
-**status:** (`WorkspaceStatus`): 'pending' | 'initializing' | 'ready' | 'paused' | 'error' | 'destroying' | 'destroyed'
+**status** (`WorkspaceStatus`): 'pending' | 'initializing' | 'ready' | 'paused' | 'error' | 'destroying' | 'destroyed'
 
-**filesystem:** (`WorkspaceFilesystem | undefined`): The filesystem provider
+**filesystem** (`WorkspaceFilesystem | undefined`): The filesystem provider
 
-**sandbox:** (`WorkspaceSandbox | undefined`): The sandbox provider
+**sandbox** (`WorkspaceSandbox | undefined`): The sandbox provider
 
-**skills:** (`WorkspaceSkills | undefined`): Skills interface for accessing SKILL.md files
+**skills** (`WorkspaceSkills | undefined`): Skills interface for accessing SKILL.md files
 
-**canBM25:** (`boolean`): Whether BM25 search is available
+**canBM25** (`boolean`): Whether BM25 search is available
 
-**canVector:** (`boolean`): Whether vector search is available
+**canVector** (`boolean`): Whether vector search is available
 
-**canHybrid:** (`boolean`): Whether hybrid search is available
+**canHybrid** (`boolean`): Whether hybrid search is available
 
 ## Methods
 
@@ -189,7 +185,7 @@ const instructions = workspace.getInstructions({ requestContext })
 
 **Parameters:**
 
-**opts.requestContext?:** (`RequestContext`): Forwarded to the \`instructions\` function on the filesystem or sandbox provider, if one is configured.
+**opts.requestContext** (`RequestContext`): Forwarded to the \`instructions\` function on the filesystem or sandbox provider, if one is configured.
 
 **Returns:** `string`
 

package/CHANGELOG.md

@@ -1,5 +1,21 @@
 # @mastra/mcp-docs-server
 
+## 1.1.8-alpha.0
+
+### Patch Changes
+
+- Updated dependencies [[`41e48c1`](https://github.com/mastra-ai/mastra/commit/41e48c198eee846478e60c02ec432c19d322a517), [`82469d3`](https://github.com/mastra-ai/mastra/commit/82469d3135d5a49dd8dc8feec0ff398b4e0225a0), [`33e2fd5`](https://github.com/mastra-ai/mastra/commit/33e2fd5088f83666df17401e2da68c943dbc0448), [`7ef6e2c`](https://github.com/mastra-ai/mastra/commit/7ef6e2c61be5a42e26f55d15b5902866fc76634f), [`b12d2a5`](https://github.com/mastra-ai/mastra/commit/b12d2a59a48be0477cabae66eb6cf0fc94a7d40d), [`9e21667`](https://github.com/mastra-ai/mastra/commit/9e2166746df81da8f1f933a918741fc52f922c70), [`fa37d39`](https://github.com/mastra-ai/mastra/commit/fa37d39910421feaf8847716292e3d65dd4f30c2), [`b12d2a5`](https://github.com/mastra-ai/mastra/commit/b12d2a59a48be0477cabae66eb6cf0fc94a7d40d), [`71c38bf`](https://github.com/mastra-ai/mastra/commit/71c38bf905905148ecd0e75c07c1f9825d299b76), [`f993c38`](https://github.com/mastra-ai/mastra/commit/f993c3848c97479b813231be872443bedeced6ab), [`f51849a`](https://github.com/mastra-ai/mastra/commit/f51849a568935122b5100b7ee69704e6d680cf7b), [`9bf3a0d`](https://github.com/mastra-ai/mastra/commit/9bf3a0dac602787925f1762f1f0387d7b4a59620), [`cafa045`](https://github.com/mastra-ai/mastra/commit/cafa0453c9de141ad50c09a13894622dffdd9978), [`1fd9ddb`](https://github.com/mastra-ai/mastra/commit/1fd9ddbb3fe83b281b12bd2e27e426ae86288266), [`6135ef4`](https://github.com/mastra-ai/mastra/commit/6135ef4f5288652bf45f616ec590607e4c95f443), [`d9d228c`](https://github.com/mastra-ai/mastra/commit/d9d228c0c6ae82ae6ce3b540a3a56b2b1c2b8d98), [`5576507`](https://github.com/mastra-ai/mastra/commit/55765071e360fb97e443aa0a91ccf7e1cd8d92aa), [`79d69c9`](https://github.com/mastra-ai/mastra/commit/79d69c9d5f842ff1c31352fb6026f04c1f6190f3), [`94f44b8`](https://github.com/mastra-ai/mastra/commit/94f44b827ce57b179e50f4916a84c0fa6e7f3b8c), [`13187db`](https://github.com/mastra-ai/mastra/commit/13187dbac880174232dedc5a501ff6c5d0fe59bc), [`2ae5311`](https://github.com/mastra-ai/mastra/commit/2ae531185fff66a80fa165c0999e3d801900e89d), [`6135ef4`](https://github.com/mastra-ai/mastra/commit/6135ef4f5288652bf45f616ec590607e4c95f443)]:
+  - @mastra/core@1.10.0-alpha.0
+  - @mastra/mcp@1.1.0-alpha.0
+
+## 1.1.7
+
+### Patch Changes
+
+- Updated dependencies [[`504fc8b`](https://github.com/mastra-ai/mastra/commit/504fc8b9d0ddab717577ad3bf9c95ea4bd5377bd), [`f9c150b`](https://github.com/mastra-ai/mastra/commit/f9c150b7595ad05ad9cc9a11098e2944361e8c22), [`88de7e8`](https://github.com/mastra-ai/mastra/commit/88de7e8dfe4b7e1951a9e441bb33136e705ce24e), [`edee4b3`](https://github.com/mastra-ai/mastra/commit/edee4b37dff0af515fc7cc0e8d71ee39e6a762f0), [`3790c75`](https://github.com/mastra-ai/mastra/commit/3790c7578cc6a47d854eb12d89e6b1912867fe29), [`e7a235b`](https://github.com/mastra-ai/mastra/commit/e7a235be6472e0c870ed6c791ddb17c492dc188b), [`d51d298`](https://github.com/mastra-ai/mastra/commit/d51d298953967aab1f58ec965b644d109214f085), [`6dbeeb9`](https://github.com/mastra-ai/mastra/commit/6dbeeb94a8b1eebb727300d1a98961f882180794), [`d5f0d8d`](https://github.com/mastra-ai/mastra/commit/d5f0d8d6a03e515ddaa9b5da19b7e44b8357b07b), [`09c3b18`](https://github.com/mastra-ai/mastra/commit/09c3b1802ff14e243a8a8baea327440bc8cc2e32), [`b896379`](https://github.com/mastra-ai/mastra/commit/b8963791c6afa79484645fcec596a201f936b9a2), [`85c84eb`](https://github.com/mastra-ai/mastra/commit/85c84ebb78aebfcba9d209c8e152b16d7a00cb71), [`a89272a`](https://github.com/mastra-ai/mastra/commit/a89272a5d71939b9fcd284e6a6dc1dd091a6bdcf), [`ee9c8df`](https://github.com/mastra-ai/mastra/commit/ee9c8df644f19d055af5f496bf4942705f5a47b7), [`77b4a25`](https://github.com/mastra-ai/mastra/commit/77b4a254e51907f8ff3a3ba95596a18e93ae4b35), [`276246e`](https://github.com/mastra-ai/mastra/commit/276246e0b9066a1ea48bbc70df84dbe528daaf99), [`08ecfdb`](https://github.com/mastra-ai/mastra/commit/08ecfdbdad6fb8285deef86a034bdf4a6047cfca), [`d5f628c`](https://github.com/mastra-ai/mastra/commit/d5f628ca86c6f6f3ff1035d52f635df32dd81cab), [`24f7204`](https://github.com/mastra-ai/mastra/commit/24f72046eb35b47c75d36193af4fb817b588720d), [`524c0f3`](https://github.com/mastra-ai/mastra/commit/524c0f3c434c3d9d18f66338dcef383d6161b59c), [`c18a0e9`](https://github.com/mastra-ai/mastra/commit/c18a0e9cef1e4ca004b2963d35e4cfc031971eac), [`4bd21ea`](https://github.com/mastra-ai/mastra/commit/4bd21ea43d44d0a0427414fc047577f9f0aa3bec), [`115a7a4`](https://github.com/mastra-ai/mastra/commit/115a7a47db5e9896fec12ae6507501adb9ec89bf), [`22a48ae`](https://github.com/mastra-ai/mastra/commit/22a48ae2513eb54d8d79dad361fddbca97a155e8), [`3c6ef79`](https://github.com/mastra-ai/mastra/commit/3c6ef798481e00d6d22563be2de98818fd4dd5e0), [`9311c17`](https://github.com/mastra-ai/mastra/commit/9311c17d7a0640d9c4da2e71b814dc67c57c6369), [`7edf78f`](https://github.com/mastra-ai/mastra/commit/7edf78f80422c43e84585f08ba11df0d4d0b73c5), [`1c4221c`](https://github.com/mastra-ai/mastra/commit/1c4221cf6032ec98d0e094d4ee11da3e48490d96), [`d25b9ea`](https://github.com/mastra-ai/mastra/commit/d25b9eabd400167255a97b690ffbc4ee4097ded5), [`fe1ce5c`](https://github.com/mastra-ai/mastra/commit/fe1ce5c9211c03d561606fda95cbfe7df1d9a9b5), [`b03c0e0`](https://github.com/mastra-ai/mastra/commit/b03c0e0389a799523929a458b0509c9e4244d562), [`0a8366b`](https://github.com/mastra-ai/mastra/commit/0a8366b0a692fcdde56c4d526e4cf03c502ae4ac), [`85664e9`](https://github.com/mastra-ai/mastra/commit/85664e9fd857320fbc245e301f764f45f66f32a3), [`bc79650`](https://github.com/mastra-ai/mastra/commit/bc796500c6e0334faa158a96077e3fb332274869), [`9257d01`](https://github.com/mastra-ai/mastra/commit/9257d01d1366d81f84c582fe02b5e200cf9621f4), [`3a3a59e`](https://github.com/mastra-ai/mastra/commit/3a3a59e8ffaa6a985fe3d9a126a3f5ade11a6724), [`3108d4e`](https://github.com/mastra-ai/mastra/commit/3108d4e649c9fddbf03253a6feeb388a5fa9fa5a), [`0c33b2c`](https://github.com/mastra-ai/mastra/commit/0c33b2c9db537f815e1c59e2c898ffce2e395a79), [`191e5bd`](https://github.com/mastra-ai/mastra/commit/191e5bd29b82f5bda35243945790da7bc7b695c2), [`fde104d`](https://github.com/mastra-ai/mastra/commit/fde104da80935d6e0dd24327e86a51011fcb3173), [`f77cd94`](https://github.com/mastra-ai/mastra/commit/f77cd94c44eabed490384e7d19232a865e13214c), [`e8135c7`](https://github.com/mastra-ai/mastra/commit/e8135c7e300dac5040670eec7eab896ac6092e30), [`daca48f`](https://github.com/mastra-ai/mastra/commit/daca48f0fb17b7ae0b62a2ac40cf0e491b2fd0b7), [`257d14f`](https://github.com/mastra-ai/mastra/commit/257d14faca5931f2e4186fc165b6f0b1f915deee), [`352f25d`](https://github.com/mastra-ai/mastra/commit/352f25da316b24cdd5b410fd8dddf6a8b763da2a), [`93477d0`](https://github.com/mastra-ai/mastra/commit/93477d0769b8a13ea5ed73d508d967fb23eaeed9), [`31c78b3`](https://github.com/mastra-ai/mastra/commit/31c78b3eb28f58a8017f1dcc795c33214d87feac), [`0bc0720`](https://github.com/mastra-ai/mastra/commit/0bc07201095791858087cc56f353fcd65e87ab54), [`36516ac`](https://github.com/mastra-ai/mastra/commit/36516aca1021cbeb42e74751b46a2614101f37c8), [`e947652`](https://github.com/mastra-ai/mastra/commit/e9476527fdecb4449e54570e80dfaf8466901254), [`23b43dd`](https://github.com/mastra-ai/mastra/commit/23b43ddd0e3db05dee828c2733faa2496b7b0319), [`3c6ef79`](https://github.com/mastra-ai/mastra/commit/3c6ef798481e00d6d22563be2de98818fd4dd5e0), [`9257d01`](https://github.com/mastra-ai/mastra/commit/9257d01d1366d81f84c582fe02b5e200cf9621f4), [`ec248f6`](https://github.com/mastra-ai/mastra/commit/ec248f6b56e8a037c066c49b2178e2507471d988)]:
+  - @mastra/core@1.9.0
+  - @mastra/mcp@1.0.3
+
 ## 1.1.7-alpha.0
 
 ### Patch Changes

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mastra/mcp-docs-server",
-  "version": "1.1.7-alpha.0",
+  "version": "1.1.8-alpha.0",
   "description": "MCP server for accessing Mastra.ai documentation, changelogs, and news.",
   "type": "module",
   "main": "dist/index.js",
@@ -29,8 +29,8 @@
     "jsdom": "^26.1.0",
     "local-pkg": "^1.1.2",
     "zod": "^3.25.76",
-    "@mastra/core": "1.9.0-alpha.0",
-    "@mastra/mcp": "^1.0.3-alpha.0"
+    "@mastra/core": "1.10.0-alpha.0",
+    "@mastra/mcp": "^1.1.0-alpha.0"
   },
   "devDependencies": {
     "@hono/node-server": "^1.19.9",
@@ -46,9 +46,9 @@
     "tsx": "^4.21.0",
     "typescript": "^5.9.3",
     "vitest": "4.0.18",
-    "@internal/types-builder": "0.0.38",
-    "@mastra/core": "1.9.0-alpha.0",
-    "@internal/lint": "0.0.63"
+    "@internal/lint": "0.0.65",
+    "@internal/types-builder": "0.0.40",
+    "@mastra/core": "1.10.0-alpha.0"
   },
   "homepage": "https://mastra.ai",
   "repository": {

package/.docs/docs/getting-started/start.md

@@ -1,28 +0,0 @@
-# Start
-
-Create a new Mastra project, or integrate Mastra with your preferred framework to start building.
-
-## New project
-
-The `create mastra` command is the fastest way to build your first agent. It walks you through setup and generates an example agent you can run and adapt in [Studio](https://mastra.ai/docs/getting-started/studio) right away. You can always integrate Mastra with your framework or UI when you’re ready.
-
-- [Quickstart](https://mastra.ai/guides/getting-started/quickstart)
-
-## Integrate with your framework
-
-Add Mastra to an existing project, or scaffold a new Mastra-powered app if you’re starting from scratch.
-
-- [Next.js](https://mastra.ai/guides/getting-started/next-js)
-- [React](https://mastra.ai/guides/getting-started/vite-react)
-- [SvelteKit](https://mastra.ai/guides/getting-started/sveltekit)
-- [Astro](https://mastra.ai/guides/getting-started/astro)
-- [Nuxt](https://mastra.ai/guides/getting-started/nuxt)
-- [Express](https://mastra.ai/guides/getting-started/express)
-- [Hono](https://mastra.ai/guides/getting-started/hono)
-- [Electron](https://mastra.ai/guides/getting-started/electron)
-
-Mastra works great with agentic UI frameworks like [AI SDK UI](https://mastra.ai/guides/build-your-ui/ai-sdk-ui), [CopilotKit](https://mastra.ai/guides/build-your-ui/copilotkit), and [Assistant UI](https://mastra.ai/guides/build-your-ui/assistant-ui). Use them with any of the frontend frameworks above to stream agent responses, render tools, and build chat interfaces.
-
-## Start from a template
-
-Have a use case in mind? Start with a pre-built [template](https://mastra.ai/templates) from Mastra or our community.