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

package/.docs/reference/voice/azure.md

@@ -2,7 +2,7 @@
 
 The AzureVoice class in Mastra provides text-to-speech and speech-to-text capabilities using Microsoft Azure Cognitive Services.
 
-## Usage Example
+## Usage example
 
 This requires Azure Speech Services credentials that can be provided through environment variables or directly in the configuration:
 
@@ -35,7 +35,7 @@ const text = await voice.listen(audioStream)
 
 ## Configuration
 
-### Constructor Options
+### Constructor options
 
 **speechModel** (`AzureSpeechConfig`): Configuration for text-to-speech synthesis.
 
@@ -61,17 +61,19 @@ const text = await voice.listen(audioStream)
 
 ## Methods
 
-### speak()
+### `speak()`
 
 Converts text to speech using Azure's neural text-to-speech service.
 
 **input** (`string | NodeJS.ReadableStream`): Text or text stream to convert to speech.
 
-**options.speaker** (`string`): Voice ID to use for speech synthesis (e.g., 'en-US-JennyNeural'). Overrides the default voice. (Default: `Constructor's speaker value`)
+**options** (`Options`): Configuration options.
+
+**options.speaker** (`string`): Voice ID to use for speech synthesis (e.g., 'en-US-JennyNeural'). Overrides the default voice.
 
 Returns: `Promise<NodeJS.ReadableStream>` - Audio stream in WAV format
 
-### listen()
+### `listen()`
 
 Transcribes audio using Azure's speech-to-text service.
 
@@ -81,7 +83,7 @@ Returns: `Promise<string>` - The recognized text from the audio
 
 **Note:** Language and recognition settings are configured in the `listeningModel` configuration during initialization, not passed as options to this method.
 
-### getSpeakers()
+### `getSpeakers()`
 
 Returns an array of available voice options (200+ voices), where each node contains:
 
@@ -93,17 +95,17 @@ Returns an array of available voice options (200+ voices), where each node conta
 
 Returns: `Promise<Array<{ voiceId: string; language: string; region: string; }>>`
 
-## Important Notes
+## Important notes
 
 ### Azure Speech Services vs Azure OpenAI
 
 **⚠️ Critical:** This package uses **Azure Speech Services**, which is different from **Azure OpenAI Services**.
 
-- **DO NOT** use your `AZURE_OPENAI_API_KEY` for this package
+- **DON'T** use your `AZURE_OPENAI_API_KEY` for this package
 - **DO** use an Azure Speech Services subscription key (obtain from Azure Portal under "Speech Services")
 - These are separate Azure resources with different API keys and endpoints
 
-### Environment Variables
+### Environment variables
 
 API keys and regions can be provided via constructor options or environment variables:
 
@@ -118,7 +120,7 @@ API keys and regions can be provided via constructor options or environment vari
 - Audio output is in WAV format
 - Audio input for recognition must be in WAV format
 
-## Available Voices
+## Available voices
 
 Azure provides 200+ neural voices across many languages. Some popular English voices include:
 

package/.docs/reference/voice/cloudflare.md

@@ -2,7 +2,7 @@
 
 The CloudflareVoice class in Mastra provides text-to-speech capabilities using Cloudflare Workers AI. This provider specializes in efficient, low-latency speech synthesis suitable for edge computing environments.
 
-## Usage Example
+## Usage example
 
 ```typescript
 import { CloudflareVoice } from '@mastra/voice-cloudflare'
@@ -29,7 +29,7 @@ console.log(speakers)
 
 ## Configuration
 
-### Constructor Options
+### Constructor options
 
 **speechModel** (`CloudflareSpeechConfig`): Configuration for text-to-speech synthesis.
 
@@ -43,19 +43,21 @@ console.log(speakers)
 
 ## Methods
 
-### speak()
+### `speak()`
 
 Converts text to speech using Cloudflare's text-to-speech service.
 
 **input** (`string | NodeJS.ReadableStream`): Text or text stream to convert to speech.
 
-**options.speaker** (`string`): Voice ID to use for speech synthesis. (Default: `Constructor's speaker value`)
+**options** (`Options`): Configuration options.
 
-**options.format** (`string`): Output audio format. (Default: `'mp3'`)
+**options.speaker** (`string`): Voice ID to use for speech synthesis.
+
+**options.format** (`string`): Output audio format.
 
 Returns: `Promise<NodeJS.ReadableStream>`
 
-### getSpeakers()
+### `getSpeakers()`
 
 Returns an array of available voice options, where each node contains:
 
@@ -72,7 +74,7 @@ Returns an array of available voice options, where each node contains:
 - For production use, ensure your Cloudflare account has the appropriate Workers AI subscription
 - Voice options are more limited compared to some other providers, but performance at the edge is excellent
 
-## Related Providers
+## Related providers
 
 If you need speech-to-text capabilities in addition to text-to-speech, consider using one of these providers:
 

package/.docs/reference/voice/composite-voice.md

@@ -4,7 +4,7 @@ The CompositeVoice class allows you to combine different voice providers for tex
 
 CompositeVoice supports both Mastra voice providers and AI SDK model providers
 
-## Constructor Parameters
+## Constructor parameters
 
 **config** (`object`): Configuration object for the composite voice service
 
@@ -16,7 +16,7 @@ CompositeVoice supports both Mastra voice providers and AI SDK model providers
 
 ## Methods
 
-### speak()
+### `speak()`
 
 Converts text to speech using the configured speaking provider.
 
@@ -30,7 +30,7 @@ Notes:
 - Options are passed through to the configured speaking provider
 - Returns a stream of audio data
 
-### listen()
+### `listen()`
 
 Converts speech to text using the configured listening provider.
 
@@ -44,7 +44,7 @@ Notes:
 - Options are passed through to the configured listening provider
 - Returns either a string or a stream of transcribed text, depending on the provider
 
-### getSpeakers()
+### `getSpeakers()`
 
 Returns a list of available voices from the speaking provider, where each node contains:
 
@@ -59,7 +59,7 @@ Notes:
 - Each voice object will have at least a voiceId property
 - Additional voice properties depend on the speaking provider
 
-## Usage Examples
+## Usage examples
 
 ### Using Mastra Voice Providers
 

package/.docs/reference/voice/deepgram.md

@@ -2,7 +2,7 @@
 
 The Deepgram voice implementation in Mastra provides text-to-speech (TTS) and speech-to-text (STT) capabilities using Deepgram's API. It supports multiple voice models and languages, with configurable options for both speech synthesis and transcription.
 
-## Usage Example
+## Usage example
 
 ```typescript
 import { DeepgramVoice } from '@mastra/voice-deepgram'
@@ -30,7 +30,7 @@ const audioStream = await voice.speak('Hello, world!')
 const transcript = await voice.listen(audioStream)
 ```
 
-## Constructor Parameters
+## Constructor parameters
 
 **speechModel** (`DeepgramVoiceConfig`): Configuration for text-to-speech functionality. (Default: `{ name: 'aura' }`)
 
@@ -56,7 +56,7 @@ const transcript = await voice.listen(audioStream)
 
 ## Methods
 
-### speak()
+### `speak()`
 
 Converts text to speech using the configured speech model and voice.
 
@@ -68,7 +68,7 @@ Converts text to speech using the configured speech model and voice.
 
 Returns: `Promise<NodeJS.ReadableStream>`
 
-### listen()
+### `listen()`
 
 Converts speech to text using the configured listening model.
 
@@ -78,7 +78,7 @@ Converts speech to text using the configured listening model.
 
 Returns: `Promise<string>`
 
-### getSpeakers()
+### `getSpeakers()`
 
 Returns a list of available voice options.
 

package/.docs/reference/voice/elevenlabs.md

@@ -2,7 +2,7 @@
 
 The ElevenLabs voice implementation in Mastra provides high-quality text-to-speech (TTS) and speech-to-text (STT) capabilities using the ElevenLabs API.
 
-## Usage Example
+## Usage example
 
 ```typescript
 import { ElevenLabsVoice } from '@mastra/voice-elevenlabs'
@@ -26,7 +26,7 @@ const audioStream = await voice.speak('Hello, world!')
 const speakers = await voice.getSpeakers()
 ```
 
-## Constructor Parameters
+## Constructor parameters
 
 **speechModel** (`ElevenLabsVoiceConfig`): Configuration for text-to-speech functionality. (Default: `{ name: 'eleven_multilingual_v2' }`)
 
@@ -38,7 +38,7 @@ const speakers = await voice.getSpeakers()
 
 ## Methods
 
-### speak()
+### `speak()`
 
 Converts text to speech using the configured speech model and voice.
 
@@ -50,7 +50,7 @@ Converts text to speech using the configured speech model and voice.
 
 Returns: `Promise<NodeJS.ReadableStream>`
 
-### getSpeakers()
+### `getSpeakers()`
 
 Returns an array of available voice options, where each node contains:
 
@@ -62,7 +62,7 @@ Returns an array of available voice options, where each node contains:
 
 **gender** (`string`): Gender of the voice
 
-### listen()
+### `listen()`
 
 Converts audio input to text using ElevenLabs Speech-to-Text API.
 
@@ -88,9 +88,9 @@ The options object supports the following properties:
 
 Returns: `Promise<string>` - A Promise that resolves to the transcribed text
 
-## Important Notes
+## Important notes
 
 1. An ElevenLabs API key is required. Set it via the `ELEVENLABS_API_KEY` environment variable or pass it in the constructor.
 2. The default speaker is set to Aria (ID: '9BWtsMINqrJLrRacOk9x').
-3. Speech-to-text functionality is not supported by ElevenLabs.
+3. Speech-to-text functionality isn't supported by ElevenLabs.
 4. Available speakers can be retrieved using the `getSpeakers()` method, which returns detailed information about each voice including language and gender.

package/.docs/reference/voice/google-gemini-live.md

@@ -1,8 +1,8 @@
-# Google Gemini Live Voice
+# Google Gemini Live voice
 
 The GeminiLiveVoice class provides real-time voice interaction capabilities using Google's Gemini Live API. It supports bidirectional audio streaming, tool calling, session management, and both standard Google API and Vertex AI authentication methods.
 
-## Usage Example
+## Usage example
 
 ```typescript
 import { GeminiLiveVoice } from '@mastra/voice-google-gemini-live'
@@ -88,7 +88,7 @@ voice.close()
 
 ## Configuration
 
-### Constructor Options
+### Constructor options
 
 **apiKey** (`string`): Google API key for Gemini API authentication. Required unless using Vertex AI.
 
@@ -122,7 +122,7 @@ voice.close()
 
 ## Methods
 
-### connect()
+### `connect()`
 
 Establishes a connection to the Gemini Live API. Must be called before using speak, listen, or send methods.
 
@@ -130,7 +130,7 @@ Establishes a connection to the Gemini Live API. Must be called before using spe
 
 **returns** (`Promise<void>`): Promise that resolves when the connection is established.
 
-### speak()
+### `speak()`
 
 Converts text to speech and sends it to the model. Can accept either a string or a readable stream as input.
 
@@ -138,15 +138,15 @@ Converts text to speech and sends it to the model. Can accept either a string or
 
 **options** (`GeminiLiveVoiceOptions`): Optional speech configuration.
 
-**options.speaker** (`GeminiVoiceName`): Voice ID to use for this specific speech request. (Default: `Constructor's speaker value`)
+**options.speaker** (`GeminiVoiceName`): Voice ID to use for this specific speech request.
 
 **options.languageCode** (`string`): Language code for the response.
 
-**options.responseModalities** (`('AUDIO' | 'TEXT')[]`): Response modalities to receive from the model. (Default: `['AUDIO', 'TEXT']`)
+**options.responseModalities** (`('AUDIO' | 'TEXT')[]`): Response modalities to receive from the model.
 
 Returns: `Promise<void>` (responses are emitted via `speaker` and `writing` events)
 
-### listen()
+### `listen()`
 
 Processes audio input for speech recognition. Takes a readable stream of audio data and returns the transcribed text.
 
@@ -156,7 +156,7 @@ Processes audio input for speech recognition. Takes a readable stream of audio d
 
 Returns: `Promise<string>` - The transcribed text
 
-### send()
+### `send()`
 
 Streams audio data in real-time to the Gemini service for continuous audio streaming scenarios like live microphone input.
 
@@ -164,7 +164,7 @@ Streams audio data in real-time to the Gemini service for continuous audio strea
 
 Returns: `Promise<void>`
 
-### updateSessionConfig()
+### `updateSessionConfig()`
 
 Updates the session configuration dynamically. This can be used to modify voice settings, speaker selection, and other runtime configurations.
 
@@ -172,7 +172,7 @@ Updates the session configuration dynamically. This can be used to modify voice
 
 Returns: `Promise<void>`
 
-### addTools()
+### `addTools()`
 
 Adds a set of tools to the voice instance. Tools allow the model to perform additional actions during conversations. When GeminiLiveVoice is added to an Agent, any tools configured for the Agent will automatically be available to the voice interface.
 
@@ -180,7 +180,7 @@ Adds a set of tools to the voice instance. Tools allow the model to perform addi
 
 Returns: `void`
 
-### addInstructions()
+### `addInstructions()`
 
 Adds or updates system instructions for the model.
 
@@ -188,7 +188,7 @@ Adds or updates system instructions for the model.
 
 Returns: `void`
 
-### answer()
+### `answer()`
 
 Triggers a response from the model. This method is primarily used internally when integrated with an Agent.
 
@@ -196,25 +196,25 @@ Triggers a response from the model. This method is primarily used internally whe
 
 Returns: `Promise<void>`
 
-### getSpeakers()
+### `getSpeakers()`
 
 Returns a list of available voice speakers for the Gemini Live API.
 
 Returns: `Promise<Array<{ voiceId: string; description?: string }>>`
 
-### disconnect()
+### `disconnect()`
 
 Disconnects from the Gemini Live session and cleans up resources. This is the async method that properly handles cleanup.
 
 Returns: `Promise<void>`
 
-### close()
+### `close()`
 
 Synchronous wrapper for disconnect(). Calls disconnect() internally without awaiting.
 
 Returns: `void`
 
-### on()
+### `on()`
 
 Registers an event listener for voice events.
 
@@ -224,7 +224,7 @@ Registers an event listener for voice events.
 
 Returns: `void`
 
-### off()
+### `off()`
 
 Removes a previously registered event listener.
 
@@ -256,7 +256,7 @@ The GeminiLiveVoice class emits the following events:
 
 **interrupt** (`event`): Interrupt events. Callback receives { type: 'user' | 'model', timestamp: number }.
 
-## Available Models
+## Available models
 
 The following Gemini Live models are available:
 
@@ -268,7 +268,7 @@ The following Gemini Live models are available:
 - `gemini-live-2.5-flash-preview`
 - `gemini-2.6.flash-preview-tts`
 
-## Available Voices
+## Available voices
 
 The following voice options are available:
 
@@ -277,7 +277,7 @@ The following voice options are available:
 - `Kore`: Neutral, professional
 - `Fenrir`: Warm, approachable
 
-## Authentication Methods
+## Authentication methods
 
 ### Gemini API (Development)
 
@@ -319,7 +319,7 @@ const voice = new GeminiLiveVoice({
 })
 ```
 
-## Advanced Features
+## Advanced features
 
 ### Session Management
 

package/.docs/reference/voice/google.md

@@ -2,7 +2,7 @@
 
 The Google Voice implementation in Mastra provides both text-to-speech (TTS) and speech-to-text (STT) capabilities using Google Cloud services. It supports multiple voices, languages, advanced audio configuration options, and both standard API key authentication and Vertex AI mode for enterprise deployments.
 
-## Usage Example
+## Usage example
 
 ```typescript
 import { GoogleVoice } from '@mastra/voice-google'
@@ -30,7 +30,7 @@ const transcript = await voice.listen(audioStream, {
 const voices = await voice.getSpeakers({ languageCode: 'en-US' })
 ```
 
-## Constructor Parameters
+## Constructor parameters
 
 **speechModel** (`GoogleModelConfig`): Configuration for text-to-speech functionality (Default: `{ apiKey: process.env.GOOGLE_API_KEY }`)
 
@@ -58,7 +58,7 @@ const voices = await voice.getSpeakers({ languageCode: 'en-US' })
 
 ## Methods
 
-### speak()
+### `speak()`
 
 Converts text to speech using Google Cloud Text-to-Speech service.
 
@@ -70,11 +70,11 @@ Converts text to speech using Google Cloud Text-to-Speech service.
 
 **options.languageCode** (`string`): Language code for the voice (e.g., 'en-US'). Defaults to the language code from the speaker ID or 'en-US'
 
-**options.audioConfig** (`ISynthesizeSpeechRequest['audioConfig']`): Audio configuration options from Google Cloud Text-to-Speech API (Default: `{ audioEncoding: 'LINEAR16' }`)
+**options.audioConfig** (`ISynthesizeSpeechRequest['audioConfig']`): Audio configuration options from Google Cloud Text-to-Speech API
 
 Returns: `Promise<NodeJS.ReadableStream>`
 
-### listen()
+### `listen()`
 
 Converts speech to text using Google Cloud Speech-to-Text service.
 
@@ -84,11 +84,11 @@ Converts speech to text using Google Cloud Speech-to-Text service.
 
 **options.stream** (`boolean`): Whether to use streaming recognition
 
-**options.config** (`IRecognitionConfig`): Recognition configuration from Google Cloud Speech-to-Text API (Default: `{ encoding: 'LINEAR16', languageCode: 'en-US' }`)
+**options.config** (`IRecognitionConfig`): Recognition configuration from Google Cloud Speech-to-Text API
 
 Returns: `Promise<string>`
 
-### getSpeakers()
+### `getSpeakers()`
 
 Returns an array of available voice options, where each node contains:
 
@@ -96,19 +96,19 @@ Returns an array of available voice options, where each node contains:
 
 **languageCodes** (`string[]`): List of language codes supported by this voice
 
-### isUsingVertexAI()
+### `isUsingVertexAI()`
 
 Checks if Vertex AI mode is enabled.
 
 Returns: `boolean` - `true` if using Vertex AI, `false` otherwise
 
-### getProject()
+### `getProject()`
 
 Gets the configured Google Cloud project ID.
 
 Returns: `string | undefined` - The project ID or `undefined` if not set
 
-### getLocation()
+### `getLocation()`
 
 Gets the configured Google Cloud location/region.
 
@@ -120,7 +120,7 @@ The Google Voice provider supports two authentication methods:
 
 ### Standard Mode (API Key)
 
-Uses a Google Cloud API key for authentication. Suitable for development and simple use cases.
+Uses a Google Cloud API key for authentication. Suitable for development and basic use cases.
 
 ```typescript
 // Using environment variable (GOOGLE_API_KEY)
@@ -208,7 +208,7 @@ For long-audio Text-to-Speech operations:
 - `operations.get` - Get operation status
 - `operations.list` - List operations
 
-## Important Notes
+## Important notes
 
 1. **Authentication**: Either a Google Cloud API key (standard mode) or service account credentials (Vertex AI mode) is required.
 

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

@@ -2,7 +2,7 @@
 
 The MastraVoice class is an abstract base class that defines the core interface for voice services in Mastra. All voice provider implementations (like OpenAI, Deepgram, PlayAI, Speechify) extend this class to provide their specific functionality. The class now includes support for real-time speech-to-speech capabilities through WebSocket connections.
 
-## Usage Example
+## Usage example
 
 ```typescript
 import { MastraVoice } from '@mastra/core/voice'
@@ -77,7 +77,7 @@ class MyVoiceProvider extends MastraVoice {
 }
 ```
 
-## Constructor Parameters
+## Constructor parameters
 
 **config** (`VoiceConfig`): Configuration object for the voice service
 
@@ -105,11 +105,11 @@ class MyVoiceProvider extends MastraVoice {
 
 **config.realtimeConfig.options** (`unknown`): Provider-specific options for real-time capabilities
 
-## Abstract Methods
+## Abstract methods
 
 These methods must be implemented by unknown class extending MastraVoice.
 
-### speak()
+### `speak()`
 
 Converts text to speech using the configured speech model.
 
@@ -131,7 +131,7 @@ Purpose:
 - Returns a stream of audio data that can be played or saved
 - May return void if the audio is handled by emitting 'speaking' event
 
-### listen()
+### `listen()`
 
 Converts speech to text using the configured listening model.
 
@@ -152,7 +152,7 @@ Purpose:
 - Not all providers support this functionality (e.g., PlayAI, Speechify)
 - May return void if the transcription is handled by emitting 'writing' event
 
-### getSpeakers()
+### `getSpeakers()`
 
 Returns a list of available voices supported by the provider.
 
@@ -167,11 +167,11 @@ Purpose:
 - Providers can include additional metadata about each voice
 - Used to discover available voices for text-to-speech conversion
 
-## Optional Methods
+## Optional methods
 
 These methods have default implementations but can be overridden by voice providers that support speech-to-speech capabilities.
 
-### connect()
+### `connect()`
 
 Establishes a WebSocket or WebRTC connection for communication.
 
@@ -186,7 +186,7 @@ Purpose:
 - Returns a Promise that resolves when the connection is established
 - Configuration is provider-specific
 
-### send()
+### `send()`
 
 Streams audio data in real-time to the voice provider.
 
@@ -201,7 +201,7 @@ Purpose:
 - Supports both ReadableStream and Int16Array audio formats
 - Must be in connected state before calling this method
 
-### answer()
+### `answer()`
 
 Triggers the voice provider to generate a response.
 
@@ -215,7 +215,7 @@ Purpose:
 - Used in real-time conversations to prompt the AI to respond
 - Response will be emitted through the event system (e.g., 'speaking' event)
 
-### addTools()
+### `addTools()`
 
 Equips the voice provider with tools that can be used during conversations.
 
@@ -229,7 +229,7 @@ Purpose:
 - Tools can extend the capabilities of the voice provider
 - Implementation is provider-specific
 
-### close()
+### `close()`
 
 Disconnects from the WebSocket or WebRTC connection.
 
@@ -243,7 +243,7 @@ Purpose:
 - Cleans up resources and stops any ongoing real-time processing
 - Should be called when you're done with the voice instance
 
-### on()
+### `on()`
 
 Registers an event listener for voice events.
 
@@ -261,7 +261,7 @@ Purpose:
 - Providers can emit custom events as well
 - Event data structure depends on the event type
 
-### off()
+### `off()`
 
 Removes an event listener.
 
@@ -277,7 +277,7 @@ Purpose:
 - Removes a previously registered event listener
 - Used to clean up event handlers when they're no longer needed
 
-## Event System
+## Event system
 
 The MastraVoice class includes an event system for real-time communication. Standard event types include:
 
@@ -287,7 +287,7 @@ The MastraVoice class includes an event system for real-time communication. Stan
 
 **error** (`{ message: string; code?: string; details?: unknown }`): Emitted when an error occurs
 
-## Protected Properties
+## Protected properties
 
 **listeningModel** (`BuiltInModelConfig | undefined`): Configuration for the speech-to-text model
 
@@ -297,13 +297,13 @@ The MastraVoice class includes an event system for real-time communication. Stan
 
 **realtimeConfig** (`{ model?: string; apiKey?: string; options?: unknown } | undefined`): Configuration for real-time speech-to-speech capabilities
 
-## Telemetry Support
+## Telemetry support
 
 MastraVoice includes built-in telemetry support through the `traced` method, which wraps method calls with performance tracking and error monitoring.
 
 ## Notes
 
-- MastraVoice is an abstract class and cannot be instantiated directly
+- MastraVoice is an abstract class and can't be instantiated directly
 - Implementations must provide concrete implementations for all abstract methods
 - The class provides a consistent interface across different voice service providers
 - Speech-to-speech capabilities are optional and provider-specific