@mastra/mcp-docs-server 1.0.0-beta.1 → 1.0.0-beta.10

package/.docs/raw/reference/vectors/pg.mdx

@@ -1,5 +1,5 @@
 ---
-title: "Reference: PG Vector Store | Vectors | Mastra Docs"
+title: "Reference: PG Vector Store | Vectors"
 description: Documentation for the PgVector class in Mastra, which provides vector search using PostgreSQL with pgvector extension.
 ---
 
@@ -403,6 +403,8 @@ interface PGIndexStats {
 
 ### updateVector()
 
+Update a single vector by ID or by metadata filter. Either `id` or `filter` must be provided, but not both.
+
 <PropertiesTable
   content={[
     {
@@ -413,63 +415,42 @@ interface PGIndexStats {
     {
       name: "id",
       type: "string",
-      description: "ID of the vector to update",
+      isOptional: true,
+      description: "ID of the vector to update (mutually exclusive with filter)",
+    },
+    {
+      name: "filter",
+      type: "Record<string, any>",
+      isOptional: true,
+      description: "Metadata filter to identify vector(s) to update (mutually exclusive with id)",
     },
     {
       name: "update",
-      type: "object",
-      description: "Update parameters",
-      properties: [
-        {
-          type: "object",
-          parameters: [
-            {
-              name: "vector",
-              type: "number[]",
-              description: "New vector values",
-              isOptional: true,
-            },
-            {
-              name: "metadata",
-              type: "Record<string, any>",
-              description: "New metadata values",
-              isOptional: true,
-            },
-          ],
-        },
-      ],
+      type: "{ vector?: number[]; metadata?: Record<string, any>; }",
+      description: "Object containing the vector and/or metadata to update",
     },
   ]}
 />
 
-Updates an existing vector by ID. At least one of vector or metadata must be provided.
+Updates an existing vector by ID or filter. At least one of vector or metadata must be provided in the update object.
 
 ```typescript copy
-// Update just the vector
+// Update by ID
 await pgVector.updateVector({
   indexName: "my_vectors",
   id: "vector123",
   update: {
     vector: [0.1, 0.2, 0.3],
-  },
-});
-
-// Update just the metadata
-await pgVector.updateVector({
-  indexName: "my_vectors",
-  id: "vector123",
-  update: {
     metadata: { label: "updated" },
   },
 });
 
-// Update both vector and metadata
+// Update by filter
 await pgVector.updateVector({
   indexName: "my_vectors",
-  id: "vector123",
+  filter: { category: "product" },
   update: {
-    vector: [0.1, 0.2, 0.3],
-    metadata: { label: "updated" },
+    metadata: { status: "reviewed" },
   },
 });
 ```
@@ -497,6 +478,32 @@ Deletes a single vector by ID from the specified index.
 await pgVector.deleteVector({ indexName: "my_vectors", id: "vector123" });
 ```
 
+### deleteVectors()
+
+Delete multiple vectors by IDs or by metadata filter. Either `ids` or `filter` must be provided, but not both.
+
+<PropertiesTable
+  content={[
+    {
+      name: "indexName",
+      type: "string",
+      description: "Name of the index containing the vectors to delete",
+    },
+    {
+      name: "ids",
+      type: "string[]",
+      isOptional: true,
+      description: "Array of vector IDs to delete (mutually exclusive with filter)",
+    },
+    {
+      name: "filter",
+      type: "Record<string, any>",
+      isOptional: true,
+      description: "Metadata filter to identify vectors to delete (mutually exclusive with ids)",
+    },
+  ]}
+/>
+
 ### disconnect()
 
 Closes the database connection pool. Should be called when done using the store.

package/.docs/raw/reference/vectors/pinecone.mdx

@@ -1,5 +1,5 @@
 ---
-title: "Reference: Pinecone Vector Store | Vectors | Mastra Docs"
+title: "Reference: Pinecone Vector Store | Vectors"
 description: Documentation for the PineconeVector class in Mastra, which provides an interface to Pinecone's vector database.
 ---
 
@@ -12,6 +12,11 @@ It provides real-time vector search, with features like hybrid search, metadata
 
 <PropertiesTable
   content={[
+    {
+      name: "id",
+      type: "string",
+      description: "Unique identifier for this vector store instance",
+    },
     {
       name: "apiKey",
       type: "string",
@@ -20,7 +25,22 @@ It provides real-time vector search, with features like hybrid search, metadata
     {
       name: "environment",
       type: "string",
-      description: 'Pinecone environment (e.g., "us-west1-gcp")',
+      isOptional: true,
+      description: "Pinecone environment controller host URL",
+    },
+    {
+      name: "cloud",
+      type: "'aws' | 'gcp' | 'azure'",
+      isOptional: true,
+      defaultValue: "aws",
+      description: "Cloud provider for Pinecone serverless",
+    },
+    {
+      name: "region",
+      type: "string",
+      isOptional: true,
+      defaultValue: "us-east-1",
+      description: "Region for Pinecone serverless",
     },
   ]}
 />
@@ -186,6 +206,8 @@ interface IndexStats {
 
 ### updateVector()
 
+Update a single vector by ID or by metadata filter. Either `id` or `filter` must be provided, but not both.
+
 <PropertiesTable
   content={[
     {
@@ -196,7 +218,20 @@ interface IndexStats {
     {
       name: "id",
       type: "string",
-      description: "ID of the vector to update",
+      isOptional: true,
+      description: "ID of the vector to update (mutually exclusive with filter)",
+    },
+    {
+      name: "filter",
+      type: "Record<string, any>",
+      isOptional: true,
+      description: "Metadata filter to identify vector(s) to update (mutually exclusive with id)",
+    },
+    {
+      name: "namespace",
+      type: "string",
+      isOptional: true,
+      description: "Optional namespace for the update operation",
     },
     {
       name: "update",
@@ -235,6 +270,38 @@ interface IndexStats {
   ]}
 />
 
+### deleteVectors()
+
+Delete multiple vectors by IDs or by metadata filter. Either `ids` or `filter` must be provided, but not both.
+
+<PropertiesTable
+  content={[
+    {
+      name: "indexName",
+      type: "string",
+      description: "Name of the index containing the vectors to delete",
+    },
+    {
+      name: "ids",
+      type: "string[]",
+      isOptional: true,
+      description: "Array of vector IDs to delete (mutually exclusive with filter)",
+    },
+    {
+      name: "filter",
+      type: "Record<string, any>",
+      isOptional: true,
+      description: "Metadata filter to identify vectors to delete (mutually exclusive with ids)",
+    },
+    {
+      name: "namespace",
+      type: "string",
+      isOptional: true,
+      description: "Optional namespace for the deletion operation",
+    },
+  ]}
+/>
+
 ## Response Types
 
 Query results are returned in this format:

package/.docs/raw/reference/vectors/qdrant.mdx

@@ -1,5 +1,5 @@
 ---
-title: "Reference: Qdrant Vector Store | Vectors | Mastra Docs"
+title: "Reference: Qdrant Vector Store | Vectors"
 description: Documentation for integrating Qdrant with Mastra, a vector similarity search engine for managing vectors and payloads.
 ---
 
@@ -159,6 +159,8 @@ interface IndexStats {
 
 ### updateVector()
 
+Update a single vector by ID or by metadata filter. Either `id` or `filter` must be provided, but not both.
+
 <PropertiesTable
   content={[
     {
@@ -169,7 +171,14 @@ interface IndexStats {
     {
       name: "id",
       type: "string",
-      description: "ID of the vector to update",
+      isOptional: true,
+      description: "ID of the vector to update (mutually exclusive with filter)",
+    },
+    {
+      name: "filter",
+      type: "Record<string, any>",
+      isOptional: true,
+      description: "Metadata filter to identify vector(s) to update (mutually exclusive with id)",
     },
     {
       name: "update",
@@ -200,6 +209,32 @@ Updates a vector and/or its metadata in the specified index. If both vector and
 
 Deletes a vector from the specified index by its ID.
 
+### deleteVectors()
+
+Delete multiple vectors by IDs or by metadata filter. Either `ids` or `filter` must be provided, but not both.
+
+<PropertiesTable
+  content={[
+    {
+      name: "indexName",
+      type: "string",
+      description: "Name of the index containing the vectors to delete",
+    },
+    {
+      name: "ids",
+      type: "string[]",
+      isOptional: true,
+      description: "Array of vector IDs to delete (mutually exclusive with filter)",
+    },
+    {
+      name: "filter",
+      type: "Record<string, any>",
+      isOptional: true,
+      description: "Metadata filter to identify vectors to delete (mutually exclusive with ids)",
+    },
+  ]}
+/>
+
 ## Response Types
 
 Query results are returned in this format:

package/.docs/raw/reference/vectors/s3vectors.mdx

@@ -1,5 +1,5 @@
 ---
-title: "Reference: Amazon S3 Vectors Store | Vectors | Mastra Docs"
+title: "Reference: Amazon S3 Vectors Store | Vectors"
 description: Documentation for the S3Vectors class in Mastra, which provides vector search using Amazon S3 Vectors (Preview).
 ---
 

package/.docs/raw/reference/vectors/turbopuffer.mdx

@@ -1,5 +1,5 @@
 ---
-title: "Reference: Turbopuffer Vector Store | Vectors | Mastra Docs"
+title: "Reference: Turbopuffer Vector Store | Vectors"
 description: Documentation for integrating Turbopuffer with Mastra, a high-performance vector database for efficient similarity search.
 ---
 
@@ -190,6 +190,80 @@ interface IndexStats {
   ]}
 />
 
+### updateVector()
+
+Update a single vector by ID or by metadata filter. Either `id` or `filter` must be provided, but not both.
+
+<PropertiesTable
+  content={[
+    {
+      name: "indexName",
+      type: "string",
+      description: "Name of the index containing the vector",
+    },
+    {
+      name: "id",
+      type: "string",
+      isOptional: true,
+      description: "ID of the vector to update (mutually exclusive with filter)",
+    },
+    {
+      name: "filter",
+      type: "Record<string, any>",
+      isOptional: true,
+      description: "Metadata filter to identify vector(s) to update (mutually exclusive with id)",
+    },
+    {
+      name: "update",
+      type: "{ vector?: number[]; metadata?: Record<string, any>; }",
+      description: "Object containing the vector and/or metadata to update",
+    },
+  ]}
+/>
+
+### deleteVector()
+
+<PropertiesTable
+  content={[
+    {
+      name: "indexName",
+      type: "string",
+      description: "Name of the index containing the vector",
+    },
+    {
+      name: "id",
+      type: "string",
+      description: "ID of the vector to delete",
+    },
+  ]}
+/>
+
+### deleteVectors()
+
+Delete multiple vectors by IDs or by metadata filter. Either `ids` or `filter` must be provided, but not both.
+
+<PropertiesTable
+  content={[
+    {
+      name: "indexName",
+      type: "string",
+      description: "Name of the index containing the vectors to delete",
+    },
+    {
+      name: "ids",
+      type: "string[]",
+      isOptional: true,
+      description: "Array of vector IDs to delete (mutually exclusive with filter)",
+    },
+    {
+      name: "filter",
+      type: "Record<string, any>",
+      isOptional: true,
+      description: "Metadata filter to identify vectors to delete (mutually exclusive with ids)",
+    },
+  ]}
+/>
+
 ## Response Types
 
 Query results are returned in this format:

package/.docs/raw/reference/vectors/upstash.mdx

@@ -1,5 +1,5 @@
 ---
-title: "Reference: Upstash Vector Store | Vectors | Mastra Docs"
+title: "Reference: Upstash Vector Store | Vectors"
 description: Documentation for the UpstashVector class in Mastra, which provides vector search using Upstash Vector.
 ---
 

package/.docs/raw/reference/vectors/vectorize.mdx

@@ -1,5 +1,5 @@
 ---
-title: "Reference: Cloudflare Vector Store | Vectors | Mastra Docs"
+title: "Reference: Cloudflare Vector Store | Vectors"
 description: Documentation for the CloudflareVector class in Mastra, which provides vector search using Cloudflare Vectorize.
 ---
 

package/.docs/raw/reference/voice/azure.mdx

@@ -1,5 +1,5 @@
 ---
-title: "Reference: Azure | Voice | Mastra Docs"
+title: "Reference: Azure | Voice"
 description: "Documentation for the AzureVoice class, providing text-to-speech and speech-to-text capabilities using Azure Cognitive Services."
 ---
 
@@ -8,6 +8,8 @@ description: "Documentation for the AzureVoice class, providing text-to-speech a
 The AzureVoice class in Mastra provides text-to-speech and speech-to-text capabilities using Microsoft Azure Cognitive Services.
 
 ## Usage Example
+This requires Azure Speech Services credentials that can be provided through environment variables or directly in the configuration:
+
 
 ```typescript
 import { AzureVoice } from "@mastra/voice-azure";
@@ -15,29 +17,25 @@ import { AzureVoice } from "@mastra/voice-azure";
 // Initialize with configuration
 const voice = new AzureVoice({
   speechModel: {
-    name: "neural",
-    apiKey: "your-azure-speech-api-key",
-    region: "eastus",
+    apiKey: "your-azure-speech-api-key", // Or use AZURE_API_KEY env var
+    region: "eastus", // Or use AZURE_REGION env var
+    voiceName: "en-US-AriaNeural", // Optional: specific voice for TTS
   },
   listeningModel: {
-    name: "whisper",
-    apiKey: "your-azure-speech-api-key",
-    region: "eastus",
+    apiKey: "your-azure-speech-api-key", // Or use AZURE_API_KEY env var
+    region: "eastus", // Or use AZURE_REGION env var
+    language: "en-US", // Optional: recognition language for STT
   },
-  speaker: "en-US-JennyNeural", // Default voice
+  speaker: "en-US-JennyNeural", // Optional: default voice
 });
 
 // Convert text to speech
 const audioStream = await voice.speak("Hello, how can I help you?", {
-  speaker: "en-US-GuyNeural", // Override default voice
-  style: "cheerful", // Voice style
+  speaker: "en-US-GuyNeural", // Optional: override default voice
 });
 
 // Convert speech to text
-const text = await voice.listen(audioStream, {
-  filetype: "wav",
-  language: "en-US",
-});
+const text = await voice.listen(audioStream);
 ```
 
 ## Configuration
@@ -69,26 +67,36 @@ const text = await voice.listen(audioStream, {
 
 ### AzureSpeechConfig
 
+Configuration object for speech synthesis (`speechModel`) and recognition (`listeningModel`).
+
 <PropertiesTable
   content={[
     {
-      name: "name",
-      type: "'neural' | 'standard' | 'whisper'",
-      description: "Model type to use. 'neural' for TTS, 'whisper' for STT.",
+      name: "apiKey",
+      type: "string",
+      description:
+        "Azure Speech Services API key (NOT Azure OpenAI key). Falls back to AZURE_API_KEY environment variable.",
       isOptional: true,
     },
     {
-      name: "apiKey",
+      name: "region",
       type: "string",
       description:
-        "Azure Speech Services API key. Falls back to AZURE_SPEECH_KEY environment variable.",
+        "Azure region (e.g., 'eastus', 'westeurope'). Falls back to AZURE_REGION environment variable.",
       isOptional: true,
     },
     {
-      name: "region",
+      name: "voiceName",
+      type: "string",
+      description:
+        "Voice ID for speech synthesis (e.g., 'en-US-AriaNeural', 'en-US-JennyNeural'). Only used in speechModel. See voice list below.",
+      isOptional: true,
+    },
+    {
+      name: "language",
       type: "string",
       description:
-        "Azure region (e.g., 'eastus', 'westeurope'). Falls back to AZURE_SPEECH_REGION environment variable.",
+        "Recognition language code (e.g., 'en-US', 'fr-FR'). Only used in listeningModel.",
       isOptional: true,
     },
   ]}
@@ -111,32 +119,14 @@ Converts text to speech using Azure's neural text-to-speech service.
     {
       name: "options.speaker",
       type: "string",
-      description: "Voice ID to use for speech synthesis.",
+      description: "Voice ID to use for speech synthesis (e.g., 'en-US-JennyNeural'). Overrides the default voice.",
       isOptional: true,
       defaultValue: "Constructor's speaker value",
     },
-    {
-      name: "options.style",
-      type: "string",
-      description: "Speaking style (e.g., 'cheerful', 'sad', 'angry').",
-      isOptional: true,
-    },
-    {
-      name: "options.rate",
-      type: "string",
-      description: "Speaking rate (e.g., 'slow', 'medium', 'fast').",
-      isOptional: true,
-    },
-    {
-      name: "options.pitch",
-      type: "string",
-      description: "Voice pitch (e.g., 'low', 'medium', 'high').",
-      isOptional: true,
-    },
   ]}
 />
 
-Returns: `Promise<NodeJS.ReadableStream>`
+Returns: `Promise<NodeJS.ReadableStream>` - Audio stream in WAV format
 
 ### listen()
 
@@ -147,31 +137,19 @@ Transcribes audio using Azure's speech-to-text service.
     {
       name: "audioStream",
       type: "NodeJS.ReadableStream",
-      description: "Audio stream to transcribe.",
+      description: "Audio stream to transcribe. Must be in WAV format.",
       isOptional: false,
     },
-    {
-      name: "options.filetype",
-      type: "string",
-      description: "Audio format of the input stream.",
-      isOptional: true,
-      defaultValue: "'wav'",
-    },
-    {
-      name: "options.language",
-      type: "string",
-      description: "Language code for transcription.",
-      isOptional: true,
-      defaultValue: "'en-US'",
-    },
   ]}
 />
 
-Returns: `Promise<string>`
+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()
 
-Returns an array of available voice options, where each node contains:
+Returns an array of available voice options (200+ voices), where each node contains:
 
 <PropertiesTable
   content={[
@@ -179,40 +157,77 @@ Returns an array of available voice options, where each node contains:
       name: "voiceId",
       type: "string",
       description:
-        "Unique identifier for the voice (e.g., 'en-US-JennyNeural')",
-      isOptional: false,
-    },
-    {
-      name: "name",
-      type: "string",
-      description: "Human-readable name of the voice",
+        "Unique identifier for the voice (e.g., 'en-US-JennyNeural', 'fr-FR-DeniseNeural')",
       isOptional: false,
     },
     {
-      name: "locale",
+      name: "language",
       type: "string",
-      description: "Language locale of the voice (e.g., 'en-US')",
+      description: "Language code extracted from voice ID (e.g., 'en', 'fr')",
       isOptional: false,
     },
     {
-      name: "gender",
+      name: "region",
       type: "string",
-      description: "Gender of the voice ('Male' or 'Female')",
+      description: "Region code extracted from voice ID (e.g., 'US', 'GB', 'FR')",
       isOptional: false,
     },
-    {
-      name: "styles",
-      type: "string[]",
-      description: "Available speaking styles for the voice",
-      isOptional: true,
-    },
   ]}
 />
 
-## Notes
+Returns: `Promise<Array<{ voiceId: string; language: string; region: string; }>>`
+
+## Important Notes
+
+### Azure Speech Services vs Azure OpenAI
+
+**⚠️ Critical:** This package uses **Azure Speech Services**, which is different from **Azure OpenAI Services**.
+
+- **DO NOT** use your `AZURE_OPENAI_API_KEY` for this package
+- **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
+
+API keys and regions can be provided via constructor options or environment variables:
+
+- `AZURE_API_KEY` - Your Azure Speech Services subscription key
+- `AZURE_REGION` - Your Azure region (e.g., 'eastus', 'westeurope')
+
+### Voice Capabilities
+
+- Azure offers 200+ neural voices across 50+ languages
+- Each voice ID follows the format: `{language}-{region}-{name}Neural` (e.g., 'en-US-JennyNeural')
+- Some voices include multilingual support or HD quality variants
+- Audio output is in WAV format
+- Audio input for recognition must be in WAV format
+
+## Available Voices
+
+Azure provides 200+ neural voices across many languages. Some popular English voices include:
+
+- **US English:**
+  - `en-US-AriaNeural` (Female, default)
+  - `en-US-JennyNeural` (Female)
+  - `en-US-GuyNeural` (Male)
+  - `en-US-DavisNeural` (Male)
+  - `en-US-AvaNeural` (Female)
+  - `en-US-AndrewNeural` (Male)
+
+- **British English:**
+  - `en-GB-SoniaNeural` (Female)
+  - `en-GB-RyanNeural` (Male)
+  - `en-GB-LibbyNeural` (Female)
+
+- **Australian English:**
+  - `en-AU-NatashaNeural` (Female)
+  - `en-AU-WilliamNeural` (Male)
+
+To get a complete list of all 200+ voices:
+
+```typescript
+const voices = await voice.getSpeakers();
+console.log(voices); // Array of { voiceId, language, region }
+```
 
-- API keys can be provided via constructor options or environment variables (AZURE_SPEECH_KEY and AZURE_SPEECH_REGION)
-- Azure offers a wide range of neural voices across many languages
-- Some voices support speaking styles like cheerful, sad, angry, etc.
-- Speech recognition supports multiple audio formats and languages
-- Azure's speech services provide high-quality neural voices with natural-sounding speech
+For more information, see the [Azure Neural TTS documentation](https://learn.microsoft.com/en-us/azure/cognitive-services/speech-service/language-support?tabs=tts).

package/.docs/raw/reference/voice/cloudflare.mdx

@@ -1,5 +1,5 @@
 ---
-title: "Reference: Cloudflare | Voice | Mastra Docs"
+title: "Reference: Cloudflare | Voice"
 description: "Documentation for the CloudflareVoice class, providing text-to-speech capabilities using Cloudflare Workers AI."
 ---