@mastra/mcp-docs-server 1.1.7 → 1.1.8

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

@@ -57,21 +57,21 @@ voice.connect()
 
 ### Constructor Options
 
-**model?:** (`string`): The model ID to use for real-time voice interactions. (Default: `'gpt-5.1-realtime-preview-2024-12-17'`)
+**model** (`string`): The model ID to use for real-time voice interactions. (Default: `'gpt-5.1-realtime-preview-2024-12-17'`)
 
-**apiKey?:** (`string`): OpenAI API key. Falls back to OPENAI\_API\_KEY environment variable.
+**apiKey** (`string`): OpenAI API key. Falls back to OPENAI\_API\_KEY environment variable.
 
-**speaker?:** (`string`): Default voice ID for speech synthesis. (Default: `'alloy'`)
+**speaker** (`string`): Default voice ID for speech synthesis. (Default: `'alloy'`)
 
 ### Voice Activity Detection (VAD) Configuration
 
-**type?:** (`string`): Type of VAD to use. Server-side VAD provides better accuracy. (Default: `'server_vad'`)
+**type** (`string`): Type of VAD to use. Server-side VAD provides better accuracy. (Default: `'server_vad'`)
 
-**threshold?:** (`number`): Speech detection sensitivity (0.0-1.0). (Default: `0.5`)
+**threshold** (`number`): Speech detection sensitivity (0.0-1.0). (Default: `0.5`)
 
-**prefix\_padding\_ms?:** (`number`): Milliseconds of audio to include before speech is detected. (Default: `1000`)
+**prefix\_padding\_ms** (`number`): Milliseconds of audio to include before speech is detected. (Default: `1000`)
 
-**silence\_duration\_ms?:** (`number`): Milliseconds of silence before ending a turn. (Default: `1000`)
+**silence\_duration\_ms** (`number`): Milliseconds of silence before ending a turn. (Default: `1000`)
 
 ## Methods
 
@@ -79,15 +79,15 @@ voice.connect()
 
 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.
+**returns** (`Promise<void>`): Promise that resolves when the connection is established.
 
 ### speak()
 
 Emits a speaking event using the configured voice 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.speaker?:** (`string`): Voice ID to use for this specific speech request. (Default: `Constructor's speaker value`)
+**options.speaker** (`string`): Voice ID to use for this specific speech request. (Default: `Constructor's speaker value`)
 
 Returns: `Promise<void>`
 
@@ -95,7 +95,7 @@ Returns: `Promise<void>`
 
 Processes audio input for speech recognition. Takes a readable stream of audio data and emits a 'listening' event with the transcribed text.
 
-**audioData:** (`NodeJS.ReadableStream`): Audio stream to transcribe.
+**audioData** (`NodeJS.ReadableStream`): Audio stream to transcribe.
 
 Returns: `Promise<void>`
 
@@ -103,7 +103,7 @@ Returns: `Promise<void>`
 
 Streams audio data in real-time to the OpenAI service for continuous audio streaming scenarios like live microphone input.
 
-**audioData:** (`NodeJS.ReadableStream`): Audio stream to send to the service.
+**audioData** (`NodeJS.ReadableStream`): Audio stream to send to the service.
 
 Returns: `Promise<void>`
 
@@ -111,7 +111,7 @@ Returns: `Promise<void>`
 
 Updates the session configuration for the voice instance. This can be used to modify voice settings, turn detection, and other parameters.
 
-**sessionConfig:** (`Realtime.SessionConfig`): New session configuration to apply.
+**sessionConfig** (`Realtime.SessionConfig`): New session configuration to apply.
 
 Returns: `void`
 
@@ -119,7 +119,7 @@ Returns: `void`
 
 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.
 
-**tools?:** (`ToolsInput`): Tools configuration to equip.
+**tools** (`ToolsInput`): Tools configuration to equip.
 
 Returns: `void`
 
@@ -139,9 +139,9 @@ Returns: `Promise<Array<{ voiceId: string; [key: string]: any }>>`
 
 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`
 
@@ -149,9 +149,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`
 
@@ -159,25 +159,25 @@ Returns: `void`
 
 The OpenAIRealtimeVoice class emits the following events:
 
-**speaking:** (`event`): Emitted when audio data is received from the model. Callback receives { audio: Int16Array }.
+**speaking** (`event`): Emitted when audio data is received from the model. Callback receives { audio: Int16Array }.
 
-**writing:** (`event`): Emitted when transcribed text is available. Callback receives { text: string, role: string }.
+**writing** (`event`): Emitted when transcribed text is available. Callback receives { text: string, role: string }.
 
-**error:** (`event`): Emitted when an error occurs. Callback receives the error object.
+**error** (`event`): Emitted when an error occurs. Callback receives the error object.
 
 ### OpenAI Realtime Events
 
 You can also listen to [OpenAI Realtime utility events](https://github.com/openai/openai-realtime-api-beta#reference-client-utility-events) by prefixing with 'openAIRealtime:':
 
-**openAIRealtime:conversation.created:** (`event`): Emitted when a new conversation is created.
+**openAIRealtime:conversation.created** (`event`): Emitted when a new conversation is created.
 
-**openAIRealtime:conversation.interrupted:** (`event`): Emitted when a conversation is interrupted.
+**openAIRealtime:conversation.interrupted** (`event`): Emitted when a conversation is interrupted.
 
-**openAIRealtime:conversation.updated:** (`event`): Emitted when a conversation is updated.
+**openAIRealtime:conversation.updated** (`event`): Emitted when a conversation is updated.
 
-**openAIRealtime:conversation.item.appended:** (`event`): Emitted when an item is appended to the conversation.
+**openAIRealtime:conversation.item.appended** (`event`): Emitted when an item is appended to the conversation.
 
-**openAIRealtime:conversation.item.completed:** (`event`): Emitted when an item in the conversation is completed.
+**openAIRealtime:conversation.item.completed** (`event`): Emitted when an item in the conversation is completed.
 
 ## Available Voices
 

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

@@ -39,17 +39,19 @@ const text = await voice.listen(audioStream, {
 
 ### Constructor Options
 
-**speechModel?:** (`OpenAIConfig`): Configuration for text-to-speech synthesis. (Default: `{ name: 'tts-1' }`)
+**speechModel** (`OpenAIConfig`): Configuration for text-to-speech synthesis. (Default: `{ name: 'tts-1' }`)
 
-**listeningModel?:** (`OpenAIConfig`): Configuration for speech-to-text recognition. (Default: `{ name: 'whisper-1' }`)
+**speechModel.name** (`'tts-1' | 'tts-1-hd' | 'whisper-1'`): Model name. Use 'tts-1-hd' for higher quality audio.
 
-**speaker?:** (`OpenAIVoiceId`): Default voice ID for speech synthesis. (Default: `'alloy'`)
+**speechModel.apiKey** (`string`): OpenAI API key. Falls back to OPENAI\_API\_KEY environment variable.
 
-### OpenAIConfig
+**listeningModel** (`OpenAIConfig`): Configuration for speech-to-text recognition. (Default: `{ name: 'whisper-1' }`)
 
-**name?:** (`'tts-1' | 'tts-1-hd' | 'whisper-1'`): Model name. Use 'tts-1-hd' for higher quality audio.
+**listeningModel.name** (`'tts-1' | 'tts-1-hd' | 'whisper-1'`): Model name. Use 'tts-1-hd' for higher quality audio.
 
-**apiKey?:** (`string`): OpenAI API key. Falls back to OPENAI\_API\_KEY environment variable.
+**listeningModel.apiKey** (`string`): OpenAI API key. Falls back to OPENAI\_API\_KEY environment variable.
+
+**speaker** (`OpenAIVoiceId`): Default voice ID for speech synthesis. (Default: `'alloy'`)
 
 ## Methods
 
@@ -57,11 +59,11 @@ const text = await voice.listen(audioStream, {
 
 Converts text to speech using OpenAI's text-to-speech models.
 
-**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.speaker?:** (`OpenAIVoiceId`): Voice ID to use for speech synthesis. (Default: `Constructor's speaker value`)
+**options.speaker** (`OpenAIVoiceId`): Voice ID to use for speech synthesis. (Default: `Constructor's speaker value`)
 
-**options.speed?:** (`number`): Speech speed multiplier. (Default: `1.0`)
+**options.speed** (`number`): Speech speed multiplier. (Default: `1.0`)
 
 Returns: `Promise<NodeJS.ReadableStream>`
 
@@ -69,9 +71,9 @@ Returns: `Promise<NodeJS.ReadableStream>`
 
 Transcribes audio using OpenAI's Whisper model.
 
-**audioStream:** (`NodeJS.ReadableStream`): Audio stream to transcribe.
+**audioStream** (`NodeJS.ReadableStream`): Audio stream to transcribe.
 
-**options.filetype?:** (`string`): Audio format of the input stream. (Default: `'mp3'`)
+**options.filetype** (`string`): Audio format of the input stream. (Default: `'mp3'`)
 
 Returns: `Promise<string>`
 
@@ -79,7 +81,7 @@ 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
 
 ## Notes
 

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

@@ -29,17 +29,15 @@ const audioStream = await voice.speak('Hello, world!', {
 
 ## Constructor Parameters
 
-**speechModel?:** (`PlayAIConfig`): Configuration for text-to-speech functionality (Default: `{ name: 'PlayDialog' }`)
+**speechModel** (`PlayAIConfig`): Configuration for text-to-speech functionality (Default: `{ name: 'PlayDialog' }`)
 
-**speaker?:** (`string`): Default voice ID to use for speech synthesis (Default: `First available voice ID`)
+**speechModel.name** (`'PlayDialog' | 'Play3.0-mini'`): The PlayAI model to use
 
-### PlayAIConfig
+**speechModel.apiKey** (`string`): PlayAI API key. Falls back to PLAYAI\_API\_KEY environment variable
 
-**name?:** (`'PlayDialog' | 'Play3.0-mini'`): The PlayAI model to use (Default: `'PlayDialog'`)
+**speechModel.userId** (`string`): PlayAI user ID. Falls back to PLAYAI\_USER\_ID environment variable
 
-**apiKey?:** (`string`): PlayAI API key. Falls back to PLAYAI\_API\_KEY environment variable
-
-**userId?:** (`string`): PlayAI user ID. Falls back to PLAYAI\_USER\_ID environment variable
+**speaker** (`string`): Default voice ID to use for speech synthesis (Default: `First available voice ID`)
 
 ## Methods
 
@@ -47,9 +45,9 @@ const audioStream = await voice.speak('Hello, world!', {
 
 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.speaker?:** (`string`): Override the default speaker for this request (Default: `Constructor's speaker value`)
+**options.speaker** (`string`): Override the default speaker for this request (Default: `Constructor's speaker value`)
 
 Returns: `Promise<NodeJS.ReadableStream>`.
 
@@ -57,17 +55,17 @@ Returns: `Promise<NodeJS.ReadableStream>`.
 
 Returns an array of available voice options, where each node contains:
 
-**name:** (`string`): Name of the voice
+**name** (`string`): Name of the voice
 
-**accent:** (`string`): Accent of the voice (e.g., 'US', 'British', 'Australian')
+**accent** (`string`): Accent of the voice (e.g., 'US', 'British', 'Australian')
 
-**gender:** (`'M' | 'F'`): Gender of the voice
+**gender** (`'M' | 'F'`): Gender of the voice
 
-**age:** (`'Young' | 'Middle' | 'Old'`): Age category of the voice
+**age** (`'Young' | 'Middle' | 'Old'`): Age category of the voice
 
-**style:** (`'Conversational' | 'Narrative'`): Speaking style of the voice
+**style** (`'Conversational' | 'Narrative'`): Speaking style of the voice
 
-**voiceId:** (`string`): Unique identifier for the voice
+**voiceId** (`string`): Unique identifier for the voice
 
 ### listen()
 

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

@@ -51,43 +51,39 @@ const text = await voice.listen(audioStream, {
 
 ### Constructor Options
 
-**speechModel?:** (`SarvamVoiceConfig`): Configuration for text-to-speech synthesis. (Default: `{ model: 'bulbul:v1', language: 'en-IN' }`)
+**speechModel** (`SarvamVoiceConfig`): Configuration for text-to-speech synthesis. (Default: `{ model: 'bulbul:v1', language: 'en-IN' }`)
 
-**speaker?:** (`SarvamVoiceId`): The speaker to be used for the output audio. If not provided, Meera will be used as default. AvailableOptions - meera, pavithra, maitreyi, arvind, amol, amartya, diya, neel, misha, vian, arjun, maya (Default: `'meera'`)
+**speechModel.apiKey** (`string`): Sarvam API key. Falls back to SARVAM\_API\_KEY environment variable.
 
-**listeningModel?:** (`SarvamListenOptions`): Configuration for speech-to-text recognition. (Default: `{ model: 'saarika:v2', language_code: 'unknown' }`)
+**speechModel.model** (`SarvamTTSModel`): Specifies the model to use for text-to-speech conversion.
 
-### SarvamVoiceConfig
+**speechModel.language** (`SarvamTTSLanguage`): Target language for speech synthesis. Available options: hi-IN, bn-IN, kn-IN, ml-IN, mr-IN, od-IN, pa-IN, ta-IN, te-IN, en-IN, gu-IN
 
-**apiKey?:** (`string`): Sarvam API key. Falls back to SARVAM\_API\_KEY environment variable.
+**speechModel.properties** (`object`): Additional voice properties for customization.
 
-**model?:** (`SarvamTTSModel`): Specifies the model to use for text-to-speech conversion. (Default: `'bulbul:v1'`)
+**speechModel.properties.pitch** (`number`): Controls the pitch of the audio. Lower values result in a deeper voice, while higher values make it sharper. The suitable range is between -0.75 and 0.75.
 
-**language:** (`SarvamTTSLanguage`): Target language for speech synthesis. Available options: hi-IN, bn-IN, kn-IN, ml-IN, mr-IN, od-IN, pa-IN, ta-IN, te-IN, en-IN, gu-IN (Default: `'en-IN'`)
+**speechModel.properties.pace** (`number`): Controls the speed of the audio. Lower values result in slower speech, while higher values make it faster. The suitable range is between 0.5 and 2.0. Default is 1.0. Required range: 0.3 <= x <= 3
 
-**properties?:** (`object`): Additional voice properties for customization.
+**speechModel.properties.loudness** (`number`): Controls the loudness of the audio. Lower values result in quieter audio, while higher values make it louder. The suitable range is between 0.3 and 3.0. Required range: 0 <= x <= 3
 
-**properties.pitch?:** (`number`): Controls the pitch of the audio. Lower values result in a deeper voice, while higher values make it sharper. The suitable range is between -0.75 and 0.75.
+**speechModel.properties.speech\_sample\_rate** (`8000 | 16000 | 22050`): Audio sample rate in Hz.
 
-**properties.pace?:** (`number`): Controls the speed of the audio. Lower values result in slower speech, while higher values make it faster. The suitable range is between 0.5 and 2.0. Default is 1.0. Required range: 0.3 <= x <= 3
+**speechModel.properties.enable\_preprocessing** (`boolean`): Controls whether normalization of English words and numeric entities (e.g., numbers, dates) is performed. Set to true for better handling of mixed-language text. Default is false.
 
-**properties.loudness?:** (`number`): Controls the loudness of the audio. Lower values result in quieter audio, while higher values make it louder. The suitable range is between 0.3 and 3.0. Required range: 0 <= x <= 3
+**speechModel.properties.eng\_interpolation\_wt** (`number`): Weight for interpolating with English speaker at encoder.
 
-**properties.speech\_sample\_rate?:** (`8000 | 16000 | 22050`): Audio sample rate in Hz.
+**speaker** (`SarvamVoiceId`): The speaker to be used for the output audio. If not provided, Meera will be used as default. AvailableOptions - meera, pavithra, maitreyi, arvind, amol, amartya, diya, neel, misha, vian, arjun, maya (Default: `'meera'`)
 
-**properties.enable\_preprocessing?:** (`boolean`): Controls whether normalization of English words and numeric entities (e.g., numbers, dates) is performed. Set to true for better handling of mixed-language text. Default is false.
+**listeningModel** (`SarvamListenOptions`): Configuration for speech-to-text recognition. (Default: `{ model: 'saarika:v2', language_code: 'unknown' }`)
 
-**properties.eng\_interpolation\_wt?:** (`number`): Weight for interpolating with English speaker at encoder.
+**listeningModel.apiKey** (`string`): Sarvam API key. Falls back to SARVAM\_API\_KEY environment variable.
 
-### SarvamListenOptions
+**listeningModel.model** (`SarvamSTTModel`): Specifies the model to use for speech-to-text conversion. Note:- Default model is saarika:v2 . Available options: saarika:v1, saarika:v2, saarika:flash
 
-**apiKey?:** (`string`): Sarvam API key. Falls back to SARVAM\_API\_KEY environment variable.
+**listeningModel.languageCode** (`SarvamSTTLanguage`): Specifies the language of the input audio. This parameter is required to ensure accurate transcription. For the saarika:v1 model, this parameter is mandatory. For the saarika:v2 model, it is optional. unknown: Use this when the language is not known; the API will detect it automatically. Note:- that the saarika:v1 model does not support unknown language code. Available options: unknown, hi-IN, bn-IN, kn-IN, ml-IN, mr-IN, od-IN, pa-IN, ta-IN, te-IN, en-IN, gu-IN
 
-**model?:** (`SarvamSTTModel`): Specifies the model to use for speech-to-text conversion. Note:- Default model is saarika:v2 . Available options: saarika:v1, saarika:v2, saarika:flash (Default: `'saarika:v2'`)
-
-**languageCode?:** (`SarvamSTTLanguage`): Specifies the language of the input audio. This parameter is required to ensure accurate transcription. For the saarika:v1 model, this parameter is mandatory. For the saarika:v2 model, it is optional. unknown: Use this when the language is not known; the API will detect it automatically. Note:- that the saarika:v1 model does not support unknown language code. Available options: unknown, hi-IN, bn-IN, kn-IN, ml-IN, mr-IN, od-IN, pa-IN, ta-IN, te-IN, en-IN, gu-IN (Default: `'unknown'`)
-
-**filetype?:** (`'mp3' | 'wav'`): Audio format of the input stream.
+**listeningModel.filetype** (`'mp3' | 'wav'`): Audio format of the input stream.
 
 ## Methods
 
@@ -95,9 +91,9 @@ const text = await voice.listen(audioStream, {
 
 Converts text to speech using Sarvam's text-to-speech models.
 
-**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.speaker?:** (`SarvamVoiceId`): Voice ID to use for speech synthesis. (Default: `Constructor's speaker value`)
+**options.speaker** (`SarvamVoiceId`): Voice ID to use for speech synthesis. (Default: `Constructor's speaker value`)
 
 Returns: `Promise<NodeJS.ReadableStream>`
 
@@ -105,9 +101,9 @@ Returns: `Promise<NodeJS.ReadableStream>`
 
 Transcribes audio using Sarvam's speech recognition models.
 
-**input:** (`NodeJS.ReadableStream`): Audio stream to transcribe.
+**input** (`NodeJS.ReadableStream`): Audio stream to transcribe.
 
-**options?:** (`SarvamListenOptions`): Configuration options for speech recognition.
+**options** (`SarvamListenOptions`): Configuration options for speech recognition.
 
 Returns: `Promise<string>`
 

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

@@ -27,15 +27,13 @@ const audioStream = await voice.speak('Hello, world!', {
 
 ## Constructor Parameters
 
-**speechModel?:** (`SpeechifyConfig`): Configuration for text-to-speech functionality (Default: `{ name: 'simba-english' }`)
+**speechModel** (`SpeechifyConfig`): Configuration for text-to-speech functionality (Default: `{ name: 'simba-english' }`)
 
-**speaker?:** (`SpeechifyVoiceId`): Default voice ID to use for speech synthesis (Default: `'george'`)
+**speechModel.name** (`VoiceModelName`): The Speechify model to use
 
-### SpeechifyConfig
+**speechModel.apiKey** (`string`): Speechify API key. Falls back to SPEECHIFY\_API\_KEY environment variable
 
-**name?:** (`VoiceModelName`): The Speechify model to use (Default: `'simba-english'`)
-
-**apiKey?:** (`string`): Speechify API key. Falls back to SPEECHIFY\_API\_KEY environment variable
+**speaker** (`SpeechifyVoiceId`): Default voice ID to use for speech synthesis (Default: `'george'`)
 
 ## Methods
 
@@ -43,11 +41,11 @@ const audioStream = await voice.speak('Hello, world!', {
 
 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.speaker?:** (`string`): Override the default speaker for this request (Default: `Constructor's speaker value`)
+**options.speaker** (`string`): Override the default speaker for this request (Default: `Constructor's speaker value`)
 
-**options.model?:** (`VoiceModelName`): Override the default model for this request (Default: `Constructor's model value`)
+**options.model** (`VoiceModelName`): Override the default model for this request (Default: `Constructor's model value`)
 
 Returns: `Promise<NodeJS.ReadableStream>`
 
@@ -55,13 +53,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()
 

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

@@ -39,7 +39,7 @@ await voice.connect()
 
 ## Parameters
 
-**instructions:** (`string`): Instructions to guide the voice model's behavior
+**instructions** (`string`): Instructions to guide the voice model's behavior
 
 ## Return Value
 

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

@@ -50,7 +50,7 @@ await voice.connect()
 
 ## Parameters
 
-**tools:** (`ToolsInput`): Object containing tool definitions that can be called by the voice model
+**tools** (`ToolsInput`): Object containing tool definitions that can be called by the voice model
 
 ## Return Value
 

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

@@ -39,7 +39,7 @@ await voice.answer()
 
 ## Parameters
 
-**options?:** (`Record<string, unknown>`): Provider-specific options for the response
+**options** (`Record<string, unknown>`): Provider-specific options for the response
 
 ## Return Value
 

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

@@ -46,7 +46,7 @@ await voice.connect({
 
 ## Parameters
 
-**options?:** (`Record<string, unknown>`): Provider-specific connection options
+**options** (`Record<string, unknown>`): Provider-specific connection options
 
 ## Return Value
 
@@ -58,9 +58,9 @@ Each real-time voice provider may support different options for the `connect()`
 
 ### OpenAI Realtime
 
-**options.timeout?:** (`number`): Connection timeout in milliseconds (Default: `30000`)
+**options.timeout** (`number`): Connection timeout in milliseconds (Default: `30000`)
 
-**options.reconnect?:** (`boolean`): Whether to automatically reconnect on connection loss (Default: `false`)
+**options.reconnect** (`boolean`): Whether to automatically reconnect on connection loss (Default: `false`)
 
 ## Using with CompositeVoice
 

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

@@ -6,27 +6,27 @@ Voice providers emit various events during real-time voice interactions. These e
 
 These events are commonly implemented across real-time voice providers:
 
-**error:** (`Error`): Emitted when an error occurs during voice processing or when audio data format is unsupported
+**error** (`Error`): Emitted when an error occurs during voice processing or when audio data format is unsupported
 
-**session.created:** (`object`): Emitted when a new session is created with the OpenAI service
+**session.created** (`object`): Emitted when a new session is created with the OpenAI service
 
-**session.updated:** (`object`): Emitted when the session configuration is updated
+**session.updated** (`object`): Emitted when the session configuration is updated
 
-**response.created:** (`object`): Emitted when a new response is created by the AI assistant
+**response.created** (`object`): Emitted when a new response is created by the AI assistant
 
-**response.done:** (`object`): Emitted when the AI assistant has completed its response
+**response.done** (`object`): Emitted when the AI assistant has completed its response
 
-**speaker:** (`StreamWithId`): Emitted with a new audio stream that can be piped to an audio output
+**speaker** (`StreamWithId`): Emitted with a new audio stream that can be piped to an audio output
 
-**writing:** (`object`): Emitted when text is being transcribed (user) or generated (assistant)
+**writing** (`object`): Emitted when text is being transcribed (user) or generated (assistant)
 
-**speaking:** (`object`): Emitted when audio data is available from the voice provider
+**speaking** (`object`): Emitted when audio data is available from the voice provider
 
-**speaking.done:** (`object`): Emitted when the voice provider has finished speaking
+**speaking.done** (`object`): Emitted when the voice provider has finished speaking
 
-**tool-call-start:** (`object`): Emitted when the AI assistant starts executing a tool
+**tool-call-start** (`object`): Emitted when the AI assistant starts executing a tool
 
-**tool-call-result:** (`object`): Emitted when a tool execution is complete with its result
+**tool-call-result** (`object`): Emitted when a tool execution is complete with its result
 
 ## Notes
 

package/.docs/reference/voice/voice.getSpeakers.md

@@ -36,7 +36,7 @@ This method does not accept any parameters.
 
 ## Return Value
 
-**Promise\<Array<{ voiceId: string } & TSpeakerMetadata>>:** (`Promise`): A promise that resolves to an array of voice options, where each option contains at least a voiceId property and may include additional provider-specific metadata.
+**Promise\<Array<{ voiceId: string } & TSpeakerMetadata>>** (`Promise`): A promise that resolves to an array of voice options, where each option contains at least a voiceId property and may include additional provider-specific metadata.
 
 ## Provider-Specific Metadata
 
@@ -44,81 +44,81 @@ Different voice providers return different metadata for their voices:
 
 **OpenAI**:
 
-**voiceId:** (`string`): Unique identifier for the voice (e.g., 'alloy', 'echo', 'fable', 'onyx', 'nova', 'shimmer')
+**voiceId** (`string`): Unique identifier for the voice (e.g., 'alloy', 'echo', 'fable', 'onyx', 'nova', 'shimmer')
 
 **OpenAI Realtime**:
 
-**voiceId:** (`string`): Unique identifier for the voice (e.g., 'alloy', 'echo', 'fable', 'onyx', 'nova', 'shimmer')
+**voiceId** (`string`): Unique identifier for the voice (e.g., 'alloy', 'echo', 'fable', 'onyx', 'nova', 'shimmer')
 
 **Deepgram**:
 
-**voiceId:** (`string`): Unique identifier for the voice
+**voiceId** (`string`): Unique identifier for the voice
 
-**language:** (`string`): Language code embedded in the voice ID (e.g., 'en')
+**language** (`string`): Language code embedded in the voice ID (e.g., 'en')
 
 **ElevenLabs**:
 
-**voiceId:** (`string`): Unique identifier for the voice
+**voiceId** (`string`): Unique identifier for the voice
 
-**name:** (`string`): Human-readable name of the voice
+**name** (`string`): Human-readable name of the voice
 
-**category:** (`string`): Category of the voice (e.g., 'premade', 'cloned')
+**category** (`string`): Category of the voice (e.g., 'premade', 'cloned')
 
 **Google**:
 
-**voiceId:** (`string`): Unique identifier for the voice
+**voiceId** (`string`): Unique identifier for the voice
 
-**languageCodes:** (`string[]`): Array of language codes supported by the voice (e.g., \['en-US'])
+**languageCodes** (`string[]`): Array of language codes supported by the voice (e.g., \['en-US'])
 
 **Azure**:
 
-**voiceId:** (`string`): Unique identifier for the voice
+**voiceId** (`string`): Unique identifier for the voice
 
-**language:** (`string`): Language code extracted from the voice ID (e.g., 'en')
+**language** (`string`): Language code extracted from the voice ID (e.g., 'en')
 
-**region:** (`string`): Region code extracted from the voice ID (e.g., 'US')
+**region** (`string`): Region code extracted from the voice ID (e.g., 'US')
 
 **Murf**:
 
-**voiceId:** (`string`): Unique identifier for the voice
+**voiceId** (`string`): Unique identifier for the voice
 
-**name:** (`string`): Name of the voice (same as voiceId)
+**name** (`string`): Name of the voice (same as voiceId)
 
-**language:** (`string`): Language code extracted from the voice ID (e.g., 'en')
+**language** (`string`): Language code extracted from the voice ID (e.g., 'en')
 
-**gender:** (`string`): Gender of the voice (always 'neutral' in current implementation)
+**gender** (`string`): Gender of the voice (always 'neutral' in current implementation)
 
 **PlayAI**:
 
-**voiceId:** (`string`): Unique identifier for the voice (S3 URL to manifest.json)
+**voiceId** (`string`): Unique identifier for the voice (S3 URL to manifest.json)
 
-**name:** (`string`): Human-readable name of the voice (e.g., 'Angelo', 'Arsenio')
+**name** (`string`): Human-readable name of the voice (e.g., 'Angelo', 'Arsenio')
 
-**accent:** (`string`): Accent of the voice (e.g., 'US', 'Irish', 'US African American')
+**accent** (`string`): Accent of the voice (e.g., 'US', 'Irish', 'US African American')
 
-**gender:** (`string`): Gender of the voice ('M' or 'F')
+**gender** (`string`): Gender of the voice ('M' or 'F')
 
-**age:** (`string`): Age category of the voice (e.g., 'Young', 'Middle')
+**age** (`string`): Age category of the voice (e.g., 'Young', 'Middle')
 
-**style:** (`string`): Speaking style of the voice (e.g., 'Conversational')
+**style** (`string`): Speaking style of the voice (e.g., 'Conversational')
 
 **Speechify**:
 
-**voiceId:** (`string`): Unique identifier for the voice
+**voiceId** (`string`): Unique identifier for the voice
 
-**name:** (`string`): Human-readable name of the voice
+**name** (`string`): Human-readable name of the voice
 
-**language:** (`string`): Language code of the voice (e.g., 'en-US')
+**language** (`string`): Language code of the voice (e.g., 'en-US')
 
 **Sarvam**:
 
-**voiceId:** (`string`): Unique identifier for the voice
+**voiceId** (`string`): Unique identifier for the voice
 
-**name:** (`string`): Human-readable name of the voice
+**name** (`string`): Human-readable name of the voice
 
-**language:** (`string`): Language of the voice (e.g., 'english', 'hindi')
+**language** (`string`): Language of the voice (e.g., 'english', 'hindi')
 
-**gender:** (`string`): Gender of the voice ('male' or 'female')
+**gender** (`string`): Gender of the voice ('male' or 'female')
 
 ## Notes