@mastra/mcp-docs-server 1.1.8 → 1.1.9-alpha.1

package/.docs/reference/voice/voice.off.md

@@ -2,7 +2,7 @@
 
 The `off()` method removes event listeners previously registered with the `on()` method. This is particularly useful for cleaning up resources and preventing memory leaks in long-running applications with real-time voice capabilities.
 
-## Usage Example
+## Usage example
 
 ```typescript
 import { OpenAIRealtimeVoice } from '@mastra/voice-openai-realtime'
@@ -41,14 +41,14 @@ voice.off('writing', writingCallback)
 
 **callback** (`function`): The same callback function that was passed to on()
 
-## Return Value
+## Return value
 
-This method does not return a value.
+This method doesn't return a value.
 
 ## Notes
 
 - The callback passed to `off()` must be the same function reference that was passed to `on()`
-- If the callback is not found, the method will have no effect
+- If the callback isn't found, the method will have no effect
 - This method is primarily used with real-time voice providers that support event-based communication
 - If called on a voice provider that doesn't support events, it will log a warning and do nothing
 - Removing event listeners is important for preventing memory leaks in long-running applications

package/.docs/reference/voice/voice.on.md

@@ -2,7 +2,7 @@
 
 The `on()` method registers event listeners for various voice events. This is particularly important for real-time voice providers, where events are used to communicate transcribed text, audio responses, and other state changes.
 
-## Usage Example
+## Usage example
 
 ```typescript
 import { OpenAIRealtimeVoice } from '@mastra/voice-openai-realtime'
@@ -52,9 +52,9 @@ voice.on('error', ({ message, code, details }) => {
 
 **callback** (`function`): Callback function that will be called when the event occurs. The callback signature depends on the specific event.
 
-## Return Value
+## Return value
 
-This method does not return a value.
+This method doesn't return a value.
 
 ## Events
 
@@ -71,7 +71,7 @@ Common events include:
 
 Different voice providers may support different sets of events with varying payload structures.
 
-## Using with CompositeVoice
+## Using with `CompositeVoice`
 
 When using `CompositeVoice`, the `on()` method delegates to the configured real-time provider:
 
@@ -108,4 +108,4 @@ voice.on('speaker', stream => {
 - To remove an event listener, use the [voice.off()](https://mastra.ai/reference/voice/voice.off) method with the same event name and callback function
 - Multiple listeners can be registered for the same event
 - The callback function will receive different data depending on the event type (see [Voice Events](https://mastra.ai/reference/voice/voice.events))
-- For best performance, consider removing event listeners when they are no longer needed
+- For best performance, consider removing event listeners when they're no longer needed

package/.docs/reference/voice/voice.send.md

@@ -2,7 +2,7 @@
 
 The `send()` method streams audio data in real-time to voice providers for continuous processing. This method is essential for real-time speech-to-speech conversations, allowing you to send microphone input directly to the AI service.
 
-## Usage Example
+## Usage example
 
 ```typescript
 import { OpenAIRealtimeVoice } from '@mastra/voice-openai-realtime'
@@ -50,7 +50,7 @@ await voice.send(audioBuffer)
 
 **audioData** (`NodeJS.ReadableStream | Int16Array`): Audio data to send to the voice provider. Can be a readable stream (like a microphone stream) or an Int16Array of audio samples.
 
-## Return Value
+## Return value
 
 Returns a `Promise<void>` that resolves when the audio data has been accepted by the voice provider.
 

package/.docs/reference/voice/voice.speak.md

@@ -10,42 +10,52 @@ The `speak()` method is a core function available in all Mastra voice providers
 
 **options.speaker** (`string`): Voice ID to use for this specific request. Overrides the default speaker set in the constructor.
 
-## Return Value
+## Return value
 
 Returns a `Promise<NodeJS.ReadableStream | void>` where:
 
 - `NodeJS.ReadableStream`: A stream of audio data that can be played or saved
 - `void`: When using a realtime voice provider that emits audio through events instead of returning it directly
 
-## Provider-Specific Options
+## Provider-specific options
 
 Each voice provider may support additional options specific to their implementation. Here are some examples:
 
 ### OpenAI
 
-**options.speed** (`number`): Speech speed multiplier. Values between 0.25 and 4.0 are supported. (Default: `1.0`)
+**options** (`Options`): Configuration options.
+
+**options.speed** (`number`): Speech speed multiplier. Values between 0.25 and 4.0 are supported.
 
 ### ElevenLabs
 
-**options.stability** (`number`): Voice stability. Higher values result in more stable, less expressive speech. (Default: `0.5`)
+**options** (`Options`): Configuration options.
+
+**options.stability** (`number`): Voice stability. Higher values result in more stable, less expressive speech.
 
-**options.similarity\_boost** (`number`): Voice clarity and similarity to the original voice. (Default: `0.75`)
+**options.similarity\_boost** (`number`): Voice clarity and similarity to the original voice.
 
 ### Google
 
+**options** (`Options`): Configuration options.
+
 **options.languageCode** (`string`): Language code for the voice (e.g., 'en-US').
 
-**options.audioConfig** (`object`): Audio configuration options from Google Cloud Text-to-Speech API. (Default: `{ audioEncoding: 'LINEAR16' }`)
+**options.audioConfig** (`object`): Audio configuration options from Google Cloud Text-to-Speech API.
 
 ### Murf
 
+**options** (`Options`): Configuration options.
+
+**options.properties** (`object`): properties configuration.
+
 **options.properties.rate** (`number`): Speech rate multiplier.
 
 **options.properties.pitch** (`number`): Voice pitch adjustment.
 
 **options.properties.format** (`'MP3' | 'WAV' | 'FLAC' | 'ALAW' | 'ULAW'`): Output audio format.
 
-## Usage Example
+## Usage example
 
 ```typescript
 import { OpenAIVoice } from '@mastra/voice-openai'
@@ -70,7 +80,7 @@ const textStream = Readable.from(['Hello', ' from', ' a', ' stream!'])
 const audioStreamFromTextStream = await voice.speak(textStream)
 ```
 
-## Using with CompositeVoice
+## Using with `CompositeVoice`
 
 When using `CompositeVoice`, the `speak()` method delegates to the configured speaking provider:
 
@@ -120,7 +130,7 @@ const audioWithOptions = await voice.speak('Hello with options!', {
 
 See the [CompositeVoice reference](https://mastra.ai/reference/voice/composite-voice) for more details on AI SDK integration.
 
-## Realtime Voice Providers
+## Realtime voice providers
 
 When using realtime voice providers like `OpenAIRealtimeVoice`, the `speak()` method behaves differently:
 

package/.docs/reference/voice/voice.updateConfig.md

@@ -2,7 +2,7 @@
 
 The `updateConfig()` method allows you to update the configuration of a voice provider at runtime. This is useful for changing voice settings, API keys, or other provider-specific options without creating a new instance.
 
-## Usage Example
+## Usage example
 
 ```typescript
 import { OpenAIRealtimeVoice } from '@mastra/voice-openai-realtime'
@@ -37,11 +37,11 @@ await voice.speak('Hello with my new voice!')
 
 **options** (`Record<string, unknown>`): Configuration options to update. The specific properties depend on the voice provider.
 
-## Return Value
+## Return value
 
-This method does not return a value.
+This method doesn't return a value.
 
-## Configuration Options
+## Configuration options
 
 Different voice providers support different configuration options:
 

package/.docs/reference/workflows/run-methods/startAsync.md

@@ -40,7 +40,7 @@ const result = await workflow.getWorkflowRunExecutionResult(runId)
 
 **runId** (`string`): The unique identifier for this workflow run. Use this to check status or retrieve results later.
 
-## When to use startAsync()
+## When to use `startAsync()`
 
 Use `startAsync()` instead of `start()` when:
 

package/.docs/reference/workflows/run-methods/timeTravel.md

@@ -147,7 +147,7 @@ const result = await run.timeTravel({
 - Step results before the target step are reconstructed from the snapshot or provided context
 - Execution begins from the specified step with the provided or reconstructed input data
 - The workflow continues to completion from that point forward
-- Time travel can be used on workflows that have not been run yet by providing custom context or input data for the step to start from.
+- Time travel can be used on workflows that haven't been run yet by providing custom context or input data for the step to start from.
 
 ## Related
 

package/.docs/reference/workflows/run.md

@@ -1,4 +1,4 @@
-# Run Class
+# Run class
 
 The `Run` class represents a workflow execution instance, providing methods to start, resume, stream, and monitor workflow execution.
 
@@ -18,7 +18,7 @@ if (result.status === 'suspended') {
 }
 ```
 
-## Run Methods
+## Run methods
 
 **start** (`(options?: StartOptions) => Promise<WorkflowResult>`): Starts workflow execution with input data
 
@@ -36,7 +36,7 @@ if (result.status === 'suspended') {
 
 **timeTravelStream** (`(options?: TimeTravelOptions) => MastraWorkflowStream`): Time travels a workflow execution with streaming support
 
-## Run Status
+## Run status
 
 A workflow run's `status` indicates its current execution state. The possible values are:
 

package/.docs/reference/workflows/step.md

@@ -1,4 +1,4 @@
-# Step Class
+# Step class
 
 The Step class defines individual units of work within a workflow, encapsulating execution logic, data validation, and input/output handling. It can take either a tool or an agent as a parameter to automatically create a step from them.
 
@@ -64,7 +64,7 @@ const agentStep = createStep(testAgent, {
 
 **onFinish** (`(result: AgentResult) => void`): Callback invoked when the agent completes generation.
 
-## Constructor Parameters
+## Constructor parameters
 
 **id** (`string`): Unique identifier for the step
 

package/.docs/reference/workflows/workflow-methods/create-run.md

@@ -34,7 +34,7 @@ const result = await run.start({
 })
 ```
 
-## Using resourceId
+## Using `resourceId`
 
 The `resourceId` parameter associates a workflow run with a specific resource, such as a user or tenant. This is useful for multi-tenant applications or when you need to track which user initiated a workflow.
 

package/.docs/reference/workflows/workflow.md

@@ -1,4 +1,4 @@
-# Workflow Class
+# Workflow class
 
 The `Workflow` class enables you to create state machines for complex sequences of operations with conditional branching and data validation.
 

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

@@ -0,0 +1,164 @@
+# BlaxelSandbox
+
+Executes commands in isolated [Blaxel](https://blaxel.ai/) cloud sandboxes. Provides secure, isolated code execution environments with support for mounting cloud storage (S3, GCS) via FUSE.
+
+> **Info:** For interface details, see [WorkspaceSandbox interface](https://mastra.ai/reference/workspace/sandbox).
+
+## Installation
+
+**npm**:
+
+```bash
+npm install @mastra/blaxel
+```
+
+**pnpm**:
+
+```bash
+pnpm add @mastra/blaxel
+```
+
+**Yarn**:
+
+```bash
+yarn add @mastra/blaxel
+```
+
+**Bun**:
+
+```bash
+bun add @mastra/blaxel
+```
+
+## Usage
+
+Add a `BlaxelSandbox` to a workspace and assign it to an agent:
+
+```typescript
+import { Agent } from '@mastra/core/agent'
+import { Workspace } from '@mastra/core/workspace'
+import { BlaxelSandbox } from '@mastra/blaxel'
+
+const workspace = new Workspace({
+  sandbox: new BlaxelSandbox(),
+})
+
+const agent = new Agent({
+  id: 'code-agent',
+  name: 'Code Agent',
+  instructions: 'You are a coding assistant working in this workspace.',
+  model: 'anthropic/claude-sonnet-4-6',
+  workspace,
+})
+```
+
+### Custom image with resources
+
+Use a custom Docker image with additional memory:
+
+```typescript
+const workspace = new Workspace({
+  sandbox: new BlaxelSandbox({
+    image: 'node:20-slim',
+    memory: 8192,
+    timeout: '10m',
+  }),
+})
+```
+
+## Constructor parameters
+
+**id** (`string`): Unique identifier for this sandbox instance. (Default: `Auto-generated`)
+
+**image** (`string`): Docker image to use for the sandbox. Debian-based images support both S3 and GCS mounts. Alpine-based images support S3 mounts only. (Default: `'blaxel/ts-app:latest'`)
+
+**memory** (`number`): Memory allocation in MB. (Default: `4096`)
+
+**timeout** (`string`): Execution timeout as a duration string (e.g. '5m', '1h'). Maps to the Blaxel sandbox TTL.
+
+**env** (`Record<string, string>`): Environment variables to set in the sandbox.
+
+**labels** (`Record<string, string>`): Custom labels for the sandbox.
+
+**runtimes** (`SandboxRuntime[]`): Supported runtimes. Valid values: 'node', 'python', 'bash', 'ruby', 'go', 'rust', 'java', 'cpp', 'r'. (Default: `['node', 'python', 'bash']`)
+
+**ports** (`Array<{ name?: string; target: number; protocol?: 'HTTP' | 'TCP' | 'UDP' }>`): Ports to expose from the sandbox.
+
+## Properties
+
+**id** (`string`): Sandbox instance identifier.
+
+**name** (`string`): 'BlaxelSandbox'
+
+**provider** (`string`): 'blaxel'
+
+**status** (`ProviderStatus`): 'pending' | 'initializing' | 'running' | 'stopped' | 'error'
+
+**instance** (`SandboxInstance`): The underlying Blaxel SandboxInstance for direct access to Blaxel APIs. Throws SandboxNotReadyError if the sandbox has not been started.
+
+**processes** (`BlaxelProcessManager`): Background process manager. See \[SandboxProcessManager reference]\(/reference/workspace/process-manager).
+
+## Background processes
+
+`BlaxelSandbox` includes a built-in process manager for spawning and managing background processes.
+
+```typescript
+const sandbox = new BlaxelSandbox({ id: 'dev-sandbox' })
+await sandbox.start()
+
+// Spawn a background process
+const handle = await sandbox.processes.spawn('node server.js', {
+  env: { PORT: '3000' },
+  onStdout: data => console.log(data),
+})
+
+// Interact with the process
+console.log(handle.stdout)
+await handle.kill()
+```
+
+> **Note:** Blaxel sandboxes don't support stdin. Calling `handle.sendStdin()` throws an error.
+
+See [`SandboxProcessManager` reference](https://mastra.ai/reference/workspace/process-manager) for the full API.
+
+## Mounting cloud storage
+
+Blaxel sandboxes can mount S3 or GCS filesystems, making cloud storage accessible as a local directory inside the sandbox.
+
+### S3
+
+```typescript
+import { Workspace } from '@mastra/core/workspace'
+import { S3Filesystem } from '@mastra/s3'
+import { BlaxelSandbox } from '@mastra/blaxel'
+
+const workspace = new Workspace({
+  mounts: {
+    '/data': new S3Filesystem({
+      bucket: 'my-bucket',
+      region: 'us-east-1',
+      accessKeyId: process.env.AWS_ACCESS_KEY_ID,
+      secretAccessKey: process.env.AWS_SECRET_ACCESS_KEY,
+    }),
+  },
+  sandbox: new BlaxelSandbox(),
+})
+```
+
+### GCS
+
+```typescript
+import { Workspace } from '@mastra/core/workspace'
+import { GCSFilesystem } from '@mastra/gcs'
+import { BlaxelSandbox } from '@mastra/blaxel'
+
+const workspace = new Workspace({
+  mounts: {
+    '/data': new GCSFilesystem({
+      bucket: 'my-bucket',
+      credentials: JSON.parse(process.env.GCS_SERVICE_ACCOUNT_KEY!),
+    }),
+  },
+  sandbox: new BlaxelSandbox(),
+})
+```