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

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

@@ -28,15 +28,13 @@ const speakers = await voice.getSpeakers()
 
 ## Constructor Parameters
 
-**speechModel?:** (`ElevenLabsVoiceConfig`): Configuration for text-to-speech functionality. (Default: `{ name: 'eleven_multilingual_v2' }`)
+**speechModel** (`ElevenLabsVoiceConfig`): Configuration for text-to-speech functionality. (Default: `{ name: 'eleven_multilingual_v2' }`)
 
-**speaker?:** (`string`): ID of the speaker to use for text-to-speech (Default: `'9BWtsMINqrJLrRacOk9x' (Aria voice)`)
+**speechModel.name** (`ElevenLabsModel`): The ElevenLabs model to use
 
-### ElevenLabsVoiceConfig
+**speechModel.apiKey** (`string`): ElevenLabs API key. Falls back to ELEVENLABS\_API\_KEY environment variable
 
-**name?:** (`ElevenLabsModel`): The ElevenLabs model to use (Default: `'eleven_multilingual_v2'`)
-
-**apiKey?:** (`string`): ElevenLabs API key. Falls back to ELEVENLABS\_API\_KEY environment variable
+**speaker** (`string`): ID of the speaker to use for text-to-speech (Default: `'9BWtsMINqrJLrRacOk9x' (Aria voice)`)
 
 ## Methods
 
@@ -44,11 +42,11 @@ const speakers = await voice.getSpeakers()
 
 Converts text to speech using the configured speech model and voice.
 
-**input:** (`string | NodeJS.ReadableStream`): Text to convert to speech. If a stream is provided, it will be converted to text first.
+**input** (`string | NodeJS.ReadableStream`): Text to convert to speech. If a stream is provided, it will be converted to text first.
 
-**options?:** (`object`): Additional options for speech synthesis
+**options** (`object`): Additional options for speech synthesis
 
-**options.speaker?:** (`string`): Override the default speaker ID for this request
+**options.speaker** (`string`): Override the default speaker ID for this request
 
 Returns: `Promise<NodeJS.ReadableStream>`
 
@@ -56,37 +54,37 @@ Returns: `Promise<NodeJS.ReadableStream>`
 
 Returns an array of available voice options, where each node contains:
 
-**voiceId:** (`string`): Unique identifier for the voice
+**voiceId** (`string`): Unique identifier for the voice
 
-**name:** (`string`): Display name of the voice
+**name** (`string`): Display name of the voice
 
-**language:** (`string`): Language code for the voice
+**language** (`string`): Language code for the voice
 
-**gender:** (`string`): Gender of the voice
+**gender** (`string`): Gender of the voice
 
 ### listen()
 
 Converts audio input to text using ElevenLabs Speech-to-Text API.
 
-**input:** (`NodeJS.ReadableStream`): A readable stream containing the audio data to transcribe
+**input** (`NodeJS.ReadableStream`): A readable stream containing the audio data to transcribe
 
-**options?:** (`object`): Configuration options for the transcription
+**options** (`object`): Configuration options for the transcription
 
 The options object supports the following properties:
 
-**language\_code?:** (`string`): ISO language code (e.g., 'en', 'fr', 'es')
+**language\_code** (`string`): ISO language code (e.g., 'en', 'fr', 'es')
 
-**tag\_audio\_events?:** (`boolean`): Whether to tag audio events like \[MUSIC], \[LAUGHTER], etc.
+**tag\_audio\_events** (`boolean`): Whether to tag audio events like \[MUSIC], \[LAUGHTER], etc.
 
-**num\_speakers?:** (`number`): Number of speakers to detect in the audio
+**num\_speakers** (`number`): Number of speakers to detect in the audio
 
-**filetype?:** (`string`): Audio file format (e.g., 'mp3', 'wav', 'ogg')
+**filetype** (`string`): Audio file format (e.g., 'mp3', 'wav', 'ogg')
 
-**timeoutInSeconds?:** (`number`): Request timeout in seconds
+**timeoutInSeconds** (`number`): Request timeout in seconds
 
-**maxRetries?:** (`number`): Maximum number of retry attempts
+**maxRetries** (`number`): Maximum number of retry attempts
 
-**abortSignal?:** (`AbortSignal`): Signal to abort the request
+**abortSignal** (`AbortSignal`): Signal to abort the request
 
 Returns: `Promise<string>` - A Promise that resolves to the transcribed text
 

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

@@ -90,37 +90,35 @@ voice.close()
 
 ### Constructor Options
 
-**apiKey?:** (`string`): Google API key for Gemini API authentication. Required unless using Vertex AI.
+**apiKey** (`string`): Google API key for Gemini API authentication. Required unless using Vertex AI.
 
-**model?:** (`GeminiVoiceModel`): The model ID to use for real-time voice interactions. (Default: `'gemini-2.0-flash-exp'`)
+**model** (`GeminiVoiceModel`): The model ID to use for real-time voice interactions. (Default: `'gemini-2.0-flash-exp'`)
 
-**speaker?:** (`GeminiVoiceName`): Default voice ID for speech synthesis. (Default: `'Puck'`)
+**speaker** (`GeminiVoiceName`): Default voice ID for speech synthesis. (Default: `'Puck'`)
 
-**vertexAI?:** (`boolean`): Use Vertex AI instead of Gemini API for authentication. (Default: `false`)
+**vertexAI** (`boolean`): Use Vertex AI instead of Gemini API for authentication. (Default: `false`)
 
-**project?:** (`string`): Google Cloud project ID (required for Vertex AI).
+**project** (`string`): Google Cloud project ID (required for Vertex AI).
 
-**location?:** (`string`): Google Cloud region for Vertex AI. (Default: `'us-central1'`)
+**location** (`string`): Google Cloud region for Vertex AI. (Default: `'us-central1'`)
 
-**serviceAccountKeyFile?:** (`string`): Path to service account JSON key file for Vertex AI authentication.
+**serviceAccountKeyFile** (`string`): Path to service account JSON key file for Vertex AI authentication.
 
-**serviceAccountEmail?:** (`string`): Service account email for impersonation (alternative to key file).
+**serviceAccountEmail** (`string`): Service account email for impersonation (alternative to key file).
 
-**instructions?:** (`string`): System instructions for the model.
+**instructions** (`string`): System instructions for the model.
 
-**sessionConfig?:** (`GeminiSessionConfig`): Session configuration including interrupt and context settings.
+**sessionConfig** (`GeminiSessionConfig`): Session configuration including interrupt and context settings.
 
-**debug?:** (`boolean`): Enable debug logging for troubleshooting. (Default: `false`)
+**sessionConfig.interrupts** (`object`): Interrupt handling configuration.
 
-### Session Configuration
+**sessionConfig.interrupts.enabled** (`boolean`): Enable interrupt handling.
 
-**interrupts?:** (`object`): Interrupt handling configuration.
+**sessionConfig.interrupts.allowUserInterruption** (`boolean`): Allow user to interrupt model responses.
 
-**interrupts.enabled?:** (`boolean`): Enable interrupt handling. (Default: `true`)
+**sessionConfig.contextCompression** (`boolean`): Enable automatic context compression.
 
-**interrupts.allowUserInterruption?:** (`boolean`): Allow user to interrupt model responses. (Default: `true`)
-
-**contextCompression?:** (`boolean`): Enable automatic context compression. (Default: `false`)
+**debug** (`boolean`): Enable debug logging for troubleshooting. (Default: `false`)
 
 ## Methods
 
@@ -128,23 +126,23 @@ voice.close()
 
 Establishes a connection to the Gemini Live API. Must be called before using speak, listen, or send methods.
 
-**requestContext?:** (`object`): Optional request context for the connection.
+**requestContext** (`object`): Optional request context for the connection.
 
-**returns:** (`Promise<void>`): Promise that resolves when the connection is established.
+**returns** (`Promise<void>`): Promise that resolves when the connection is established.
 
 ### speak()
 
 Converts text to speech and sends it to the model. Can accept either a string or a readable stream as input.
 
-**input:** (`string | NodeJS.ReadableStream`): Text or text stream to convert to speech.
+**input** (`string | NodeJS.ReadableStream`): Text or text stream to convert to speech.
 
-**options?:** (`GeminiLiveVoiceOptions`): Optional speech configuration.
+**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. (Default: `Constructor's speaker value`)
 
-**options.languageCode?:** (`string`): Language code for the response.
+**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. (Default: `['AUDIO', 'TEXT']`)
 
 Returns: `Promise<void>` (responses are emitted via `speaker` and `writing` events)
 
@@ -152,9 +150,9 @@ Returns: `Promise<void>` (responses are emitted via `speaker` and `writing` even
 
 Processes audio input for speech recognition. Takes a readable stream of audio data and returns the transcribed text.
 
-**audioStream:** (`NodeJS.ReadableStream`): Audio stream to transcribe.
+**audioStream** (`NodeJS.ReadableStream`): Audio stream to transcribe.
 
-**options?:** (`GeminiLiveVoiceOptions`): Optional listening configuration.
+**options** (`GeminiLiveVoiceOptions`): Optional listening configuration.
 
 Returns: `Promise<string>` - The transcribed text
 
@@ -162,7 +160,7 @@ Returns: `Promise<string>` - The transcribed text
 
 Streams audio data in real-time to the Gemini service for continuous audio streaming scenarios like live microphone input.
 
-**audioData:** (`NodeJS.ReadableStream | Int16Array`): Audio stream or buffer to send to the service.
+**audioData** (`NodeJS.ReadableStream | Int16Array`): Audio stream or buffer to send to the service.
 
 Returns: `Promise<void>`
 
@@ -170,7 +168,7 @@ Returns: `Promise<void>`
 
 Updates the session configuration dynamically. This can be used to modify voice settings, speaker selection, and other runtime configurations.
 
-**config:** (`Partial<GeminiLiveVoiceConfig>`): Configuration updates to apply.
+**config** (`Partial<GeminiLiveVoiceConfig>`): Configuration updates to apply.
 
 Returns: `Promise<void>`
 
@@ -178,7 +176,7 @@ Returns: `Promise<void>`
 
 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.
 
-**tools:** (`ToolsInput`): Tools configuration to equip.
+**tools** (`ToolsInput`): Tools configuration to equip.
 
 Returns: `void`
 
@@ -186,7 +184,7 @@ Returns: `void`
 
 Adds or updates system instructions for the model.
 
-**instructions?:** (`string`): System instructions to set.
+**instructions** (`string`): System instructions to set.
 
 Returns: `void`
 
@@ -194,7 +192,7 @@ Returns: `void`
 
 Triggers a response from the model. This method is primarily used internally when integrated with an Agent.
 
-**options?:** (`Record<string, unknown>`): Optional parameters for the answer request.
+**options** (`Record<string, unknown>`): Optional parameters for the answer request.
 
 Returns: `Promise<void>`
 
@@ -220,9 +218,9 @@ Returns: `void`
 
 Registers an event listener for voice events.
 
-**event:** (`string`): Name of the event to listen for.
+**event** (`string`): Name of the event to listen for.
 
-**callback:** (`Function`): Function to call when the event occurs.
+**callback** (`Function`): Function to call when the event occurs.
 
 Returns: `void`
 
@@ -230,9 +228,9 @@ Returns: `void`
 
 Removes a previously registered event listener.
 
-**event:** (`string`): Name of the event to stop listening to.
+**event** (`string`): Name of the event to stop listening to.
 
-**callback:** (`Function`): The specific callback function to remove.
+**callback** (`Function`): The specific callback function to remove.
 
 Returns: `void`
 
@@ -240,23 +238,23 @@ Returns: `void`
 
 The GeminiLiveVoice class emits the following events:
 
-**speaker:** (`event`): Emitted when audio data is received from the model. Callback receives a NodeJS.ReadableStream.
+**speaker** (`event`): Emitted when audio data is received from the model. Callback receives a NodeJS.ReadableStream.
 
-**speaking:** (`event`): Emitted with audio metadata. Callback receives { audioData?: Int16Array, sampleRate?: number }.
+**speaking** (`event`): Emitted with audio metadata. Callback receives { audioData?: Int16Array, sampleRate?: number }.
 
-**writing:** (`event`): Emitted when transcribed text is available. Callback receives { text: string, role: 'assistant' | 'user' }.
+**writing** (`event`): Emitted when transcribed text is available. Callback receives { text: string, role: 'assistant' | 'user' }.
 
-**session:** (`event`): Emitted on session state changes. Callback receives { state: 'connecting' | 'connected' | 'disconnected' | 'disconnecting' | 'updated', config?: object }.
+**session** (`event`): Emitted on session state changes. Callback receives { state: 'connecting' | 'connected' | 'disconnected' | 'disconnecting' | 'updated', config?: object }.
 
-**turnComplete:** (`event`): Emitted when a conversation turn is completed. Callback receives { timestamp: number }.
+**turnComplete** (`event`): Emitted when a conversation turn is completed. Callback receives { timestamp: number }.
 
-**toolCall:** (`event`): Emitted when the model requests a tool call. Callback receives { name: string, args: object, id: string }.
+**toolCall** (`event`): Emitted when the model requests a tool call. Callback receives { name: string, args: object, id: string }.
 
-**usage:** (`event`): Emitted with token usage information. Callback receives { inputTokens: number, outputTokens: number, totalTokens: number, modality: string }.
+**usage** (`event`): Emitted with token usage information. Callback receives { inputTokens: number, outputTokens: number, totalTokens: number, modality: string }.
 
-**error:** (`event`): Emitted when an error occurs. Callback receives { message: string, code?: string, details?: unknown }.
+**error** (`event`): Emitted when an error occurs. Callback receives { message: string, code?: string, details?: unknown }.
 
-**interrupt:** (`event`): Interrupt events. Callback receives { type: 'user' | 'model', timestamp: number }.
+**interrupt** (`event`): Interrupt events. Callback receives { type: 'user' | 'model', timestamp: number }.
 
 ## Available Models
 

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

@@ -32,25 +32,29 @@ const voices = await voice.getSpeakers({ languageCode: 'en-US' })
 
 ## Constructor Parameters
 
-**speechModel?:** (`GoogleModelConfig`): Configuration for text-to-speech functionality (Default: `{ apiKey: process.env.GOOGLE_API_KEY }`)
+**speechModel** (`GoogleModelConfig`): Configuration for text-to-speech functionality (Default: `{ apiKey: process.env.GOOGLE_API_KEY }`)
 
-**listeningModel?:** (`GoogleModelConfig`): Configuration for speech-to-text functionality (Default: `{ apiKey: process.env.GOOGLE_API_KEY }`)
+**speechModel.apiKey** (`string`): Google Cloud API key. Falls back to GOOGLE\_API\_KEY environment variable. Not used when vertexAI is true.
 
-**speaker?:** (`string`): Default voice ID to use for text-to-speech (Default: `'en-US-Casual-K'`)
+**speechModel.keyFilename** (`string`): Path to service account JSON key file. Falls back to GOOGLE\_APPLICATION\_CREDENTIALS environment variable.
 
-**vertexAI?:** (`boolean`): Enable Vertex AI mode for enterprise deployments. Uses project-based authentication instead of API keys. Requires 'project' to be set. (Default: `false`)
+**speechModel.credentials** (`object`): In-memory service account credentials object with client\_email and private\_key properties.
 
-**project?:** (`string`): Google Cloud project ID (required when vertexAI is true). Falls back to GOOGLE\_CLOUD\_PROJECT environment variable.
+**listeningModel** (`GoogleModelConfig`): Configuration for speech-to-text functionality (Default: `{ apiKey: process.env.GOOGLE_API_KEY }`)
 
-**location?:** (`string`): Google Cloud region for Vertex AI. Falls back to GOOGLE\_CLOUD\_LOCATION environment variable. (Default: `'us-central1'`)
+**listeningModel.apiKey** (`string`): Google Cloud API key. Falls back to GOOGLE\_API\_KEY environment variable. Not used when vertexAI is true.
 
-### GoogleModelConfig
+**listeningModel.keyFilename** (`string`): Path to service account JSON key file. Falls back to GOOGLE\_APPLICATION\_CREDENTIALS environment variable.
 
-**apiKey?:** (`string`): Google Cloud API key. Falls back to GOOGLE\_API\_KEY environment variable. Not used when vertexAI is true.
+**listeningModel.credentials** (`object`): In-memory service account credentials object with client\_email and private\_key properties.
 
-**keyFilename?:** (`string`): Path to service account JSON key file. Falls back to GOOGLE\_APPLICATION\_CREDENTIALS environment variable.
+**speaker** (`string`): Default voice ID to use for text-to-speech (Default: `'en-US-Casual-K'`)
 
-**credentials?:** (`object`): In-memory service account credentials object with client\_email and private\_key properties.
+**vertexAI** (`boolean`): Enable Vertex AI mode for enterprise deployments. Uses project-based authentication instead of API keys. Requires 'project' to be set. (Default: `false`)
+
+**project** (`string`): Google Cloud project ID (required when vertexAI is true). Falls back to GOOGLE\_CLOUD\_PROJECT environment variable.
+
+**location** (`string`): Google Cloud region for Vertex AI. Falls back to GOOGLE\_CLOUD\_LOCATION environment variable. (Default: `'us-central1'`)
 
 ## Methods
 
@@ -58,15 +62,15 @@ const voices = await voice.getSpeakers({ languageCode: 'en-US' })
 
 Converts text to speech using Google Cloud Text-to-Speech service.
 
-**input:** (`string | NodeJS.ReadableStream`): Text to convert to speech. If a stream is provided, it will be converted to text first.
+**input** (`string | NodeJS.ReadableStream`): Text to convert to speech. If a stream is provided, it will be converted to text first.
 
-**options?:** (`object`): Speech synthesis options
+**options** (`object`): Speech synthesis options
 
-**options.speaker?:** (`string`): Voice ID to use for this request
+**options.speaker** (`string`): Voice ID to use for this request
 
-**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.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 (Default: `{ audioEncoding: 'LINEAR16' }`)
 
 Returns: `Promise<NodeJS.ReadableStream>`
 
@@ -74,13 +78,13 @@ Returns: `Promise<NodeJS.ReadableStream>`
 
 Converts speech to text using Google Cloud Speech-to-Text service.
 
-**audioStream:** (`NodeJS.ReadableStream`): Audio stream to transcribe
+**audioStream** (`NodeJS.ReadableStream`): Audio stream to transcribe
 
-**options?:** (`object`): Recognition options
+**options** (`object`): Recognition options
 
-**options.stream?:** (`boolean`): Whether to use streaming recognition
+**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 (Default: `{ encoding: 'LINEAR16', languageCode: 'en-US' }`)
 
 Returns: `Promise<string>`
 
@@ -88,9 +92,9 @@ Returns: `Promise<string>`
 
 Returns an array of available voice options, where each node contains:
 
-**voiceId:** (`string`): Unique identifier for the voice
+**voiceId** (`string`): Unique identifier for the voice
 
-**languageCodes:** (`string[]`): List of language codes supported by this voice
+**languageCodes** (`string[]`): List of language codes supported by this voice
 
 ### isUsingVertexAI()
 

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

@@ -79,31 +79,31 @@ class MyVoiceProvider extends MastraVoice {
 
 ## Constructor Parameters
 
-**config?:** (`VoiceConfig`): Configuration object for the voice service
+**config** (`VoiceConfig`): Configuration object for the voice service
 
-**config.speechModel?:** (`BuiltInModelConfig`): Configuration for the text-to-speech model
+**config.speechModel** (`BuiltInModelConfig`): Configuration for the text-to-speech model
 
-**config.listeningModel?:** (`BuiltInModelConfig`): Configuration for the speech-to-text model
+**config.speechModel.name** (`string`): Name of the model to use
 
-**config.speaker?:** (`string`): Default speaker/voice ID to use
+**config.speechModel.apiKey** (`string`): API key for the model service
 
-**config.name?:** (`string`): Name for the voice provider instance
+**config.listeningModel** (`BuiltInModelConfig`): Configuration for the speech-to-text model
 
-**config.realtimeConfig?:** (`object`): Configuration for real-time speech-to-speech capabilities
+**config.listeningModel.name** (`string`): Name of the model to use
 
-### BuiltInModelConfig
+**config.listeningModel.apiKey** (`string`): API key for the model service
 
-**name:** (`string`): Name of the model to use
+**config.speaker** (`string`): Default speaker/voice ID to use
 
-**apiKey?:** (`string`): API key for the model service
+**config.name** (`string`): Name for the voice provider instance
 
-### RealtimeConfig
+**config.realtimeConfig** (`object`): Configuration for real-time speech-to-speech capabilities
 
-**model?:** (`string`): Model to use for real-time speech-to-speech capabilities
+**config.realtimeConfig.model** (`string`): Model to use for real-time speech-to-speech capabilities
 
-**apiKey?:** (`string`): API key for the real-time service
+**config.realtimeConfig.apiKey** (`string`): API key for the real-time service
 
-**options?:** (`unknown`): Provider-specific options for real-time capabilities
+**config.realtimeConfig.options** (`unknown`): Provider-specific options for real-time capabilities
 
 ## Abstract Methods
 
@@ -281,21 +281,21 @@ Purpose:
 
 The MastraVoice class includes an event system for real-time communication. Standard event types include:
 
-**speaking:** (`{ text: string; audioStream?: NodeJS.ReadableStream; audio?: Int16Array }`): Emitted when the voice provider is speaking, contains audio data
+**speaking** (`{ text: string; audioStream?: NodeJS.ReadableStream; audio?: Int16Array }`): Emitted when the voice provider is speaking, contains audio data
 
-**writing:** (`{ text: string, role: string }`): Emitted when text is transcribed from speech
+**writing** (`{ text: string, role: string }`): Emitted when text is transcribed from speech
 
-**error:** (`{ message: string; code?: string; details?: unknown }`): Emitted when an error occurs
+**error** (`{ message: string; code?: string; details?: unknown }`): Emitted when an error occurs
 
 ## Protected Properties
 
-**listeningModel?:** (`BuiltInModelConfig | undefined`): Configuration for the speech-to-text model
+**listeningModel** (`BuiltInModelConfig | undefined`): Configuration for the speech-to-text model
 
-**speechModel?:** (`BuiltInModelConfig | undefined`): Configuration for the text-to-speech model
+**speechModel** (`BuiltInModelConfig | undefined`): Configuration for the text-to-speech model
 
-**speaker?:** (`string | undefined`): Default speaker/voice ID
+**speaker** (`string | undefined`): Default speaker/voice ID
 
-**realtimeConfig?:** (`{ model?: string; apiKey?: string; options?: unknown } | undefined`): Configuration for real-time speech-to-speech capabilities
+**realtimeConfig** (`{ model?: string; apiKey?: string; options?: unknown } | undefined`): Configuration for real-time speech-to-speech capabilities
 
 ## Telemetry Support
 

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

@@ -45,41 +45,37 @@ const voices = await voice.getSpeakers()
 
 ## Constructor Parameters
 
-**speechModel?:** (`MurfConfig`): Configuration for text-to-speech functionality (Default: `{ name: 'GEN2' }`)
+**speechModel** (`MurfConfig`): Configuration for text-to-speech functionality (Default: `{ name: 'GEN2' }`)
 
-**speaker?:** (`string`): Default voice ID to use for text-to-speech (Default: `'en-UK-hazel'`)
+**speechModel.name** (`'GEN1' | 'GEN2'`): The Murf model generation to use
 
-### MurfConfig
+**speechModel.apiKey** (`string`): Murf API key. Falls back to MURF\_API\_KEY environment variable
 
-**name:** (`'GEN1' | 'GEN2'`): The Murf model generation to use (Default: `'GEN2'`)
+**speechModel.properties** (`object`): Default properties for all speech synthesis requests
 
-**apiKey?:** (`string`): Murf API key. Falls back to MURF\_API\_KEY environment variable
+**speechModel.properties.style** (`string`): Speaking style for the voice
 
-**properties?:** (`object`): Default properties for all speech synthesis requests
+**speechModel.properties.rate** (`number`): Speech rate multiplier
 
-### Speech Properties
+**speechModel.properties.pitch** (`number`): Voice pitch adjustment
 
-**style?:** (`string`): Speaking style for the voice
+**speechModel.properties.sampleRate** (`8000 | 24000 | 44100 | 48000`): Audio sample rate in Hz
 
-**rate?:** (`number`): Speech rate multiplier
+**speechModel.properties.format** (`'MP3' | 'WAV' | 'FLAC' | 'ALAW' | 'ULAW'`): Output audio format
 
-**pitch?:** (`number`): Voice pitch adjustment
+**speechModel.properties.channelType** (`'STEREO' | 'MONO'`): Audio channel configuration
 
-**sampleRate?:** (`8000 | 24000 | 44100 | 48000`): Audio sample rate in Hz
+**speechModel.properties.pronunciationDictionary** (`Record<string, string>`): Custom pronunciation mappings
 
-**format?:** (`'MP3' | 'WAV' | 'FLAC' | 'ALAW' | 'ULAW'`): Output audio format
+**speechModel.properties.encodeAsBase64** (`boolean`): Whether to encode the audio as base64
 
-**channelType?:** (`'STEREO' | 'MONO'`): Audio channel configuration
+**speechModel.properties.variation** (`number`): Voice variation parameter
 
-**pronunciationDictionary?:** (`Record<string, string>`): Custom pronunciation mappings
+**speechModel.properties.audioDuration** (`number`): Target audio duration in seconds
 
-**encodeAsBase64?:** (`boolean`): Whether to encode the audio as base64
+**speechModel.properties.multiNativeLocale** (`string`): Locale for multilingual support
 
-**variation?:** (`number`): Voice variation parameter
-
-**audioDuration?:** (`number`): Target audio duration in seconds
-
-**multiNativeLocale?:** (`string`): Locale for multilingual support
+**speaker** (`string`): Default voice ID to use for text-to-speech (Default: `'en-UK-hazel'`)
 
 ## Methods
 
@@ -87,13 +83,13 @@ const voices = await voice.getSpeakers()
 
 Converts text to speech using Murf's API.
 
-**input:** (`string | NodeJS.ReadableStream`): Text to convert to speech. If a stream is provided, it will be converted to text first.
+**input** (`string | NodeJS.ReadableStream`): Text to convert to speech. If a stream is provided, it will be converted to text first.
 
-**options?:** (`object`): Speech synthesis options
+**options** (`object`): Speech synthesis options
 
-**options.speaker?:** (`string`): Override the default speaker for this request
+**options.speaker** (`string`): Override the default speaker for this request
 
-**options.properties?:** (`object`): Override default speech properties for this request
+**options.properties** (`object`): Override default speech properties for this request
 
 Returns: `Promise<NodeJS.ReadableStream>`
 
@@ -101,13 +97,13 @@ Returns: `Promise<NodeJS.ReadableStream>`
 
 Returns an array of available voice options, where each node contains:
 
-**voiceId:** (`string`): Unique identifier for the voice
+**voiceId** (`string`): Unique identifier for the voice
 
-**name:** (`string`): Display name of the voice
+**name** (`string`): Display name of the voice
 
-**language:** (`string`): Language code for the voice
+**language** (`string`): Language code for the voice
 
-**gender:** (`string`): Gender of the voice
+**gender** (`string`): Gender of the voice
 
 ### listen()