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

package/.docs/reference/vectors/upstash.md

@@ -1,8 +1,8 @@
-# Upstash Vector Store
+# Upstash vector store
 
 The UpstashVector class provides vector search using [Upstash Vector](https://upstash.com/vector), a serverless vector database service that provides vector similarity search with metadata filtering capabilities and hybrid search support.
 
-## Constructor Options
+## Constructor options
 
 **url** (`string`): Upstash Vector database URL
 
@@ -10,7 +10,7 @@ The UpstashVector class provides vector search using [Upstash Vector](https://up
 
 ## Methods
 
-### createIndex()
+### `createIndex()`
 
 Note: This method is a no-op for Upstash as indexes are created automatically.
 
@@ -20,7 +20,7 @@ Note: This method is a no-op for Upstash as indexes are created automatically.
 
 **metric** (`'cosine' | 'euclidean' | 'dotproduct'`): Distance metric for similarity search (Default: `cosine`)
 
-### upsert()
+### `upsert()`
 
 **indexName** (`string`): Name of the index to upsert into
 
@@ -32,7 +32,7 @@ Note: This method is a no-op for Upstash as indexes are created automatically.
 
 **ids** (`string[]`): Optional vector IDs (auto-generated if not provided)
 
-### query()
+### `query()`
 
 **indexName** (`string`): Name of the index to query
 
@@ -50,11 +50,11 @@ Note: This method is a no-op for Upstash as indexes are created automatically.
 
 **queryMode** (`QueryMode`): Search mode: 'DENSE' for dense-only, 'SPARSE' for sparse-only, or 'HYBRID' for combined search
 
-### listIndexes()
+### `listIndexes()`
 
 Returns an array of index names (namespaces) as strings.
 
-### describeIndex()
+### `describeIndex()`
 
 **indexName** (`string`): Name of the index to describe
 
@@ -68,11 +68,11 @@ interface IndexStats {
 }
 ```
 
-### deleteIndex()
+### `deleteIndex()`
 
 **indexName** (`string`): Name of the index (namespace) to delete
 
-### updateVector()
+### `updateVector()`
 
 **indexName** (`string`): Name of the index to update
 
@@ -86,7 +86,7 @@ The `update` object can have the following properties:
 - `sparseVector` (optional): A sparse vector object with `indices` and `values` arrays for hybrid indexes.
 - `metadata` (optional): A record of key-value pairs for metadata.
 
-### deleteVector()
+### `deleteVector()`
 
 **indexName** (`string`): Name of the index from which to delete the item
 
@@ -94,7 +94,7 @@ The `update` object can have the following properties:
 
 Attempts to delete an item by its ID from the specified index. Logs an error message if the deletion fails.
 
-## Hybrid Vector Search
+## Hybrid vector search
 
 Upstash Vector supports hybrid search that combines semantic search (dense vectors) with keyword-based search (sparse vectors) for improved relevance and accuracy.
 
@@ -182,7 +182,7 @@ await vectorStore.updateVector({
 })
 ```
 
-## Response Types
+## Response types
 
 Query results are returned in this format:
 
@@ -195,7 +195,7 @@ interface QueryResult {
 }
 ```
 
-## Error Handling
+## Error handling
 
 The store throws typed errors that can be caught:
 
@@ -213,14 +213,14 @@ try {
 }
 ```
 
-## Environment Variables
+## Environment variables
 
 Required environment variables:
 
 - `UPSTASH_VECTOR_URL`: Your Upstash Vector database URL
 - `UPSTASH_VECTOR_TOKEN`: Your Upstash Vector API token
 
-## Usage Example
+## Usage example
 
 ### Local embeddings with fastembed
 

package/.docs/reference/vectors/vectorize.md

@@ -1,8 +1,8 @@
-# Cloudflare Vector Store
+# Cloudflare vector store
 
 The CloudflareVector class provides vector search using [Cloudflare Vectorize](https://developers.cloudflare.com/vectorize/), a vector database service integrated with Cloudflare's edge network.
 
-## Constructor Options
+## Constructor options
 
 **accountId** (`string`): Cloudflare account ID
 
@@ -10,7 +10,7 @@ The CloudflareVector class provides vector search using [Cloudflare Vectorize](h
 
 ## Methods
 
-### createIndex()
+### `createIndex()`
 
 **indexName** (`string`): Name of the index to create
 
@@ -18,7 +18,7 @@ The CloudflareVector class provides vector search using [Cloudflare Vectorize](h
 
 **metric** (`'cosine' | 'euclidean' | 'dotproduct'`): Distance metric for similarity search (dotproduct maps to dot-product) (Default: `cosine`)
 
-### upsert()
+### `upsert()`
 
 **indexName** (`string`): Name of the index to upsert into
 
@@ -28,7 +28,7 @@ The CloudflareVector class provides vector search using [Cloudflare Vectorize](h
 
 **ids** (`string[]`): Optional vector IDs (auto-generated if not provided)
 
-### query()
+### `query()`
 
 **indexName** (`string`): Name of the index to query
 
@@ -40,11 +40,11 @@ The CloudflareVector class provides vector search using [Cloudflare Vectorize](h
 
 **includeVector** (`boolean`): Whether to include vectors in the results (Default: `false`)
 
-### listIndexes()
+### `listIndexes()`
 
 Returns an array of index names as strings.
 
-### describeIndex()
+### `describeIndex()`
 
 **indexName** (`string`): Name of the index to describe
 
@@ -58,11 +58,11 @@ interface IndexStats {
 }
 ```
 
-### deleteIndex()
+### `deleteIndex()`
 
 **indexName** (`string`): Name of the index to delete
 
-### createMetadataIndex()
+### `createMetadataIndex()`
 
 Creates an index on a metadata field to enable filtering.
 
@@ -72,7 +72,7 @@ Creates an index on a metadata field to enable filtering.
 
 **indexType** (`'string' | 'number' | 'boolean'`): Type of the metadata field
 
-### deleteMetadataIndex()
+### `deleteMetadataIndex()`
 
 Removes an index from a metadata field.
 
@@ -80,13 +80,13 @@ Removes an index from a metadata field.
 
 **propertyName** (`string`): Name of the metadata field to remove indexing from
 
-### listMetadataIndexes()
+### `listMetadataIndexes()`
 
 Lists all metadata field indexes for an index.
 
 **indexName** (`string`): Name of the index to list metadata indexes for
 
-### updateVector()
+### `updateVector()`
 
 Updates a vector or metadata for a specific ID within an index.
 
@@ -96,7 +96,7 @@ Updates a vector or metadata for a specific ID within an index.
 
 **update** (`{ vector?: number[]; metadata?: Record<string, any>; }`): Object containing the vector and/or metadata to update
 
-### deleteVector()
+### `deleteVector()`
 
 Deletes a vector and its associated metadata for a specific ID within an index.
 
@@ -104,7 +104,7 @@ Deletes a vector and its associated metadata for a specific ID within an index.
 
 **id** (`string`): Unique identifier of the vector and metadata to delete
 
-## Response Types
+## Response types
 
 Query results are returned in this format:
 
@@ -117,7 +117,7 @@ interface QueryResult {
 }
 ```
 
-## Error Handling
+## Error handling
 
 The store throws typed errors that can be caught:
 
@@ -135,7 +135,7 @@ try {
 }
 ```
 
-## Environment Variables
+## Environment variables
 
 Required environment variables:
 

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,7 +61,7 @@ const text = await voice.listen(audioStream)
 
 ## Methods
 
-### speak()
+### `speak()`
 
 Converts text to speech using Azure's neural text-to-speech service.
 
@@ -73,7 +73,7 @@ Converts text to speech using Azure's neural text-to-speech service.
 
 Returns: `Promise<NodeJS.ReadableStream>` - Audio stream in WAV format
 
-### listen()
+### `listen()`
 
 Transcribes audio using Azure's speech-to-text service.
 
@@ -83,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:
 
@@ -95,7 +95,7 @@ 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
 
@@ -105,7 +105,7 @@ Returns: `Promise<Array<{ voiceId: string; language: string; region: string; }>>
 - **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:
 
@@ -120,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,7 +43,7 @@ console.log(speakers)
 
 ## Methods
 
-### speak()
+### `speak()`
 
 Converts text to speech using Cloudflare's text-to-speech service.
 
@@ -57,7 +57,7 @@ Converts text to speech using Cloudflare's text-to-speech service.
 
 Returns: `Promise<NodeJS.ReadableStream>`
 
-### getSpeakers()
+### `getSpeakers()`
 
 Returns an array of available voice options, where each node contains:
 
@@ -74,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,7 +88,7 @@ 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').

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.
 
@@ -146,7 +146,7 @@ Converts text to speech and sends it to the model. Can accept either a string or
 
 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