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

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

@@ -1,4 +1,4 @@
-# Convex Vector Store
+# Convex vector store
 
 The ConvexVector class provides vector storage and similarity search using [Convex](https://convex.dev). It stores embeddings inside Convex and performs cosine similarity search.
 
@@ -28,11 +28,11 @@ yarn add @mastra/convex@latest
 bun add @mastra/convex@latest
 ```
 
-## Convex Setup
+## Convex setup
 
 Before using `ConvexVector`, you need to set up the Convex schema and storage handler. See [Convex Storage Setup](https://mastra.ai/reference/storage/convex) for setup instructions.
 
-## Constructor Options
+## Constructor options
 
 **deploymentUrl** (`string`): Convex deployment URL (e.g., https\://your-project.convex.cloud)
 
@@ -40,7 +40,7 @@ Before using `ConvexVector`, you need to set up the Convex schema and storage ha
 
 **storageFunction** (`string`): Path to the storage mutation function (Default: `mastra/storage:handle`)
 
-## Constructor Examples
+## Constructor examples
 
 ### Basic Configuration
 
@@ -67,7 +67,7 @@ const vectorStore = new ConvexVector({
 
 ## Methods
 
-### createIndex()
+### `createIndex()`
 
 **indexName** (`string`): Name of the index to create
 
@@ -82,7 +82,7 @@ await vectorStore.createIndex({
 })
 ```
 
-### upsert()
+### `upsert()`
 
 **indexName** (`string`): Name of the index to upsert vectors into
 
@@ -101,7 +101,7 @@ await vectorStore.upsert({
 });
 ```
 
-### query()
+### `query()`
 
 **indexName** (`string`): Name of the index to query
 
@@ -122,7 +122,7 @@ const results = await vectorStore.query({
 });
 ```
 
-### listIndexes()
+### `listIndexes()`
 
 Returns an array of index names as strings.
 
@@ -131,7 +131,7 @@ const indexes = await vectorStore.listIndexes()
 // ["my_vectors", "embeddings", ...]
 ```
 
-### describeIndex()
+### `describeIndex()`
 
 **indexName** (`string`): Name of the index to describe
 
@@ -145,7 +145,7 @@ interface IndexStats {
 }
 ```
 
-### deleteIndex()
+### `deleteIndex()`
 
 **indexName** (`string`): Name of the index to delete
 
@@ -155,7 +155,7 @@ Deletes the index and all its vectors.
 await vectorStore.deleteIndex({ indexName: 'my_vectors' })
 ```
 
-### updateVector()
+### `updateVector()`
 
 Update a single vector by ID or by metadata filter. Either `id` or `filter` must be provided, but not both.
 
@@ -188,7 +188,7 @@ await vectorStore.updateVector({
 })
 ```
 
-### deleteVector()
+### `deleteVector()`
 
 **indexName** (`string`): Name of the index containing the vector
 
@@ -198,7 +198,7 @@ await vectorStore.updateVector({
 await vectorStore.deleteVector({ indexName: 'my_vectors', id: 'vector123' })
 ```
 
-### deleteVectors()
+### `deleteVectors()`
 
 Delete multiple vectors by IDs or by metadata filter. Either `ids` or `filter` must be provided, but not both.
 
@@ -222,7 +222,7 @@ await vectorStore.deleteVectors({
 })
 ```
 
-## Response Types
+## Response types
 
 Query results are returned in this format:
 
@@ -235,7 +235,7 @@ interface QueryResult {
 }
 ```
 
-## Metadata Filtering
+## Metadata filtering
 
 ConvexVector supports metadata filtering with various operators:
 

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

@@ -1,4 +1,4 @@
-# Couchbase Vector Store
+# Couchbase vector store
 
 The `CouchbaseVector` class provides vector search using [Couchbase Vector Search](https://docs.couchbase.com/server/current/vector-search/vector-search.html). It enables efficient similarity search and metadata filtering within your Couchbase collections.
 
@@ -33,7 +33,7 @@ yarn add @mastra/couchbase@latest
 bun add @mastra/couchbase@latest
 ```
 
-## Usage Example
+## Usage example
 
 ```typescript
 import { CouchbaseVector } from '@mastra/couchbase'
@@ -49,7 +49,7 @@ const store = new CouchbaseVector({
 })
 ```
 
-## Constructor Options
+## Constructor options
 
 **id** (`string`): Unique identifier for this vector store instance
 
@@ -69,7 +69,7 @@ const store = new CouchbaseVector({
 
 ## Methods
 
-### createIndex()
+### `createIndex()`
 
 Creates a new vector index in Couchbase.
 
@@ -81,11 +81,11 @@ Creates a new vector index in Couchbase.
 
 **metric** (`'cosine' | 'euclidean' | 'dotproduct'`): Distance metric for similarity search (Default: `cosine`)
 
-### upsert()
+### `upsert()`
 
 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.
+> **Note:** You can upsert data before or after creating the index. The `upsert` method doesn't require the index to exist. Couchbase allows multiple Search indexes over the same collection.
 
 **indexName** (`string`): Name of the index to insert into
 
@@ -95,11 +95,11 @@ Adds or updates vectors and their metadata in the collection.
 
 **ids** (`string[]`): Optional vector IDs (auto-generated if not provided)
 
-### query()
+### `query()`
 
 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.
+> **Warning:** The `filter` and `includeVector` parameters aren't 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
 
@@ -113,7 +113,7 @@ Searches for similar vectors.
 
 **minScore** (`number`): Minimum similarity score threshold (Default: `0`)
 
-### describeIndex()
+### `describeIndex()`
 
 Returns information about the index.
 
@@ -129,21 +129,21 @@ interface IndexStats {
 }
 ```
 
-### deleteIndex()
+### `deleteIndex()`
 
 Deletes an index and all its data.
 
 **indexName** (`string`): Name of the index to delete
 
-### listIndexes()
+### `listIndexes()`
 
 Lists all vector indexes in the Couchbase bucket.
 
 Returns: `Promise<string[]>`
 
-### updateVector()
+### `updateVector()`
 
-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.
+Updates a specific vector entry by its ID with new vector data and/or metadata. **Note:** Filter-based updates aren't yet implemented for Couchbase.
 
 **indexName** (`string`): Name of the index containing the vector
 
@@ -151,7 +151,7 @@ Updates a specific vector entry by its ID with new vector data and/or metadata.
 
 **update** (`{ vector?: number[]; metadata?: Record<string, any>; }`): Object containing the vector and/or metadata to update
 
-### deleteVector()
+### `deleteVector()`
 
 Deletes a single vector by its ID from the index.
 
@@ -159,19 +159,19 @@ Deletes a single vector by its ID from the index.
 
 **id** (`string`): ID of the vector to delete
 
-### deleteVectors()
+### `deleteVectors()`
 
-Deletes multiple vectors by their IDs. **Note:** Filter-based deletion is not yet implemented for Couchbase.
+Deletes multiple vectors by their IDs. **Note:** Filter-based deletion isn't yet implemented for Couchbase.
 
 **indexName** (`string`): Name of the index containing the vectors to delete
 
 **ids** (`string[]`): Array of vector IDs to delete
 
-### disconnect()
+### `disconnect()`
 
 Closes the Couchbase client connection. Should be called when done using the store.
 
-## Response Types
+## Response types
 
 Query results are returned in this format:
 
@@ -184,7 +184,7 @@ interface QueryResult {
 }
 ```
 
-## Error Handling
+## Error handling
 
 The store throws typed errors that can be caught:
 
@@ -210,7 +210,7 @@ try {
 
 ## Notes
 
-- **Index Deletion Caveat:** Deleting a Search index does NOT delete the vectors/documents in the associated Couchbase collection. Data remains unless explicitly removed.
+- **Index Deletion Caveat:** Deleting a Search index doesn't delete the vectors/documents in the associated Couchbase collection. Data remains unless explicitly removed.
 - **Required Permissions:** The Couchbase user must have permissions to connect, read/write documents in the target collection (`kv` role), and manage Search Indexes (`search_admin` role on the relevant bucket/scope).
 - **Index Definition Details & Document Structure:** The `createIndex` method constructs a Search Index definition that indexes the `embedding` field (as type `vector`) and the `content` field (as type `text`), targeting documents within the specified `scopeName.collectionName`. Each document stores the vector in the `embedding` field and metadata in the `metadata` field. If `metadata` contains a `text` property, its value is also copied to a top-level `content` field, which is indexed for text search.
 - **Replication & Durability:** Consider using Couchbase's built-in replication and persistence features for data durability. Monitor index statistics regularly to ensure efficient search.
@@ -219,7 +219,7 @@ try {
 
 - Index creation delays may impact immediate querying after creation.
 - No hard enforcement of vector dimension at ingest time (dimension mismatches will error at query time).
-- Vector insertion and index updates are eventually consistent; strong consistency is not guaranteed immediately after writes.
+- Vector insertion and index updates are eventually consistent; strong consistency isn't guaranteed immediately after writes.
 
 ## Related
 

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

@@ -1,4 +1,4 @@
-# DuckDBVector Store
+# DuckDB vector store
 
 The DuckDB storage implementation provides an embedded high-performance vector search solution using [DuckDB](https://duckdb.org/), an in-process analytical database. It uses the VSS extension for vector similarity search with HNSW indexing, offering a lightweight and efficient vector database that requires no external server.
 
@@ -73,7 +73,7 @@ const results = await store.query({
 await store.close();
 ```
 
-## Constructor Options
+## Constructor options
 
 **id** (`string`): Unique identifier for the vector store instance
 
@@ -85,7 +85,7 @@ await store.close();
 
 ## Methods
 
-### createIndex()
+### `createIndex()`
 
 Creates a new vector collection with optional HNSW index for fast approximate nearest neighbor search.
 
@@ -95,7 +95,7 @@ Creates a new vector collection with optional HNSW index for fast approximate ne
 
 **metric** (`'cosine' | 'euclidean' | 'dotproduct'`): Distance metric for similarity search (Default: `cosine`)
 
-### upsert()
+### `upsert()`
 
 Adds or updates vectors and their metadata in the index.
 
@@ -107,7 +107,7 @@ Adds or updates vectors and their metadata in the index.
 
 **ids** (`string[]`): Optional vector IDs (auto-generated UUIDs if not provided)
 
-### query()
+### `query()`
 
 Searches for similar vectors with optional metadata filtering.
 
@@ -121,7 +121,7 @@ Searches for similar vectors with optional metadata filtering.
 
 **includeVector** (`boolean`): Whether to include vector data in results (Default: `false`)
 
-### describeIndex()
+### `describeIndex()`
 
 Gets information about an index.
 
@@ -137,19 +137,19 @@ interface IndexStats {
 }
 ```
 
-### deleteIndex()
+### `deleteIndex()`
 
 Deletes an index and all its data.
 
 **indexName** (`string`): Name of the index to delete
 
-### listIndexes()
+### `listIndexes()`
 
 Lists all vector indexes in the database.
 
 Returns: `Promise<string[]>`
 
-### updateVector()
+### `updateVector()`
 
 Update a single vector by ID or by metadata filter. Either `id` or `filter` must be provided, but not both.
 
@@ -165,7 +165,7 @@ Update a single vector by ID or by metadata filter. Either `id` or `filter` must
 
 **update.metadata** (`Record<string, any>`): New metadata to update
 
-### deleteVector()
+### `deleteVector()`
 
 Deletes a specific vector entry from an index by its ID.
 
@@ -173,7 +173,7 @@ Deletes a specific vector entry from an index by its ID.
 
 **id** (`string`): ID of the vector entry to delete
 
-### deleteVectors()
+### `deleteVectors()`
 
 Delete multiple vectors by IDs or by metadata filter. Either `ids` or `filter` must be provided, but not both.
 
@@ -183,7 +183,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)
 
-### close()
+### `close()`
 
 Closes the database connection and releases resources.
 
@@ -191,7 +191,7 @@ Closes the database connection and releases resources.
 await store.close()
 ```
 
-## Response Types
+## Response types
 
 Query results are returned in this format:
 
@@ -204,7 +204,7 @@ interface QueryResult {
 }
 ```
 
-## Filter Operators
+## Filter operators
 
 DuckDB vector store supports MongoDB-like filter operators:
 
@@ -239,7 +239,7 @@ const results = await store.query({
 });
 ```
 
-## Distance Metrics
+## Distance metrics
 
 | Metric       | Description       | Score Interpretation   | Best For                            |
 | ------------ | ----------------- | ---------------------- | ----------------------------------- |
@@ -247,7 +247,7 @@ const results = await store.query({
 | `euclidean`  | L2 distance       | 0-∞ (0 = most similar) | Image embeddings, spatial data      |
 | `dotproduct` | Inner product     | Higher = more similar  | When vector magnitude matters       |
 
-## Error Handling
+## Error handling
 
 The store throws specific errors for different failure cases:
 
@@ -276,7 +276,7 @@ Common error cases include:
 - Empty filter or ids array in delete/update operations
 - Mutual exclusivity violations (providing both `id` and `filter`)
 
-## Use Cases
+## Use cases
 
 ### Embedded Semantic Search
 

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

@@ -1,6 +1,6 @@
-# ElasticSearch Vector Store
+# Elasticsearch vector store
 
-The ElasticSearchVector class provides vector search using [ElasticSearch](https://www.elastic.co/elasticsearch/) with its `dense_vector` field type and k-NN search capabilities. It's part of the `@mastra/elasticsearch` package.
+The `ElasticSearchVector` class provides vector search using [Elasticsearch](https://www.elastic.co/elasticsearch/) with its `dense_vector` field type and k-NN search capabilities. It's part of the `@mastra/elasticsearch` package.
 
 ## Installation
 
@@ -65,15 +65,15 @@ const results = await store.query({
 });
 ```
 
-## Constructor Options
+## Constructor options
 
 **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
 
-### createIndex()
+### `createIndex()`
 
 Creates a new index with the specified configuration.
 
@@ -83,7 +83,7 @@ Creates a new index with the specified configuration.
 
 **metric** (`'cosine' | 'euclidean' | 'dotproduct'`): Distance metric for similarity search (Default: `cosine`)
 
-### upsert()
+### `upsert()`
 
 Adds or updates vectors and their metadata in the index.
 
@@ -95,7 +95,7 @@ Adds or updates vectors and their metadata in the index.
 
 **ids** (`string[]`): Optional vector IDs (auto-generated if not provided)
 
-### query()
+### `query()`
 
 Searches for similar vectors with optional metadata filtering.
 
@@ -109,7 +109,7 @@ Searches for similar vectors with optional metadata filtering.
 
 **includeVector** (`boolean`): Whether to include vector data in results (Default: `false`)
 
-### describeIndex()
+### `describeIndex()`
 
 Gets information about an index.
 
@@ -125,19 +125,19 @@ interface IndexStats {
 }
 ```
 
-### deleteIndex()
+### `deleteIndex()`
 
 Deletes an index and all its data.
 
 **indexName** (`string`): Name of the index to delete
 
-### listIndexes()
+### `listIndexes()`
 
 Lists all vector indexes.
 
 Returns: `Promise<string[]>`
 
-### updateVector()
+### `updateVector()`
 
 Update a single vector by ID or by metadata filter. Either `id` or `filter` must be provided, but not both.
 
@@ -153,7 +153,7 @@ Update a single vector by ID or by metadata filter. Either `id` or `filter` must
 
 **update.metadata** (`Record<string, any>`): New metadata
 
-### deleteVector()
+### `deleteVector()`
 
 Deletes a single vector by its ID.
 
@@ -161,7 +161,7 @@ Deletes a single vector by its ID.
 
 **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.
 
@@ -171,7 +171,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:
 

package/.docs/reference/vectors/lance.md

@@ -1,8 +1,8 @@
-# Lance Vector Store
+# Lance vector store
 
 The LanceVectorStore class provides vector search using [LanceDB](https://lancedb.github.io/lancedb/), an embedded vector database built on the Lance columnar format. It offers efficient storage and fast similarity search for both local development and production deployments.
 
-## Factory Method
+## Factory method
 
 The LanceVectorStore uses a factory pattern for creation. You should use the static `create()` method rather than the constructor directly.
 
@@ -10,7 +10,7 @@ The LanceVectorStore uses a factory pattern for creation. You should use the sta
 
 **options** (`ConnectionOptions`): Additional connection options for LanceDB
 
-## Constructor Examples
+## Constructor examples
 
 You can create a `LanceVectorStore` instance using the static create method:
 
@@ -31,7 +31,7 @@ const s3Store = await LanceVectorStore.create('s3://bucket/db', {
 
 ## Methods
 
-### createIndex()
+### `createIndex()`
 
 **tableName** (`string`): Name of the table to create index in
 
@@ -43,7 +43,7 @@ const s3Store = await LanceVectorStore.create('s3://bucket/db', {
 
 **indexConfig** (`LanceIndexConfig`): Index configuration (Default: `{ type: 'hnsw' }`)
 
-#### LanceIndexConfig
+#### `LanceIndexConfig`
 
 **type** (`'ivfflat' | 'hnsw'`): Index type (Default: `hnsw`)
 
@@ -61,7 +61,7 @@ const s3Store = await LanceVectorStore.create('s3://bucket/db', {
 
 **hnsw\.efConstruction** (`number`): Build-time complexity (default: 100)
 
-### createTable()
+### `createTable()`
 
 **tableName** (`string`): Name of the table to create
 
@@ -69,7 +69,7 @@ const s3Store = await LanceVectorStore.create('s3://bucket/db', {
 
 **options** (`Partial<CreateTableOptions>`): Additional table creation options
 
-### upsert()
+### `upsert()`
 
 **tableName** (`string`): Name of the table to upsert vectors into
 
@@ -79,7 +79,7 @@ const s3Store = await LanceVectorStore.create('s3://bucket/db', {
 
 **ids** (`string[]`): Optional vector IDs (auto-generated if not provided)
 
-### query()
+### `query()`
 
 **tableName** (`string`): Name of the table to query
 
@@ -95,7 +95,7 @@ const s3Store = await LanceVectorStore.create('s3://bucket/db', {
 
 **includeAllColumns** (`boolean`): Whether to include all columns in the result (Default: `false`)
 
-### listTables()
+### `listTables()`
 
 Returns an array of table names as strings.
 
@@ -104,25 +104,25 @@ const tables = await vectorStore.listTables()
 // ['my_vectors', 'embeddings', 'documents']
 ```
 
-### getTableSchema()
+### `getTableSchema()`
 
 **tableName** (`string`): Name of the table to describe
 
 Returns the schema of the specified table.
 
-### deleteTable()
+### `deleteTable()`
 
 **tableName** (`string`): Name of the table to delete
 
-### deleteAllTables()
+### `deleteAllTables()`
 
 Deletes all tables in the database.
 
-### listIndexes()
+### `listIndexes()`
 
 Returns an array of index names as strings.
 
-### describeIndex()
+### `describeIndex()`
 
 **indexName** (`string`): Name of the index to describe
 
@@ -143,11 +143,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.
 
@@ -159,13 +159,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.
 
@@ -175,11 +175,11 @@ 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)
 
-### close()
+### `close()`
 
 Closes the database connection.
 
-## Response Types
+## Response types
 
 Query results are returned in this format:
 
@@ -193,7 +193,7 @@ interface QueryResult {
 }
 ```
 
-## Error Handling
+## Error handling
 
 The store throws typed errors that can be caught:
 
@@ -210,7 +210,7 @@ try {
 }
 ```
 
-## Best Practices
+## Best practices
 
 - Use the appropriate index type for your use case: