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

package/.docs/reference/vectors/pg.md

@@ -4,27 +4,27 @@ The PgVector class provides vector search using [PostgreSQL](https://www.postgre
 
 ## Constructor Options
 
-**connectionString?:** (`string`): PostgreSQL connection URL
+**connectionString** (`string`): PostgreSQL connection URL
 
-**host?:** (`string`): PostgreSQL server host
+**host** (`string`): PostgreSQL server host
 
-**port?:** (`number`): PostgreSQL server port
+**port** (`number`): PostgreSQL server port
 
-**database?:** (`string`): PostgreSQL database name
+**database** (`string`): PostgreSQL database name
 
-**user?:** (`string`): PostgreSQL user
+**user** (`string`): PostgreSQL user
 
-**password?:** (`string`): PostgreSQL password
+**password** (`string`): PostgreSQL password
 
-**ssl?:** (`boolean | ConnectionOptions`): Enable SSL or provide custom SSL configuration
+**ssl** (`boolean | ConnectionOptions`): Enable SSL or provide custom SSL configuration
 
-**schemaName?:** (`string`): The name of the schema you want the vector store to use. Will use the default schema if not provided.
+**schemaName** (`string`): The name of the schema you want the vector store to use. Will use the default schema if not provided.
 
-**max?:** (`number`): Maximum number of pool connections (default: 20)
+**max** (`number`): Maximum number of pool connections (default: 20)
 
-**idleTimeoutMillis?:** (`number`): Idle connection timeout in milliseconds (default: 30000)
+**idleTimeoutMillis** (`number`): Idle connection timeout in milliseconds (default: 30000)
 
-**pgPoolOptions?:** (`PoolConfig`): Additional pg pool configuration options
+**pgPoolOptions** (`PoolConfig`): Additional pg pool configuration options
 
 ## Constructor Examples
 
@@ -72,23 +72,35 @@ const vectorStore = new PgVector({
 
 ### createIndex()
 
-**indexName:** (`string`): Name of the index to create
+**indexName** (`string`): Name of the index to create
 
-**dimension:** (`number`): Vector dimension (must match your embedding model)
+**dimension** (`number`): Vector dimension (must match your embedding model)
 
-**metric?:** (`'cosine' | 'euclidean' | 'dotproduct'`): Distance metric for similarity search (Default: `cosine`)
+**metric** (`'cosine' | 'euclidean' | 'dotproduct'`): Distance metric for similarity search (Default: `cosine`)
 
-**indexConfig?:** (`IndexConfig`): Index configuration (Default: `{ type: 'ivfflat' }`)
+**indexConfig** (`IndexConfig`): Index configuration (Default: `{ type: 'ivfflat' }`)
 
-**buildIndex?:** (`boolean`): Whether to build the index (Default: `true`)
+**buildIndex** (`boolean`): Whether to build the index (Default: `true`)
 
 #### IndexConfig
 
-**type:** (`'flat' | 'hnsw' | 'ivfflat'`): stringflat:flatSequential scan (no index) that performs exhaustive search.ivfflat:ivfflatClusters vectors into lists for approximate search.hnsw:hnswGraph-based index offering fast search times and high recall. (Default: `ivfflat`)
+**type** (`'flat' | 'hnsw' | 'ivfflat'`): Index type (Default: `ivfflat`)
 
-**ivf?:** (`IVFConfig`): objectlists?:numberNumber of lists. If not specified, automatically calculated based on dataset size. (Minimum 100, Maximum 4000)
+**type.flat** (`flat`): Sequential scan (no index) that performs exhaustive search.
 
-**hnsw?:** (`HNSWConfig`): objectm?:numberMaximum number of connections per node (default: 8)efConstruction?:numberBuild-time complexity (default: 32)
+**type.ivfflat** (`ivfflat`): Clusters vectors into lists for approximate search.
+
+**type.hnsw** (`hnsw`): Graph-based index offering fast search times and high recall.
+
+**ivf** (`IVFConfig`): IVF configuration
+
+**ivf.lists** (`number`): Number of lists. If not specified, automatically calculated based on dataset size. (Minimum 100, Maximum 4000)
+
+**hnsw** (`HNSWConfig`): HNSW configuration
+
+**hnsw\.m** (`number`): Maximum number of connections per node (default: 8)
+
+**hnsw\.efConstruction** (`number`): Build-time complexity (default: 32)
 
 #### Memory Requirements
 
@@ -102,29 +114,33 @@ Higher M values or efConstruction values will increase memory requirements signi
 
 ### upsert()
 
-**indexName:** (`string`): Name of the index to upsert vectors into
+**indexName** (`string`): Name of the index to upsert vectors into
 
-**vectors:** (`number[][]`): Array of embedding vectors
+**vectors** (`number[][]`): Array of embedding vectors
 
-**metadata?:** (`Record<string, any>[]`): Metadata for each vector
+**metadata** (`Record<string, any>[]`): Metadata for each vector
 
-**ids?:** (`string[]`): Optional vector IDs (auto-generated if not provided)
+**ids** (`string[]`): Optional vector IDs (auto-generated if not provided)
 
 ### query()
 
-**indexName:** (`string`): Name of the index to query
+**indexName** (`string`): Name of the index to query
+
+**queryVector** (`number[]`): Query vector
+
+**topK** (`number`): Number of results to return (Default: `10`)
 
-**queryVector:** (`number[]`): Query vector
+**filter** (`Record<string, any>`): Metadata filters
 
-**topK?:** (`number`): Number of results to return (Default: `10`)
+**includeVector** (`boolean`): Whether to include the vector in the result (Default: `false`)
 
-**filter?:** (`Record<string, any>`): Metadata filters
+**minScore** (`number`): Minimum similarity score threshold (Default: `0`)
 
-**includeVector?:** (`boolean`): Whether to include the vector in the result (Default: `false`)
+**options** (`{ ef?: number; probes?: number }`): Additional options for HNSW and IVF indexes
 
-**minScore?:** (`number`): Minimum similarity score threshold (Default: `0`)
+**options.ef** (`number`): HNSW search parameter
 
-**options?:** (`{ ef?: number; probes?: number }`): objectef?:numberHNSW search parameterprobes?:numberIVF search parameter
+**options.probes** (`number`): IVF search parameter
 
 ### listIndexes()
 
@@ -132,7 +148,7 @@ Returns an array of index names as strings.
 
 ### describeIndex()
 
-**indexName:** (`string`): Name of the index to describe
+**indexName** (`string`): Name of the index to describe
 
 Returns:
 
@@ -153,19 +169,19 @@ interface PGIndexStats {
 
 ### deleteIndex()
 
-**indexName:** (`string`): Name of the index to delete
+**indexName** (`string`): Name of the index to delete
 
 ### updateVector()
 
 Update a single vector by ID or by metadata filter. Either `id` or `filter` must be provided, but not both.
 
-**indexName:** (`string`): Name of the index containing the vector
+**indexName** (`string`): Name of the index containing the vector
 
-**id?:** (`string`): ID of the vector to update (mutually exclusive with filter)
+**id** (`string`): ID of the vector to update (mutually exclusive with filter)
 
-**filter?:** (`Record<string, any>`): Metadata filter to identify vector(s) to update (mutually exclusive with id)
+**filter** (`Record<string, any>`): Metadata filter to identify vector(s) to update (mutually exclusive with id)
 
-**update:** (`{ vector?: number[]; metadata?: Record<string, any>; }`): Object containing the vector and/or metadata to update
+**update** (`{ vector?: number[]; metadata?: Record<string, any>; }`): Object containing the vector and/or metadata to update
 
 Updates an existing vector by ID or filter. At least one of vector or metadata must be provided in the update object.
 
@@ -192,9 +208,9 @@ await pgVector.updateVector({
 
 ### deleteVector()
 
-**indexName:** (`string`): Name of the index containing the vector
+**indexName** (`string`): Name of the index containing the vector
 
-**id:** (`string`): ID of the vector to delete
+**id** (`string`): ID of the vector to delete
 
 Deletes a single vector by ID from the specified index.
 
@@ -206,11 +222,11 @@ await pgVector.deleteVector({ indexName: 'my_vectors', id: 'vector123' })
 
 Delete multiple vectors by IDs or by metadata filter. Either `ids` or `filter` must be provided, but not both.
 
-**indexName:** (`string`): Name of the index containing the vectors to delete
+**indexName** (`string`): Name of the index containing the vectors to delete
 
-**ids?:** (`string[]`): Array of vector IDs to delete (mutually exclusive with filter)
+**ids** (`string[]`): Array of vector IDs to delete (mutually exclusive with filter)
 
-**filter?:** (`Record<string, any>`): Metadata filter to identify vectors to delete (mutually exclusive with ids)
+**filter** (`Record<string, any>`): Metadata filter to identify vectors to delete (mutually exclusive with ids)
 
 ### disconnect()
 
@@ -218,11 +234,11 @@ Closes the database connection pool. Should be called when done using the store.
 
 ### buildIndex()
 
-**indexName:** (`string`): Name of the index to define
+**indexName** (`string`): Name of the index to define
 
-**metric?:** (`'cosine' | 'euclidean' | 'dotproduct'`): Distance metric for similarity search (Default: `cosine`)
+**metric** (`'cosine' | 'euclidean' | 'dotproduct'`): Distance metric for similarity search (Default: `cosine`)
 
-**indexConfig:** (`IndexConfig`): Configuration for the index type and parameters
+**indexConfig** (`IndexConfig`): Configuration for the index type and parameters
 
 Builds or rebuilds an index with specified metric and configuration. Will drop any existing index before creating the new one.
 

package/.docs/reference/vectors/pinecone.md

@@ -6,59 +6,59 @@ The PineconeVector class provides an interface to [Pinecone](https://www.pinecon
 
 The constructor accepts all [Pinecone configuration options](https://docs.pinecone.io/reference/typescript-sdk) plus Mastra-specific fields.
 
-**id:** (`string`): Unique identifier for this vector store instance
+**id** (`string`): Unique identifier for this vector store instance
 
-**apiKey:** (`string`): Pinecone API key
+**apiKey** (`string`): Pinecone API key
 
-**controllerHostUrl?:** (`string`): Custom Pinecone controller host URL
+**controllerHostUrl** (`string`): Custom Pinecone controller host URL
 
-**additionalHeaders?:** (`Record<string, string>`): Additional HTTP headers to include in requests
+**additionalHeaders** (`Record<string, string>`): Additional HTTP headers to include in requests
 
-**sourceTag?:** (`string`): Source tag for request tracking
+**sourceTag** (`string`): Source tag for request tracking
 
-**cloud?:** (`'aws' | 'gcp' | 'azure'`): Cloud provider for new index creation (Default: `aws`)
+**cloud** (`'aws' | 'gcp' | 'azure'`): Cloud provider for new index creation (Default: `aws`)
 
-**region?:** (`string`): Region for new index creation (Default: `us-east-1`)
+**region** (`string`): Region for new index creation (Default: `us-east-1`)
 
 ## Methods
 
 ### createIndex()
 
-**indexName:** (`string`): Name of the index to create
+**indexName** (`string`): Name of the index to create
 
-**dimension:** (`number`): Vector dimension (must match your embedding model)
+**dimension** (`number`): Vector dimension (must match your embedding model)
 
-**metric?:** (`'cosine' | 'euclidean' | 'dotproduct'`): Distance metric for similarity search. Use 'dotproduct' if you plan to use hybrid search. (Default: `cosine`)
+**metric** (`'cosine' | 'euclidean' | 'dotproduct'`): Distance metric for similarity search. Use 'dotproduct' if you plan to use hybrid search. (Default: `cosine`)
 
 ### upsert()
 
-**indexName:** (`string`): Name of your Pinecone index
+**indexName** (`string`): Name of your Pinecone index
 
-**vectors:** (`number[][]`): Array of dense embedding vectors
+**vectors** (`number[][]`): Array of dense embedding vectors
 
-**sparseVectors?:** (`{ indices: number[], values: number[] }[]`): Array of sparse vectors for hybrid search. Each vector must have matching indices and values arrays.
+**sparseVectors** (`{ indices: number[], values: number[] }[]`): Array of sparse vectors for hybrid search. Each vector must have matching indices and values arrays.
 
-**metadata?:** (`Record<string, any>[]`): Metadata for each vector
+**metadata** (`Record<string, any>[]`): Metadata for each vector
 
-**ids?:** (`string[]`): Optional vector IDs (auto-generated if not provided)
+**ids** (`string[]`): Optional vector IDs (auto-generated if not provided)
 
-**namespace?:** (`string`): Optional namespace to store vectors in. Vectors in different namespaces are isolated from each other.
+**namespace** (`string`): Optional namespace to store vectors in. Vectors in different namespaces are isolated from each other.
 
 ### query()
 
-**indexName:** (`string`): Name of the index to query
+**indexName** (`string`): Name of the index to query
 
-**queryVector:** (`number[]`): Dense query vector to find similar vectors
+**queryVector** (`number[]`): Dense query vector to find similar vectors
 
-**sparseVector?:** (`{ indices: number[], values: number[] }`): Optional sparse vector for hybrid search. Must have matching indices and values arrays.
+**sparseVector** (`{ indices: number[], values: number[] }`): Optional sparse vector for hybrid search. Must have matching indices and values arrays.
 
-**topK?:** (`number`): Number of results to return (Default: `10`)
+**topK** (`number`): Number of results to return (Default: `10`)
 
-**filter?:** (`Record<string, any>`): Metadata filters for the query
+**filter** (`Record<string, any>`): Metadata filters for the query
 
-**includeVector?:** (`boolean`): Whether to include the vector in the result (Default: `false`)
+**includeVector** (`boolean`): Whether to include the vector in the result (Default: `false`)
 
-**namespace?:** (`string`): Optional namespace to query vectors from. Only returns results from the specified namespace.
+**namespace** (`string`): Optional namespace to query vectors from. Only returns results from the specified namespace.
 
 ### listIndexes()
 
@@ -66,7 +66,7 @@ Returns an array of index names as strings.
 
 ### describeIndex()
 
-**indexName:** (`string`): Name of the index to describe
+**indexName** (`string`): Name of the index to describe
 
 Returns:
 
@@ -80,43 +80,43 @@ interface IndexStats {
 
 ### deleteIndex()
 
-**indexName:** (`string`): Name of the index to delete
+**indexName** (`string`): Name of the index to delete
 
 ### updateVector()
 
 Update a single vector by ID or by metadata filter. Either `id` or `filter` must be provided, but not both.
 
-**indexName:** (`string`): Name of the index containing the vector
+**indexName** (`string`): Name of the index containing the vector
 
-**id?:** (`string`): ID of the vector to update (mutually exclusive with filter)
+**id** (`string`): ID of the vector to update (mutually exclusive with filter)
 
-**filter?:** (`Record<string, any>`): Metadata filter to identify vector(s) to update (mutually exclusive with id)
+**filter** (`Record<string, any>`): Metadata filter to identify vector(s) to update (mutually exclusive with id)
 
-**namespace?:** (`string`): Optional namespace for the update operation
+**namespace** (`string`): Optional namespace for the update operation
 
-**update:** (`object`): Update parameters
+**update** (`object`): Update parameters
 
-**update.vector?:** (`number[]`): New vector values to update
+**update.vector** (`number[]`): New vector values to update
 
-**update.metadata?:** (`Record<string, any>`): New metadata to update
+**update.metadata** (`Record<string, any>`): New metadata to update
 
 ### deleteVector()
 
-**indexName:** (`string`): Name of the index containing the vector
+**indexName** (`string`): Name of the index containing the vector
 
-**id:** (`string`): ID of the vector to delete
+**id** (`string`): 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.
 
-**indexName:** (`string`): Name of the index containing the vectors to delete
+**indexName** (`string`): Name of the index containing the vectors to delete
 
-**ids?:** (`string[]`): Array of vector IDs to delete (mutually exclusive with filter)
+**ids** (`string[]`): Array of vector IDs to delete (mutually exclusive with filter)
 
-**filter?:** (`Record<string, any>`): Metadata filter to identify vectors to delete (mutually exclusive with ids)
+**filter** (`Record<string, any>`): Metadata filter to identify vectors to delete (mutually exclusive with ids)
 
-**namespace?:** (`string`): Optional namespace for the deletion operation
+**namespace** (`string`): Optional namespace for the deletion operation
 
 ## Response Types
 

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

@@ -4,23 +4,23 @@ The QdrantVector class provides vector search using [Qdrant](https://qdrant.tech
 
 ## Constructor Options
 
-**url:** (`string`): REST URL of the Qdrant instance. Eg. https\://xyz-example.eu-central.aws.cloud.qdrant.io:6333
+**url** (`string`): REST URL of the Qdrant instance. Eg. https\://xyz-example.eu-central.aws.cloud.qdrant.io:6333
 
-**apiKey:** (`string`): Optional Qdrant API key
+**apiKey** (`string`): Optional Qdrant API key
 
-**https:** (`boolean`): Whether to use TLS when setting up the connection. Recommended.
+**https** (`boolean`): Whether to use TLS when setting up the connection. Recommended.
 
 ## Methods
 
 ### createIndex()
 
-**indexName:** (`string`): Name of the index to create
+**indexName** (`string`): Name of the index to create
 
-**dimension:** (`number`): Vector dimension (must match your embedding model). Required for single-vector collections.
+**dimension** (`number`): Vector dimension (must match your embedding model). Required for single-vector collections.
 
-**metric?:** (`'cosine' | 'euclidean' | 'dotproduct'`): Distance metric for similarity search (Default: `cosine`)
+**metric** (`'cosine' | 'euclidean' | 'dotproduct'`): Distance metric for similarity search (Default: `cosine`)
 
-**namedVectors?:** (`Record<string, { size: number; distance: 'cosine' | 'euclidean' | 'dotproduct' }>`): Configuration for named vector spaces. When provided, creates a collection with multiple named vector fields.
+**namedVectors** (`Record<string, { size: number; distance: 'cosine' | 'euclidean' | 'dotproduct' }>`): Configuration for named vector spaces. When provided, creates a collection with multiple named vector fields.
 
 #### Creating a Named Vectors Collection
 
@@ -38,15 +38,15 @@ await store.createIndex({
 
 ### upsert()
 
-**indexName:** (`string`): Name of the index to upsert into
+**indexName** (`string`): Name of the index to upsert into
 
-**vectors:** (`number[][]`): Array of embedding vectors
+**vectors** (`number[][]`): Array of embedding vectors
 
-**metadata?:** (`Record<string, any>[]`): Metadata for each vector
+**metadata** (`Record<string, any>[]`): Metadata for each vector
 
-**ids?:** (`string[]`): Optional vector IDs (auto-generated if not provided)
+**ids** (`string[]`): Optional vector IDs (auto-generated if not provided)
 
-**vectorName?:** (`string`): Name of the vector space to upsert into when using named vectors.
+**vectorName** (`string`): Name of the vector space to upsert into when using named vectors.
 
 #### Upserting into Named Vector Spaces
 
@@ -70,17 +70,17 @@ await store.upsert({
 
 ### query()
 
-**indexName:** (`string`): Name of the index to query
+**indexName** (`string`): Name of the index to query
 
-**queryVector:** (`number[]`): Query vector to find similar vectors
+**queryVector** (`number[]`): Query vector to find similar vectors
 
-**topK?:** (`number`): Number of results to return (Default: `10`)
+**topK** (`number`): Number of results to return (Default: `10`)
 
-**filter?:** (`Record<string, any>`): Metadata filters for the query
+**filter** (`Record<string, any>`): Metadata filters for the query
 
-**includeVector?:** (`boolean`): Whether to include vectors in the results (Default: `false`)
+**includeVector** (`boolean`): Whether to include vectors in the results (Default: `false`)
 
-**using?:** (`string`): Name of the vector field to query when using named vectors. Use this when your collection has multiple named vector fields.
+**using** (`string`): Name of the vector field to query when using named vectors. Use this when your collection has multiple named vector fields.
 
 #### Named Vectors
 
@@ -101,7 +101,7 @@ Returns an array of index names as strings.
 
 ### describeIndex()
 
-**indexName:** (`string`): Name of the index to describe
+**indexName** (`string`): Name of the index to describe
 
 Returns:
 
@@ -115,27 +115,27 @@ interface IndexStats {
 
 ### deleteIndex()
 
-**indexName:** (`string`): Name of the index to delete
+**indexName** (`string`): Name of the index to delete
 
 ### updateVector()
 
 Update a single vector by ID or by metadata filter. Either `id` or `filter` must be provided, but not both.
 
-**indexName:** (`string`): Name of the index to update
+**indexName** (`string`): Name of the index to update
 
-**id?:** (`string`): ID of the vector to update (mutually exclusive with filter)
+**id** (`string`): ID of the vector to update (mutually exclusive with filter)
 
-**filter?:** (`Record<string, any>`): Metadata filter to identify vector(s) to update (mutually exclusive with id)
+**filter** (`Record<string, any>`): Metadata filter to identify vector(s) to update (mutually exclusive with id)
 
-**update:** (`{ vector?: number[]; metadata?: Record<string, any>; }`): Object containing the vector and/or metadata to update
+**update** (`{ vector?: number[]; metadata?: Record<string, any>; }`): Object containing the vector and/or metadata to update
 
 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()
 
-**indexName:** (`string`): Name of the index from which to delete the vector
+**indexName** (`string`): Name of the index from which to delete the vector
 
-**id:** (`string`): ID of the vector to delete
+**id** (`string`): ID of the vector to delete
 
 Deletes a vector from the specified index by its ID.
 
@@ -143,23 +143,23 @@ Deletes a vector from the specified index by its ID.
 
 Delete multiple vectors by IDs or by metadata filter. Either `ids` or `filter` must be provided, but not both.
 
-**indexName:** (`string`): Name of the index containing the vectors to delete
+**indexName** (`string`): Name of the index containing the vectors to delete
 
-**ids?:** (`string[]`): Array of vector IDs to delete (mutually exclusive with filter)
+**ids** (`string[]`): Array of vector IDs to delete (mutually exclusive with filter)
 
-**filter?:** (`Record<string, any>`): Metadata filter to identify vectors to delete (mutually exclusive with ids)
+**filter** (`Record<string, any>`): Metadata filter to identify vectors to delete (mutually exclusive with ids)
 
 ### 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`.
 
-**indexName:** (`string`): Name of the collection to create the payload index on
+**indexName** (`string`): Name of the collection to create the payload index on
 
-**fieldName:** (`string`): Name of the payload field to index
+**fieldName** (`string`): Name of the payload field to index
 
-**fieldSchema:** (`'keyword' | 'integer' | 'float' | 'geo' | 'text' | 'bool' | 'datetime' | 'uuid'`): The schema type for the payload field
+**fieldSchema** (`'keyword' | 'integer' | 'float' | 'geo' | 'text' | 'bool' | 'datetime' | 'uuid'`): The schema type for the payload field
 
-**wait?:** (`boolean`): Whether to wait for the operation to complete (Default: `true`)
+**wait** (`boolean`): Whether to wait for the operation to complete (Default: `true`)
 
 ```typescript
 // Create a keyword index for filtering by source
@@ -180,11 +180,11 @@ const results = await store.query({
 
 Removes a payload index from a collection field.
 
-**indexName:** (`string`): Name of the collection to delete the payload index from
+**indexName** (`string`): Name of the collection to delete the payload index from
 
-**fieldName:** (`string`): Name of the payload field index to delete
+**fieldName** (`string`): Name of the payload field index to delete
 
-**wait?:** (`boolean`): Whether to wait for the operation to complete (Default: `true`)
+**wait** (`boolean`): Whether to wait for the operation to complete (Default: `true`)
 
 ## Response Types
 

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

@@ -84,11 +84,11 @@ await store.disconnect()
 
 ## Constructor Options
 
-**vectorBucketName:** (`string`): Target S3 Vectors vector bucket name.
+**vectorBucketName** (`string`): Target S3 Vectors vector bucket name.
 
-**clientConfig?:** (`S3VectorsClientConfig`): AWS SDK v3 client options (e.g., \`region\`, \`credentials\`).
+**clientConfig** (`S3VectorsClientConfig`): AWS SDK v3 client options (e.g., \`region\`, \`credentials\`).
 
-**nonFilterableMetadataKeys?:** (`string[]`): Metadata keys that should NOT be filterable (applied to the index at creation time). Use this for large text fields like \`content\`.
+**nonFilterableMetadataKeys** (`string[]`): Metadata keys that should NOT be filterable (applied to the index at creation time). Use this for large text fields like \`content\`.
 
 ## Methods
 
@@ -96,37 +96,37 @@ await store.disconnect()
 
 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).
 
-**indexName:** (`string`): Logical index name. Normalized internally: underscores are replaced with hyphens and the name is lowercased.
+**indexName** (`string`): Logical index name. Normalized internally: underscores are replaced with hyphens and the name is lowercased.
 
-**dimension:** (`number`): Vector dimension (must match your embedding model)
+**dimension** (`number`): Vector dimension (must match your embedding model)
 
-**metric?:** (`'cosine' | 'euclidean'`): Distance metric for similarity search. \`dotproduct\` is not supported by S3 Vectors. (Default: `cosine`)
+**metric** (`'cosine' | 'euclidean'`): Distance metric for similarity search. \`dotproduct\` is not supported by S3 Vectors. (Default: `cosine`)
 
 ### upsert()
 
 Adds or replaces vectors (full-record put). If `ids` are not provided, UUIDs are generated.
 
-**indexName:** (`string`): Name of the index to upsert into
+**indexName** (`string`): Name of the index to upsert into
 
-**vectors:** (`number[][]`): Array of embedding vectors
+**vectors** (`number[][]`): Array of embedding vectors
 
-**metadata?:** (`Record<string, any>[]`): Metadata for each vector
+**metadata** (`Record<string, any>[]`): Metadata for each vector
 
-**ids?:** (`string[]`): Optional vector IDs (auto-generated if not provided)
+**ids** (`string[]`): Optional vector IDs (auto-generated if not provided)
 
 ### query()
 
 Searches for nearest neighbors with optional metadata filtering.
 
-**indexName:** (`string`): Name of the index to query
+**indexName** (`string`): Name of the index to query
 
-**queryVector:** (`number[]`): Query vector to find similar vectors
+**queryVector** (`number[]`): Query vector to find similar vectors
 
-**topK?:** (`number`): Number of results to return (Default: `10`)
+**topK** (`number`): Number of results to return (Default: `10`)
 
-**filter?:** (`S3VectorsFilter`): JSON-based metadata filter supporting \`$and\`, \`$or\`, \`$eq\`, \`$ne\`, \`$gt\`, \`$gte\`, \`$lt\`, \`$lte\`, \`$in\`, \`$nin\`, \`$exists\`.
+**filter** (`S3VectorsFilter`): JSON-based metadata filter supporting \`$and\`, \`$or\`, \`$eq\`, \`$ne\`, \`$gt\`, \`$gte\`, \`$lt\`, \`$lte\`, \`$in\`, \`$nin\`, \`$exists\`.
 
-**includeVector?:** (`boolean`): Whether to include vectors in the results (Default: `false`)
+**includeVector** (`boolean`): Whether to include vectors in the results (Default: `false`)
 
 > **Note:** Results include `score = 1/(1 + distance)` so that higher is better while preserving the underlying distance ranking.
 
@@ -134,7 +134,7 @@ Searches for nearest neighbors with optional metadata filtering.
 
 Returns information about the index.
 
-**indexName:** (`string`): Index name to describe.
+**indexName** (`string`): Index name to describe.
 
 Returns:
 
@@ -150,7 +150,7 @@ interface IndexStats {
 
 Deletes an index and its data.
 
-**indexName:** (`string`): Index to delete.
+**indexName** (`string`): Index to delete.
 
 ### listIndexes()
 
@@ -162,23 +162,23 @@ Returns: `Promise<string[]>`
 
 Updates a vector or metadata for a specific ID within an index.
 
-**indexName:** (`string`): Index containing the vector.
+**indexName** (`string`): Index containing the vector.
 
-**id:** (`string`): ID to update.
+**id** (`string`): ID to update.
 
-**update:** (`object`): Update data containing vector and/or metadata
+**update** (`object`): Update data containing vector and/or metadata
 
-**update.vector?:** (`number[]`): New vector data to update
+**update.vector** (`number[]`): New vector data to update
 
-**update.metadata?:** (`Record<string, any>`): New metadata to update
+**update.metadata** (`Record<string, any>`): New metadata to update
 
 ### deleteVector()
 
 Deletes a specific vector by ID.
 
-**indexName:** (`string`): Index containing the vector.
+**indexName** (`string`): Index containing the vector.
 
-**id:** (`string`): ID to delete.
+**id** (`string`): ID to delete.
 
 ### disconnect()