@mastra/mcp-docs-server 1.1.9-alpha.0 → 1.1.9-alpha.2

package/.docs/reference/vectors/astra.md

@@ -1,8 +1,8 @@
-# Astra Vector Store
+# Astra vector store
 
 The AstraVector class provides vector search using [DataStax Astra DB](https://www.datastax.com/products/datastax-astra), a cloud-native, serverless database built on Apache Cassandra. It provides vector search capabilities with enterprise-grade scalability and high availability.
 
-## Constructor Options
+## Constructor options
 
 **token** (`string`): Astra DB API token
 
@@ -12,7 +12,7 @@ The AstraVector class provides vector search using [DataStax Astra DB](https://w
 
 ## Methods
 
-### createIndex()
+### `createIndex()`
 
 **indexName** (`string`): Name of the index to create
 
@@ -20,7 +20,7 @@ The AstraVector class provides vector search using [DataStax Astra DB](https://w
 
 **metric** (`'cosine' | 'euclidean' | 'dotproduct'`): Distance metric for similarity search (maps to dot\_product for dotproduct) (Default: `cosine`)
 
-### upsert()
+### `upsert()`
 
 **indexName** (`string`): Name of the index to upsert into
 
@@ -30,7 +30,7 @@ The AstraVector class provides vector search using [DataStax Astra DB](https://w
 
 **ids** (`string[]`): Optional vector IDs (auto-generated if not provided)
 
-### query()
+### `query()`
 
 **indexName** (`string`): Name of the index to query
 
@@ -42,11 +42,11 @@ The AstraVector class provides vector search using [DataStax Astra DB](https://w
 
 **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
 
@@ -60,11 +60,11 @@ interface IndexStats {
 }
 ```
 
-### deleteIndex()
+### `deleteIndex()`
 
 **indexName** (`string`): Name of the index to delete
 
-### updateVector()
+### `updateVector()`
 
 **indexName** (`string`): Name of the index containing the vector
 
@@ -72,13 +72,13 @@ interface IndexStats {
 
 **update** (`object`): Update object containing vector and/or metadata changes
 
-### deleteVector()
+### `deleteVector()`
 
 **indexName** (`string`): Name of the index containing the vector
 
 **id** (`string`): ID of the vector to delete
 
-## Response Types
+## Response types
 
 Query results are returned in this format:
 
@@ -91,7 +91,7 @@ interface QueryResult {
 }
 ```
 
-## Error Handling
+## Error handling
 
 The store throws typed errors that can be caught:
 
@@ -109,7 +109,7 @@ try {
 }
 ```
 
-## Environment Variables
+## Environment variables
 
 Required environment variables:
 

package/.docs/reference/vectors/chroma.md

@@ -1,4 +1,4 @@
-# Chroma Vector Store
+# Chroma vector store
 
 The ChromaVector class provides vector search using [Chroma](https://docs.trychroma.com/docs/overview/getting-started), an open-source embedding database. It offers efficient vector search with metadata filtering and hybrid search capabilities.
 
@@ -10,7 +10,7 @@ The ChromaVector class provides vector search using [Chroma](https://docs.trychr
 >
 > [Get started with Chroma Cloud](https://trychroma.com/signup)
 
-## Constructor Options
+## Constructor options
 
 **host** (`string`): The host address of the Chroma server. Defaults to 'localhost'
 
@@ -28,7 +28,7 @@ The ChromaVector class provides vector search using [Chroma](https://docs.trychr
 
 **fetchOptions** (`RequestInit`): Additional fetch options for HTTP requests
 
-## Running a Chroma Server
+## Running a Chroma server
 
 If you are a Chroma Cloud user, provide the `ChromaVector` constructor your API key, tenant, and database name.
 
@@ -42,7 +42,7 @@ Otherwise, you have several options for setting up your single-node Chroma serve
 
 ## Methods
 
-### createIndex()
+### `createIndex()`
 
 **indexName** (`string`): Name of the index to create
 
@@ -50,7 +50,7 @@ Otherwise, you have several options for setting up your single-node Chroma serve
 
 **metric** (`'cosine' | 'euclidean' | 'dotproduct'`): Distance metric for similarity search (Default: `cosine`)
 
-### forkIndex()
+### `forkIndex()`
 
 Note: Forking is only supported on Chroma Cloud, or if you deploy your own OSS **distributed** Chroma.
 
@@ -60,7 +60,7 @@ Note: Forking is only supported on Chroma Cloud, or if you deploy your own OSS *
 
 **newIndexName** (`string`): The name of the forked index
 
-### upsert()
+### `upsert()`
 
 **indexName** (`string`): Name of the index to upsert into
 
@@ -72,7 +72,7 @@ Note: Forking is only supported on Chroma Cloud, or if you deploy your own OSS *
 
 **documents** (`string[]`): Chroma-specific: Original text documents associated with the vectors
 
-### query()
+### `query()`
 
 Query an index using a `queryVector`. Returns an array of semantically similar records in order of distance from the `queryVector`. Each record has the shape:
 
@@ -100,7 +100,7 @@ You can also provide the shape of your metadata to a `query` call for type infer
 
 **documentFilter** (`Record<string, any>`): Chroma-specific: Filter to apply on the document content
 
-### get()
+### `get()`
 
 Get records from your Chroma index by IDs, metadata, and document filters. It returns an array of records of the shape:
 
@@ -129,11 +129,11 @@ You can also provide the shape of your metadata to a `get` call for type inferen
 
 **offset** (`number`): Offset for returning records. Use with \`limit\` to paginate results.
 
-### listIndexes()
+### `listIndexes()`
 
 Returns an array of index names as strings.
 
-### describeIndex()
+### `describeIndex()`
 
 **indexName** (`string`): Name of the index to describe
 
@@ -147,11 +147,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.
 
@@ -187,13 +187,13 @@ await vectorStore.updateVector({
 })
 ```
 
-### deleteVector()
+### `deleteVector()`
 
 **indexName** (`string`): Name of the index containing the vector to delete
 
 **id** (`string`): ID of the vector to delete
 
-### deleteVectors()
+### `deleteVectors()`
 
 Delete multiple vectors by IDs or by metadata filter. This method enables bulk deletion and source-based vector management. Either `ids` or `filter` must be provided, but not both.
 
@@ -227,7 +227,7 @@ await vectorStore.deleteVectors({
 })
 ```
 
-## Response Types
+## Response types
 
 Query results are returned in this format:
 
@@ -241,7 +241,7 @@ interface QueryResult {
 }
 ```
 
-## Error Handling
+## Error handling
 
 The store throws typed errors that can be caught:
 

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,7 +81,7 @@ 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.
 
@@ -95,7 +95,7 @@ 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.
 
@@ -113,7 +113,7 @@ Searches for similar vectors.
 
 **minScore** (`number`): Minimum similarity score threshold (Default: `0`)
 
-### describeIndex()
+### `describeIndex()`
 
 Returns information about the index.
 
@@ -129,19 +129,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 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 aren't yet implemented for Couchbase.
 
@@ -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,7 +159,7 @@ 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 isn't yet implemented for Couchbase.
 
@@ -167,11 +167,11 @@ Deletes multiple vectors by their IDs. **Note:** Filter-based deletion isn't yet
 
 **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:
 

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