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

package/.docs/reference/vectors/convex.md

@@ -34,11 +34,11 @@ Before using `ConvexVector`, you need to set up the Convex schema and storage ha
 
 ## Constructor Options
 
-**deploymentUrl:** (`string`): Convex deployment URL (e.g., https\://your-project.convex.cloud)
+**deploymentUrl** (`string`): Convex deployment URL (e.g., https\://your-project.convex.cloud)
 
-**adminAuthToken:** (`string`): Convex admin authentication token
+**adminAuthToken** (`string`): Convex admin authentication token
 
-**storageFunction?:** (`string`): Path to the storage mutation function (Default: `mastra/storage:handle`)
+**storageFunction** (`string`): Path to the storage mutation function (Default: `mastra/storage:handle`)
 
 ## Constructor Examples
 
@@ -69,11 +69,11 @@ const vectorStore = new ConvexVector({
 
 ### 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 (only cosine is currently supported) (Default: `cosine`)
+**metric** (`'cosine' | 'euclidean' | 'dotproduct'`): Distance metric for similarity search (only cosine is currently supported) (Default: `cosine`)
 
 ```typescript
 await vectorStore.createIndex({
@@ -84,13 +84,13 @@ await vectorStore.createIndex({
 
 ### 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)
 
 ```typescript
 await vectorStore.upsert({
@@ -103,15 +103,15 @@ await vectorStore.upsert({
 
 ### query()
 
-**indexName:** (`string`): Name of the index to query
+**indexName** (`string`): Name of the index to query
 
-**queryVector:** (`number[]`): Query vector
+**queryVector** (`number[]`): Query vector
 
-**topK?:** (`number`): Number of results to return (Default: `10`)
+**topK** (`number`): Number of results to return (Default: `10`)
 
-**filter?:** (`Record<string, any>`): Metadata filters
+**filter** (`Record<string, any>`): Metadata filters
 
-**includeVector?:** (`boolean`): Whether to include the vector in the result (Default: `false`)
+**includeVector** (`boolean`): Whether to include the vector in the result (Default: `false`)
 
 ```typescript
 const results = await vectorStore.query({
@@ -133,7 +133,7 @@ const indexes = await vectorStore.listIndexes()
 
 ### describeIndex()
 
-**indexName:** (`string`): Name of the index to describe
+**indexName** (`string`): Name of the index to describe
 
 Returns:
 
@@ -147,7 +147,7 @@ interface IndexStats {
 
 ### deleteIndex()
 
-**indexName:** (`string`): Name of the index to delete
+**indexName** (`string`): Name of the index to delete
 
 Deletes the index and all its vectors.
 
@@ -159,13 +159,13 @@ await vectorStore.deleteIndex({ indexName: 'my_vectors' })
 
 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
 
 ```typescript
 // Update by ID
@@ -190,9 +190,9 @@ await vectorStore.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
 
 ```typescript
 await vectorStore.deleteVector({ indexName: 'my_vectors', id: 'vector123' })
@@ -202,11 +202,11 @@ await vectorStore.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)
 
 ```typescript
 // Delete by IDs

package/.docs/reference/vectors/couchbase.md

@@ -51,21 +51,21 @@ const store = new CouchbaseVector({
 
 ## Constructor Options
 
-**id:** (`string`): Unique identifier for this vector store instance
+**id** (`string`): Unique identifier for this vector store instance
 
-**connectionString:** (`string`): Couchbase connection string
+**connectionString** (`string`): Couchbase connection string
 
-**username:** (`string`): Couchbase username
+**username** (`string`): Couchbase username
 
-**password:** (`string`): Couchbase password
+**password** (`string`): Couchbase password
 
-**bucketName:** (`string`): Name of the Couchbase bucket to use
+**bucketName** (`string`): Name of the Couchbase bucket to use
 
-**scopeName:** (`string`): Name of the Couchbase scope to use
+**scopeName** (`string`): Name of the Couchbase scope to use
 
-**collectionName:** (`string`): Name of the Couchbase collection to use
+**collectionName** (`string`): Name of the Couchbase collection to use
 
-**options?:** (`CouchbaseClientOptions`): Optional Couchbase client options
+**options** (`CouchbaseClientOptions`): Optional Couchbase client options
 
 ## Methods
 
@@ -75,11 +75,11 @@ Creates a new vector index in Couchbase.
 
 > **Note:** Index creation is asynchronous. After calling `createIndex`, allow time (typically 1–5 seconds for small datasets, longer for large ones) before querying. For production, implement polling to check index status rather than using fixed delays.
 
-**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`)
 
 ### upsert()
 
@@ -87,13 +87,13 @@ Adds or updates vectors and their metadata in the collection.
 
 > **Note:** You can upsert data before or after creating the index. The `upsert` method does not require the index to exist. Couchbase allows multiple Search indexes over the same collection.
 
-**indexName:** (`string`): Name of the index to insert into
+**indexName** (`string`): Name of the index to insert 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()
 
@@ -101,23 +101,23 @@ Searches for similar vectors.
 
 > **Warning:** The `filter` and `includeVector` parameters are not currently supported. Filtering must be performed client-side after retrieving results, or by using the Couchbase SDK's Search capabilities directly. To retrieve the vector embedding, fetch the full document by ID using the Couchbase SDK.
 
-**indexName:** (`string`): Name of the index to search in
+**indexName** (`string`): Name of the index to search in
 
-**queryVector:** (`number[]`): Query vector to find similar vectors for
+**queryVector** (`number[]`): Query vector to find similar vectors for
 
-**topK?:** (`number`): Number of results to return (Default: `10`)
+**topK** (`number`): Number of results to return (Default: `10`)
 
-**filter?:** (`Record<string, any>`): Metadata filters
+**filter** (`Record<string, any>`): Metadata filters
 
-**includeVector?:** (`boolean`): Whether to include vector data in results (Default: `false`)
+**includeVector** (`boolean`): Whether to include vector data in results (Default: `false`)
 
-**minScore?:** (`number`): Minimum similarity score threshold (Default: `0`)
+**minScore** (`number`): Minimum similarity score threshold (Default: `0`)
 
 ### describeIndex()
 
 Returns information about the index.
 
-**indexName:** (`string`): Name of the index to describe
+**indexName** (`string`): Name of the index to describe
 
 Returns:
 
@@ -133,7 +133,7 @@ interface IndexStats {
 
 Deletes an index and all its data.
 
-**indexName:** (`string`): Name of the index to delete
+**indexName** (`string`): Name of the index to delete
 
 ### listIndexes()
 
@@ -145,27 +145,27 @@ Returns: `Promise<string[]>`
 
 Updates a specific vector entry by its ID with new vector data and/or metadata. **Note:** Filter-based updates are not yet implemented for Couchbase.
 
-**indexName:** (`string`): Name of the index containing the vector
+**indexName** (`string`): Name of the index containing the vector
 
-**id:** (`string`): ID of the vector entry to update
+**id** (`string`): ID of the vector entry to update
 
-**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
 
 ### deleteVector()
 
 Deletes a single vector by its ID from the index.
 
-**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()
 
 Deletes multiple vectors by their IDs. **Note:** Filter-based deletion is not yet implemented for Couchbase.
 
-**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
+**ids** (`string[]`): Array of vector IDs to delete
 
 ### disconnect()
 

package/.docs/reference/vectors/duckdb.md

@@ -75,13 +75,13 @@ await store.close();
 
 ## Constructor Options
 
-**id:** (`string`): Unique identifier for the vector store instance
+**id** (`string`): Unique identifier for the vector store instance
 
-**path?:** (`string`): Database file path. Use ':memory:' for in-memory database, or a file path like './vectors.duckdb' for persistence. (Default: `':memory:'`)
+**path** (`string`): Database file path. Use ':memory:' for in-memory database, or a file path like './vectors.duckdb' for persistence. (Default: `':memory:'`)
 
-**dimensions?:** (`number`): Default dimension for vector embeddings (Default: `1536`)
+**dimensions** (`number`): Default dimension for vector embeddings (Default: `1536`)
 
-**metric?:** (`'cosine' | 'euclidean' | 'dotproduct'`): Default distance metric for similarity search (Default: `cosine`)
+**metric** (`'cosine' | 'euclidean' | 'dotproduct'`): Default distance metric for similarity search (Default: `cosine`)
 
 ## Methods
 
@@ -89,43 +89,43 @@ await store.close();
 
 Creates a new vector collection with optional HNSW index for fast approximate nearest neighbor search.
 
-**indexName:** (`string`): Name of the index to create
+**indexName** (`string`): Name of the index to create
 
-**dimension:** (`number`): Vector dimension size (must match your embedding model)
+**dimension** (`number`): Vector dimension size (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`)
 
 ### upsert()
 
 Adds or updates vectors and their metadata in the index.
 
-**indexName:** (`string`): Name of the index to insert into
+**indexName** (`string`): Name of the index to insert 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 UUIDs if not provided)
+**ids** (`string[]`): Optional vector IDs (auto-generated UUIDs if not provided)
 
 ### query()
 
 Searches for similar vectors with optional metadata filtering.
 
-**indexName:** (`string`): Name of the index to search in
+**indexName** (`string`): Name of the index to search in
 
-**queryVector:** (`number[]`): Query vector to find similar vectors for
+**queryVector** (`number[]`): Query vector to find similar vectors for
 
-**topK?:** (`number`): Number of results to return (Default: `10`)
+**topK** (`number`): Number of results to return (Default: `10`)
 
-**filter?:** (`Filter`): Metadata filters using MongoDB-like query syntax
+**filter** (`Filter`): Metadata filters using MongoDB-like query syntax
 
-**includeVector?:** (`boolean`): Whether to include vector data in results (Default: `false`)
+**includeVector** (`boolean`): Whether to include vector data in results (Default: `false`)
 
 ### describeIndex()
 
 Gets information about an index.
 
-**indexName:** (`string`): Name of the index to describe
+**indexName** (`string`): Name of the index to describe
 
 Returns:
 
@@ -141,7 +141,7 @@ interface IndexStats {
 
 Deletes an index and all its data.
 
-**indexName:** (`string`): Name of the index to delete
+**indexName** (`string`): Name of the index to delete
 
 ### listIndexes()
 
@@ -153,35 +153,35 @@ Returns: `Promise<string[]>`
 
 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 entry to update (mutually exclusive with filter)
+**id** (`string`): ID of the vector entry 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:** (`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 entry from an index by its ID.
 
-**indexName:** (`string`): Name of the index containing the vector
+**indexName** (`string`): Name of the index containing the vector
 
-**id:** (`string`): ID of the vector entry to delete
+**id** (`string`): ID of the vector entry 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)
 
 ### close()
 

package/.docs/reference/vectors/elasticsearch.md

@@ -67,9 +67,9 @@ const results = await store.query({
 
 ## Constructor Options
 
-**id:** (`string`): Unique identifier for this vector store instance
+**id** (`string`): Unique identifier for this vector store instance
 
-**url:** (`string`): ElasticSearch connection URL (e.g., 'http\://localhost:9200')
+**url** (`string`): ElasticSearch connection URL (e.g., 'http\://localhost:9200')
 
 ## Methods
 
@@ -77,43 +77,43 @@ const results = await store.query({
 
 Creates a new index with the specified configuration.
 
-**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`)
 
 ### upsert()
 
 Adds or updates vectors and their metadata in the index.
 
-**indexName:** (`string`): Name of the index to insert into
+**indexName** (`string`): Name of the index to insert 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 similar vectors with optional metadata filtering.
 
-**indexName:** (`string`): Name of the index to search in
+**indexName** (`string`): Name of the index to search in
 
-**queryVector:** (`number[]`): Query vector to find similar vectors for
+**queryVector** (`number[]`): Query vector to find similar vectors for
 
-**topK?:** (`number`): Number of results to return (Default: `10`)
+**topK** (`number`): Number of results to return (Default: `10`)
 
-**filter?:** (`Record<string, any>`): Metadata filters
+**filter** (`Record<string, any>`): Metadata filters
 
-**includeVector?:** (`boolean`): Whether to include vector data in results (Default: `false`)
+**includeVector** (`boolean`): Whether to include vector data in results (Default: `false`)
 
 ### describeIndex()
 
 Gets information about an index.
 
-**indexName:** (`string`): Name of the index to describe
+**indexName** (`string`): Name of the index to describe
 
 Returns:
 
@@ -129,7 +129,7 @@ interface IndexStats {
 
 Deletes an index and all its data.
 
-**indexName:** (`string`): Name of the index to delete
+**indexName** (`string`): Name of the index to delete
 
 ### listIndexes()
 
@@ -141,35 +141,35 @@ Returns: `Promise<string[]>`
 
 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:** (`object`): Update data containing vector and/or metadata
+**update** (`object`): Update data containing vector and/or metadata
 
-**update.vector?:** (`number[]`): New vector data
+**update.vector** (`number[]`): New vector data
 
-**update.metadata?:** (`Record<string, any>`): New metadata
+**update.metadata** (`Record<string, any>`): New metadata
 
 ### deleteVector()
 
 Deletes a single vector by its ID.
 
-**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)
 
 ## Response Types