@mastra/mcp-docs-server 1.1.8 → 1.1.9-alpha.1

package/.docs/reference/vectors/qdrant.md

@@ -1,8 +1,8 @@
-# Qdrant Vector Store
+# Qdrant vector store
 
 The QdrantVector class provides vector search using [Qdrant](https://qdrant.tech/), a vector similarity search engine. It provides a production-ready service with a convenient API to store, search, and manage vectors with additional payload and extended filtering support.
 
-## Constructor Options
+## Constructor options
 
 **url** (`string`): REST URL of the Qdrant instance. Eg. https\://xyz-example.eu-central.aws.cloud.qdrant.io:6333
 
@@ -12,7 +12,7 @@ The QdrantVector class provides vector search using [Qdrant](https://qdrant.tech
 
 ## Methods
 
-### createIndex()
+### `createIndex()`
 
 **indexName** (`string`): Name of the index to create
 
@@ -36,7 +36,7 @@ await store.createIndex({
 })
 ```
 
-### upsert()
+### `upsert()`
 
 **indexName** (`string`): Name of the index to upsert into
 
@@ -68,7 +68,7 @@ await store.upsert({
 })
 ```
 
-### query()
+### `query()`
 
 **indexName** (`string`): Name of the index to query
 
@@ -95,11 +95,11 @@ const results = await store.query({
 })
 ```
 
-### listIndexes()
+### `listIndexes()`
 
 Returns an array of index names as strings.
 
-### describeIndex()
+### `describeIndex()`
 
 **indexName** (`string`): Name of the index to describe
 
@@ -113,11 +113,11 @@ interface IndexStats {
 }
 ```
 
-### deleteIndex()
+### `deleteIndex()`
 
 **indexName** (`string`): Name of the index to delete
 
-### updateVector()
+### `updateVector()`
 
 Update a single vector by ID or by metadata filter. Either `id` or `filter` must be provided, but not both.
 
@@ -131,7 +131,7 @@ Update a single vector by ID or by metadata filter. Either `id` or `filter` must
 
 Updates a vector and/or its metadata in the specified index. If both vector and metadata are provided, both will be updated. If only one is provided, only that will be updated.
 
-### deleteVector()
+### `deleteVector()`
 
 **indexName** (`string`): Name of the index from which to delete the vector
 
@@ -139,7 +139,7 @@ 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()
+### `deleteVectors()`
 
 Delete multiple vectors by IDs or by metadata filter. Either `ids` or `filter` must be provided, but not both.
 
@@ -149,7 +149,7 @@ Delete multiple vectors by IDs or by metadata filter. Either `ids` or `filter` m
 
 **filter** (`Record<string, any>`): Metadata filter to identify vectors to delete (mutually exclusive with ids)
 
-### createPayloadIndex()
+### `createPayloadIndex()`
 
 Creates a payload (metadata) index on a collection field to enable efficient filtering. This is **required** for Qdrant Cloud and any Qdrant instance with `strict_mode_config = true`.
 
@@ -176,7 +176,7 @@ const results = await store.query({
 })
 ```
 
-### deletePayloadIndex()
+### `deletePayloadIndex()`
 
 Removes a payload index from a collection field.
 
@@ -186,7 +186,7 @@ Removes a payload index from a collection field.
 
 **wait** (`boolean`): Whether to wait for the operation to complete (Default: `true`)
 
-## Response Types
+## Response types
 
 Query results are returned in this format:
 
@@ -199,7 +199,7 @@ interface QueryResult {
 }
 ```
 
-## Error Handling
+## Error handling
 
 The store throws typed errors that can be caught:
 

package/.docs/reference/vectors/s3vectors.md

@@ -1,8 +1,8 @@
-# Amazon S3 Vectors Store
+# Amazon S3 vectors store
 
 The `S3Vectors` class provides vector search using [Amazon S3 Vectors (Preview)](https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-vectors.html). It stores vectors in **vector buckets** and performs similarity search in **vector indexes**, with JSON-based metadata filters.
 
-> **Warning:** Amazon S3 Vectors is a Preview service. Preview features may change or be removed without notice and are not covered by AWS SLAs. Behavior, limits, and regional availability can change at any time. This library may introduce breaking changes to stay aligned with AWS.
+> **Warning:** Amazon S3 Vectors is a Preview service. Preview features may change or be removed without notice and aren't covered by AWS SLAs. Behavior, limits, and regional availability can change at any time. This library may introduce breaking changes to stay aligned with AWS.
 
 ## Installation
 
@@ -30,7 +30,7 @@ yarn add @mastra/s3vectors@latest
 bun add @mastra/s3vectors@latest
 ```
 
-## Usage Example
+## Usage example
 
 ```typescript
 import { S3Vectors } from '@mastra/s3vectors'
@@ -82,7 +82,7 @@ const results = await store.query({
 await store.disconnect()
 ```
 
-## Constructor Options
+## Constructor options
 
 **vectorBucketName** (`string`): Target S3 Vectors vector bucket name.
 
@@ -92,7 +92,7 @@ await store.disconnect()
 
 ## Methods
 
-### createIndex()
+### `createIndex()`
 
 Creates a new vector index in the configured vector bucket. If the index already exists, the call validates the schema and becomes a no-op (existing metric and dimension are preserved).
 
@@ -102,9 +102,9 @@ Creates a new vector index in the configured vector bucket. If the index already
 
 **metric** (`'cosine' | 'euclidean'`): Distance metric for similarity search. \`dotproduct\` is not supported by S3 Vectors. (Default: `cosine`)
 
-### upsert()
+### `upsert()`
 
-Adds or replaces vectors (full-record put). If `ids` are not provided, UUIDs are generated.
+Adds or replaces vectors (full-record put). If `ids` aren't provided, UUIDs are generated.
 
 **indexName** (`string`): Name of the index to upsert into
 
@@ -114,7 +114,7 @@ Adds or replaces vectors (full-record put). If `ids` are not provided, UUIDs are
 
 **ids** (`string[]`): Optional vector IDs (auto-generated if not provided)
 
-### query()
+### `query()`
 
 Searches for nearest neighbors with optional metadata filtering.
 
@@ -130,7 +130,7 @@ Searches for nearest neighbors with optional metadata filtering.
 
 > **Note:** Results include `score = 1/(1 + distance)` so that higher is better while preserving the underlying distance ranking.
 
-### describeIndex()
+### `describeIndex()`
 
 Returns information about the index.
 
@@ -146,19 +146,19 @@ interface IndexStats {
 }
 ```
 
-### deleteIndex()
+### `deleteIndex()`
 
 Deletes an index and its data.
 
 **indexName** (`string`): Index to delete.
 
-### listIndexes()
+### `listIndexes()`
 
 Lists all indexes in the configured vector bucket.
 
 Returns: `Promise<string[]>`
 
-### updateVector()
+### `updateVector()`
 
 Updates a vector or metadata for a specific ID within an index.
 
@@ -172,7 +172,7 @@ Updates a vector or metadata for a specific ID within an index.
 
 **update.metadata** (`Record<string, any>`): New metadata to update
 
-### deleteVector()
+### `deleteVector()`
 
 Deletes a specific vector by ID.
 
@@ -180,11 +180,11 @@ Deletes a specific vector by ID.
 
 **id** (`string`): ID to delete.
 
-### disconnect()
+### `disconnect()`
 
 Closes the underlying AWS SDK HTTP handler to free sockets.
 
-## Response Types
+## Response types
 
 Query results are returned in this format:
 
@@ -197,14 +197,14 @@ interface QueryResult {
 }
 ```
 
-## Filter Syntax
+## Filter syntax
 
 S3 Vectors supports a strict subset of operators and value types. The Mastra filter translator:
 
 - **Canonicalizes implicit AND**: `{a:1,b:2}` → `{ $and: [{a:1},{b:2}] }`.
 - **Normalizes Date values** to epoch ms for numeric comparisons and array elements.
 - **Disallows Date** in equality positions (`field: value` or `$eq/$ne`); equality values must be **string | number | boolean**.
-- **Rejects** null/undefined for equality; **array equality** is not supported (use `$in`/`$nin`).
+- **Rejects** null/undefined for equality; **array equality** isn't supported (use `$in`/`$nin`).
 - Only **`$and` / `$or`** are allowed as top-level logical operators.
 - Logical operators must contain **field conditions** (not direct operators).
 
@@ -236,9 +236,9 @@ S3 Vectors supports a strict subset of operators and value types. The Mastra fil
 { timestamp: { $gt: new Date("2024-01-01T00:00:00Z") } }
 ```
 
-> **Note:** If you set `nonFilterableMetadataKeys` at index creation, those keys are stored but **cannot** be used in filters.
+> **Note:** If you set `nonFilterableMetadataKeys` at index creation, those keys are stored but **can't** be used in filters.
 
-## Error Handling
+## Error handling
 
 The store throws typed errors that can be caught:
 
@@ -256,7 +256,7 @@ try {
 }
 ```
 
-## Environment Variables
+## Environment variables
 
 Typical environment variables when wiring your app:
 
@@ -264,9 +264,9 @@ Typical environment variables when wiring your app:
 - `AWS_REGION`: AWS region for the S3 Vectors bucket.
 - **AWS credentials**: via the standard AWS SDK provider chain (`AWS_ACCESS_KEY_ID`, `AWS_SECRET_ACCESS_KEY`, `AWS_PROFILE`, etc.).
 
-## Best Practices
+## Best practices
 
-- Choose the metric (`cosine` or `euclidean`) to match your embedding model; `dotproduct` is not supported.
+- Choose the metric (`cosine` or `euclidean`) to match your embedding model; `dotproduct` isn't supported.
 - Keep **filterable** metadata small and structured (string/number/boolean). Store large text (e.g., `content`) as **non-filterable**.
 - Use **dotted paths** for nested metadata and explicit `$and`/`$or` for complex logic.
 - Avoid calling `describeIndex()` on hot paths—`count` is computed with paginated `ListVectors` (**O(n)**).

package/.docs/reference/vectors/turbopuffer.md

@@ -1,8 +1,8 @@
-# Turbopuffer Vector Store
+# Turbopuffer vector store
 
 The TurbopufferVector class provides vector search using [Turbopuffer](https://turbopuffer.com/), a high-performance vector database optimized for RAG applications. Turbopuffer offers fast vector similarity search with advanced filtering capabilities and efficient storage management.
 
-## Constructor Options
+## Constructor options
 
 **apiKey** (`string`): The API key to authenticate with Turbopuffer
 
@@ -20,7 +20,7 @@ The TurbopufferVector class provides vector search using [Turbopuffer](https://t
 
 ## Methods
 
-### createIndex()
+### `createIndex()`
 
 **indexName** (`string`): Name of the index to create
 
@@ -28,7 +28,7 @@ The TurbopufferVector class provides vector search using [Turbopuffer](https://t
 
 **metric** (`'cosine' | 'euclidean' | 'dotproduct'`): Distance metric for similarity search (Default: `cosine`)
 
-### upsert()
+### `upsert()`
 
 **vectors** (`number[][]`): Array of embedding vectors
 
@@ -36,7 +36,7 @@ The TurbopufferVector class provides vector search using [Turbopuffer](https://t
 
 **ids** (`string[]`): Optional vector IDs (auto-generated if not provided)
 
-### query()
+### `query()`
 
 **indexName** (`string`): Name of the index to query
 
@@ -48,11 +48,11 @@ The TurbopufferVector class provides vector search using [Turbopuffer](https://t
 
 **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
 
@@ -66,11 +66,11 @@ interface IndexStats {
 }
 ```
 
-### deleteIndex()
+### `deleteIndex()`
 
 **indexName** (`string`): Name of the index to delete
 
-### updateVector()
+### `updateVector()`
 
 Update a single vector by ID or by metadata filter. Either `id` or `filter` must be provided, but not both.
 
@@ -82,13 +82,13 @@ Update a single vector by ID or by metadata filter. Either `id` or `filter` must
 
 **update** (`{ vector?: number[]; metadata?: Record<string, any>; }`): Object containing the vector and/or metadata to update
 
-### deleteVector()
+### `deleteVector()`
 
 **indexName** (`string`): Name of the index containing the vector
 
 **id** (`string`): ID of the vector to delete
 
-### deleteVectors()
+### `deleteVectors()`
 
 Delete multiple vectors by IDs or by metadata filter. Either `ids` or `filter` must be provided, but not both.
 
@@ -98,7 +98,7 @@ Delete multiple vectors by IDs or by metadata filter. Either `ids` or `filter` m
 
 **filter** (`Record<string, any>`): Metadata filter to identify vectors to delete (mutually exclusive with ids)
 
-## Response Types
+## Response types
 
 Query results are returned in this format:
 
@@ -111,7 +111,7 @@ interface QueryResult {
 }
 ```
 
-## Schema Configuration
+## Schema configuration
 
 The `schemaConfigForIndex` option allows you to define explicit schemas for different indexes:
 
@@ -134,7 +134,7 @@ schemaConfigForIndex: (indexName: string) => {
 }
 ```
 
-## Error Handling
+## Error handling
 
 The store throws typed errors that can be caught:
 

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: