@mastra/mcp-docs-server 1.1.9-alpha.0 → 1.1.9-alpha.2

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.
 
@@ -74,7 +74,7 @@ Converts text to speech using Google Cloud Text-to-Speech service.
 
 Returns: `Promise<NodeJS.ReadableStream>`
 
-### listen()
+### `listen()`
 
 Converts speech to text using Google Cloud Speech-to-Text service.
 
@@ -88,7 +88,7 @@ Converts speech to text using Google Cloud Speech-to-Text service.
 
 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.
 
@@ -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,7 +297,7 @@ 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.
 

package/.docs/reference/voice/murf.md

@@ -2,7 +2,7 @@
 
 The Murf voice implementation in Mastra provides text-to-speech (TTS) capabilities using Murf's AI voice service. It supports multiple voices across different languages.
 
-## Usage Example
+## Usage example
 
 ```typescript
 import { MurfVoice } from '@mastra/voice-murf'
@@ -43,7 +43,7 @@ const audioStream = await voice.speak('Hello, world!', {
 const voices = await voice.getSpeakers()
 ```
 
-## Constructor Parameters
+## Constructor parameters
 
 **speechModel** (`MurfConfig`): Configuration for text-to-speech functionality (Default: `{ name: 'GEN2' }`)
 
@@ -79,7 +79,7 @@ const voices = await voice.getSpeakers()
 
 ## Methods
 
-### speak()
+### `speak()`
 
 Converts text to speech using Murf's API.
 
@@ -93,7 +93,7 @@ Converts text to speech using Murf's API.
 
 Returns: `Promise<NodeJS.ReadableStream>`
 
-### getSpeakers()
+### `getSpeakers()`
 
 Returns an array of available voice options, where each node contains:
 
@@ -105,11 +105,11 @@ Returns an array of available voice options, where each node contains:
 
 **gender** (`string`): Gender of the voice
 
-### listen()
+### `listen()`
 
 This method isn't supported by Murf and will throw an error. Murf doesn't provide speech-to-text functionality.
 
-## Important Notes
+## Important notes
 
 1. A Murf API key is required. Set it via the `MURF_API_KEY` environment variable or pass it in the constructor.
 2. The service uses GEN2 as the default model version.

package/.docs/reference/voice/openai-realtime.md

@@ -1,8 +1,8 @@
-# OpenAI Realtime Voice
+# OpenAI Realtime voice
 
 The OpenAIRealtimeVoice class provides real-time voice interaction capabilities using OpenAI's WebSocket-based API. It supports real time speech to speech, voice activity detection, and event-based audio streaming.
 
-## Usage Example
+## Usage example
 
 ```typescript
 import { OpenAIRealtimeVoice } from '@mastra/voice-openai-realtime'
@@ -55,7 +55,7 @@ voice.connect()
 
 ## Configuration
 
-### Constructor Options
+### Constructor options
 
 **model** (`string`): The model ID to use for real-time voice interactions. (Default: `'gpt-5.1-realtime-preview-2024-12-17'`)
 
@@ -75,13 +75,13 @@ voice.connect()
 
 ## Methods
 
-### connect()
+### `connect()`
 
-Establishes a connection to the OpenAI realtime service. Must be called before using speak, listen, or send functions.
+Establishes a connection to the OpenAI Realtime service. Must be called before using speak, listen, or send functions.
 
 **returns** (`Promise<void>`): Promise that resolves when the connection is established.
 
-### speak()
+### `speak()`
 
 Emits a speaking event using the configured voice model. Can accept either a string or a readable stream as input.
 
@@ -93,7 +93,7 @@ Emits a speaking event using the configured voice model. Can accept either a str
 
 Returns: `Promise<void>`
 
-### listen()
+### `listen()`
 
 Processes audio input for speech recognition. Takes a readable stream of audio data and emits a 'listening' event with the transcribed text.
 
@@ -101,7 +101,7 @@ Processes audio input for speech recognition. Takes a readable stream of audio d
 
 Returns: `Promise<void>`
 
-### send()
+### `send()`
 
 Streams audio data in real-time to the OpenAI service for continuous audio streaming scenarios like live microphone input.
 
@@ -109,7 +109,7 @@ Streams audio data in real-time to the OpenAI service for continuous audio strea
 
 Returns: `Promise<void>`
 
-### updateConfig()
+### `updateConfig()`
 
 Updates the session configuration for the voice instance. This can be used to modify voice settings, turn detection, and other parameters.
 
@@ -117,7 +117,7 @@ Updates the session configuration for the voice instance. This can be used to mo
 
 Returns: `void`
 
-### addTools()
+### `addTools()`
 
 Adds a set of tools to the voice instance. Tools allow the model to perform additional actions during conversations. When OpenAIRealtimeVoice is added to an Agent, any tools configured for the Agent will automatically be available to the voice interface.
 
@@ -125,19 +125,19 @@ Adds a set of tools to the voice instance. Tools allow the model to perform addi
 
 Returns: `void`
 
-### close()
+### `close()`
 
-Disconnects from the OpenAI realtime session and cleans up resources. Should be called when you're done with the voice instance.
+Disconnects from the OpenAI Realtime session and cleans up resources. Should be called when you're done with the voice instance.
 
 Returns: `void`
 
-### getSpeakers()
+### `getSpeakers()`
 
 Returns a list of available voice speakers.
 
 Returns: `Promise<Array<{ voiceId: string; [key: string]: any }>>`
 
-### on()
+### `on()`
 
 Registers an event listener for voice events.
 
@@ -147,7 +147,7 @@ Registers an event listener for voice events.
 
 Returns: `void`
 
-### off()
+### `off()`
 
 Removes a previously registered event listener.
 
@@ -181,7 +181,7 @@ You can also listen to [OpenAI Realtime utility events](https://github.com/opena
 
 **openAIRealtime:conversation.item.completed** (`event`): Emitted when an item in the conversation is completed.
 
-## Available Voices
+## Available voices
 
 The following voice options are available:
 

package/.docs/reference/voice/openai.md

@@ -2,7 +2,7 @@
 
 The OpenAIVoice class in Mastra provides text-to-speech and speech-to-text capabilities using OpenAI's models.
 
-## Usage Example
+## Usage example
 
 ```typescript
 import { OpenAIVoice } from '@mastra/voice-openai'
@@ -37,7 +37,7 @@ const text = await voice.listen(audioStream, {
 
 ## Configuration
 
-### Constructor Options
+### Constructor options
 
 **speechModel** (`OpenAIConfig`): Configuration for text-to-speech synthesis. (Default: `{ name: 'tts-1' }`)
 
@@ -55,7 +55,7 @@ const text = await voice.listen(audioStream, {
 
 ## Methods
 
-### speak()
+### `speak()`
 
 Converts text to speech using OpenAI's text-to-speech models.
 
@@ -69,7 +69,7 @@ Converts text to speech using OpenAI's text-to-speech models.
 
 Returns: `Promise<NodeJS.ReadableStream>`
 
-### listen()
+### `listen()`
 
 Transcribes audio using OpenAI's Whisper model.
 
@@ -81,7 +81,7 @@ Transcribes audio using OpenAI's Whisper model.
 
 Returns: `Promise<string>`
 
-### getSpeakers()
+### `getSpeakers()`
 
 Returns an array of available voice options, where each node contains:
 

package/.docs/reference/voice/playai.md

@@ -2,7 +2,7 @@
 
 The PlayAI voice implementation in Mastra provides text-to-speech capabilities using PlayAI's API.
 
-## Usage Example
+## Usage example
 
 ```typescript
 import { PlayAIVoice } from '@mastra/voice-playai'
@@ -27,7 +27,7 @@ const audioStream = await voice.speak('Hello, world!', {
 })
 ```
 
-## Constructor Parameters
+## Constructor parameters
 
 **speechModel** (`PlayAIConfig`): Configuration for text-to-speech functionality (Default: `{ name: 'PlayDialog' }`)
 
@@ -41,7 +41,7 @@ const audioStream = await voice.speak('Hello, world!', {
 
 ## Methods
 
-### speak()
+### `speak()`
 
 Converts text to speech using the configured speech model and voice.
 
@@ -53,7 +53,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:
 
@@ -69,7 +69,7 @@ Returns an array of available voice options, where each node contains:
 
 **voiceId** (`string`): Unique identifier for the voice
 
-### listen()
+### `listen()`
 
 This method isn't supported by PlayAI and will throw an error. PlayAI doesn't provide speech-to-text functionality.
 

package/.docs/reference/voice/sarvam.md

@@ -2,7 +2,7 @@
 
 The SarvamVoice class in Mastra provides text-to-speech and speech-to-text capabilities using Sarvam AI models.
 
-## Usage Example
+## Usage example
 
 ```typescript
 import { SarvamVoice } from '@mastra/voice-sarvam'
@@ -49,7 +49,7 @@ const text = await voice.listen(audioStream, {
 
 ## Configuration
 
-### Constructor Options
+### Constructor options
 
 **speechModel** (`SarvamVoiceConfig`): Configuration for text-to-speech synthesis. (Default: `{ model: 'bulbul:v1', language: 'en-IN' }`)
 
@@ -87,7 +87,7 @@ const text = await voice.listen(audioStream, {
 
 ## Methods
 
-### speak()
+### `speak()`
 
 Converts text to speech using Sarvam's text-to-speech models.
 
@@ -99,7 +99,7 @@ Converts text to speech using Sarvam's text-to-speech models.
 
 Returns: `Promise<NodeJS.ReadableStream>`
 
-### listen()
+### `listen()`
 
 Transcribes audio using Sarvam's speech recognition models.
 
@@ -109,7 +109,7 @@ Transcribes audio using Sarvam's speech recognition models.
 
 Returns: `Promise<string>`
 
-### getSpeakers()
+### `getSpeakers()`
 
 Returns an array of available voice options.
 

package/.docs/reference/voice/speechify.md

@@ -2,7 +2,7 @@
 
 The Speechify voice implementation in Mastra provides text-to-speech capabilities using Speechify's API.
 
-## Usage Example
+## Usage example
 
 ```typescript
 import { SpeechifyVoice } from '@mastra/voice-speechify'
@@ -25,7 +25,7 @@ const audioStream = await voice.speak('Hello, world!', {
 })
 ```
 
-## Constructor Parameters
+## Constructor parameters
 
 **speechModel** (`SpeechifyConfig`): Configuration for text-to-speech functionality (Default: `{ name: 'simba-english' }`)
 
@@ -37,7 +37,7 @@ const audioStream = await voice.speak('Hello, world!', {
 
 ## Methods
 
-### speak()
+### `speak()`
 
 Converts text to speech using the configured speech model and voice.
 
@@ -51,7 +51,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:
 
@@ -63,7 +63,7 @@ Returns an array of available voice options, where each node contains:
 
 **gender** (`string`): Gender of the voice
 
-### listen()
+### `listen()`
 
 This method isn't supported by Speechify and will throw an error. Speechify doesn't provide speech-to-text functionality.
 

package/.docs/reference/voice/voice.addInstructions.md

@@ -2,7 +2,7 @@
 
 The `addInstructions()` method equips a voice provider with instructions that guide the model's behavior during real-time interactions. This is particularly useful for real-time voice providers that maintain context across a conversation.
 
-## Usage Example
+## Usage example
 
 ```typescript
 import { OpenAIRealtimeVoice } from '@mastra/voice-openai-realtime'
@@ -41,7 +41,7 @@ await voice.connect()
 
 **instructions** (`string`): Instructions to guide the voice model's behavior
 
-## Return Value
+## Return value
 
 This method doesn't return a value.
 

package/.docs/reference/voice/voice.addTools.md

@@ -2,7 +2,7 @@
 
 The `addTools()` method equips a voice provider with tools (functions) that can be called by the model during real-time interactions. This enables voice assistants to perform actions like searching for information, making calculations, or interacting with external systems.
 
-## Usage Example
+## Usage example
 
 ```typescript
 import { OpenAIRealtimeVoice } from '@mastra/voice-openai-realtime'
@@ -52,7 +52,7 @@ await voice.connect()
 
 **tools** (`ToolsInput`): Object containing tool definitions that can be called by the voice model
 
-## Return Value
+## Return value
 
 This method doesn't return a value.
 

package/.docs/reference/voice/voice.answer.md

@@ -2,7 +2,7 @@
 
 The `answer()` method is used in real-time voice providers to trigger the AI to generate a response. This method is particularly useful in speech-to-speech conversations where you need to explicitly signal the AI to respond after receiving user input.
 
-## Usage Example
+## Usage example
 
 ```typescript
 import { OpenAIRealtimeVoice } from '@mastra/voice-openai-realtime'
@@ -41,7 +41,7 @@ await voice.answer()
 
 **options** (`Record<string, unknown>`): Provider-specific options for the response
 
-## Return Value
+## Return value
 
 Returns a `Promise<void>` that resolves when the response has been triggered.
 

package/.docs/reference/voice/voice.close.md

@@ -2,7 +2,7 @@
 
 The `close()` method disconnects from a real-time voice service and cleans up resources. This is important for properly ending voice sessions and preventing resource leaks.
 
-## Usage Example
+## Usage example
 
 ```typescript
 import { OpenAIRealtimeVoice } from '@mastra/voice-openai-realtime'
@@ -38,7 +38,7 @@ setTimeout(() => {
 
 This method doesn't accept any parameters.
 
-## Return Value
+## Return value
 
 This method doesn't return a value.
 

package/.docs/reference/voice/voice.connect.md

@@ -2,7 +2,7 @@
 
 The `connect()` method establishes a WebSocket or WebRTC connection for real-time speech-to-speech communication. This method must be called before using other real-time features like `send()` or `answer()`.
 
-## Usage Example
+## Usage example
 
 ```typescript
 import { OpenAIRealtimeVoice } from '@mastra/voice-openai-realtime'
@@ -48,11 +48,11 @@ await voice.connect({
 
 **options** (`Record<string, unknown>`): Provider-specific connection options
 
-## Return Value
+## Return value
 
 Returns a `Promise<void>` that resolves when the connection is successfully established.
 
-## Provider-Specific Options
+## Provider-specific options
 
 Each real-time voice provider may support different options for the `connect()` method:
 
@@ -64,7 +64,7 @@ Each real-time voice provider may support different options for the `connect()`
 
 **options.reconnect** (`boolean`): Whether to automatically reconnect on connection loss
 
-## Using with CompositeVoice
+## Using with `CompositeVoice`
 
 When using `CompositeVoice`, the `connect()` method delegates to the configured real-time provider:
 
@@ -88,7 +88,7 @@ await voice.connect()
 - Some providers may automatically reconnect on connection loss, depending on their implementation
 - Connection errors will typically be thrown as exceptions that should be caught and handled
 
-## Related Methods
+## Related methods
 
 - [voice.send()](https://mastra.ai/reference/voice/voice.send) - Sends audio data to the voice provider
 - [voice.answer()](https://mastra.ai/reference/voice/voice.answer) - Triggers the voice provider to respond

package/.docs/reference/voice/voice.events.md

@@ -1,8 +1,8 @@
-# Voice Events
+# Voice events
 
 Voice providers emit various events during real-time voice interactions. These events can be listened to using the [voice.on()](https://mastra.ai/reference/voice/voice.on) method and are particularly important for building interactive voice applications.
 
-## Common Events
+## Common events
 
 These events are commonly implemented across real-time voice providers: