@mastra/core 1.9.0 → 1.10.0

package/dist/docs/references/reference-tools-mcp-server.md

@@ -51,37 +51,37 @@ const server = new MCPServer({
 
 The constructor accepts an `MCPServerConfig` object with the following properties:
 
-**id:** (`string`): Unique identifier for the server. This ID is preserved when the server is registered with Mastra and can be used to retrieve the server via getMCPServerById().
+**id** (`string`): Unique identifier for the server. This ID is preserved when the server is registered with Mastra and can be used to retrieve the server via getMCPServerById().
 
-**name:** (`string`): A descriptive name for your server (e.g., 'My Weather and Agent Server').
+**name** (`string`): A descriptive name for your server (e.g., 'My Weather and Agent Server').
 
-**version:** (`string`): The semantic version of your server (e.g., '1.0.0').
+**version** (`string`): The semantic version of your server (e.g., '1.0.0').
 
-**tools:** (`ToolsInput`): An object where keys are tool names and values are Mastra tool definitions (created with \`createTool\` or Vercel AI SDK). These tools will be directly exposed.
+**tools** (`ToolsInput`): An object where keys are tool names and values are Mastra tool definitions (created with \`createTool\` or Vercel AI SDK). These tools will be directly exposed.
 
-**agents?:** (`Record<string, Agent>`): An object where keys are agent identifiers and values are Mastra Agent instances. Each agent will be automatically converted into a tool named \`ask\_\<agentIdentifier>\`. The agent \*\*must\*\* have a non-empty \`description\` string property defined in its constructor configuration. This description will be used in the tool's description. If an agent's description is missing or empty, an error will be thrown during MCPServer initialization.
+**agents** (`Record<string, Agent>`): An object where keys are agent identifiers and values are Mastra Agent instances. Each agent will be automatically converted into a tool named \`ask\_\<agentIdentifier>\`. The agent \*\*must\*\* have a non-empty \`description\` string property defined in its constructor configuration. This description will be used in the tool's description. If an agent's description is missing or empty, an error will be thrown during MCPServer initialization.
 
-**workflows?:** (`Record<string, Workflow>`): An object where keys are workflow identifiers and values are Mastra Workflow instances. Each workflow is converted into a tool named \`run\_\<workflowKey>\`. The workflow's \`inputSchema\` becomes the tool's input schema. The workflow \*\*must\*\* have a non-empty \`description\` string property, which is used for the tool's description. If a workflow's description is missing or empty, an error will be thrown. The tool executes the workflow by calling \`workflow\.createRun()\` followed by \`run.start({ inputData: \<tool\_input> })\`. If a tool name derived from an agent or workflow (e.g., \`ask\_myAgent\` or \`run\_myWorkflow\`) collides with an explicitly defined tool name or another derived name, the explicitly defined tool takes precedence, and a warning is logged. Agents/workflows leading to subsequent collisions are skipped.
+**workflows** (`Record<string, Workflow>`): An object where keys are workflow identifiers and values are Mastra Workflow instances. Each workflow is converted into a tool named \`run\_\<workflowKey>\`. The workflow's \`inputSchema\` becomes the tool's input schema. The workflow \*\*must\*\* have a non-empty \`description\` string property, which is used for the tool's description. If a workflow's description is missing or empty, an error will be thrown. The tool executes the workflow by calling \`workflow\.createRun()\` followed by \`run.start({ inputData: \<tool\_input> })\`. If a tool name derived from an agent or workflow (e.g., \`ask\_myAgent\` or \`run\_myWorkflow\`) collides with an explicitly defined tool name or another derived name, the explicitly defined tool takes precedence, and a warning is logged. Agents/workflows leading to subsequent collisions are skipped.
 
-**description?:** (`string`): Optional description of what the MCP server does.
+**description** (`string`): Optional description of what the MCP server does.
 
-**instructions?:** (`string`): Optional instructions describing how to use the server and its features.
+**instructions** (`string`): Optional instructions describing how to use the server and its features.
 
-**repository?:** (`Repository`): Optional repository information for the server's source code.
+**repository** (`Repository`): Optional repository information for the server's source code.
 
-**releaseDate?:** (`string`): Optional release date of this server version (ISO 8601 string). Defaults to the time of instantiation if not provided.
+**releaseDate** (`string`): Optional release date of this server version (ISO 8601 string). Defaults to the time of instantiation if not provided.
 
-**isLatest?:** (`boolean`): Optional flag indicating if this is the latest version. Defaults to true if not provided.
+**isLatest** (`boolean`): Optional flag indicating if this is the latest version. Defaults to true if not provided.
 
-**packageCanonical?:** (`'npm' | 'docker' | 'pypi' | 'crates' | string`): Optional canonical packaging format if the server is distributed as a package (e.g., 'npm', 'docker').
+**packageCanonical** (`'npm' | 'docker' | 'pypi' | 'crates' | string`): Optional canonical packaging format if the server is distributed as a package (e.g., 'npm', 'docker').
 
-**packages?:** (`PackageInfo[]`): Optional list of installable packages for this server.
+**packages** (`PackageInfo[]`): Optional list of installable packages for this server.
 
-**remotes?:** (`RemoteInfo[]`): Optional list of remote access points for this server.
+**remotes** (`RemoteInfo[]`): Optional list of remote access points for this server.
 
-**resources?:** (`MCPServerResources`): An object defining how the server should handle MCP resources. See Resource Handling section for details.
+**resources** (`MCPServerResources`): An object defining how the server should handle MCP resources. See Resource Handling section for details.
 
-**prompts?:** (`MCPServerPrompts`): An object defining how the server should handle MCP prompts. See Prompt Handling section for details.
+**prompts** (`MCPServerPrompts`): An object defining how the server should handle MCP prompts. See Prompt Handling section for details.
 
 ## Exposing Agents as Tools
 
@@ -228,15 +228,15 @@ httpServer.listen(PORT, () => {
 
 Here are the details for the values needed by the `startSSE` method:
 
-**url:** (`URL`): The web address the user is requesting.
+**url** (`URL`): The web address the user is requesting.
 
-**ssePath:** (`string`): The specific part of the URL where clients will connect for SSE (e.g., '/sse').
+**ssePath** (`string`): The specific part of the URL where clients will connect for SSE (e.g., '/sse').
 
-**messagePath:** (`string`): The specific part of the URL where clients will send messages (e.g., '/message').
+**messagePath** (`string`): The specific part of the URL where clients will send messages (e.g., '/message').
 
-**req:** (`any`): The incoming request object from your web server.
+**req** (`any`): The incoming request object from your web server.
 
-**res:** (`any`): The response object from your web server, used to send data back.
+**res** (`any`): The response object from your web server, used to send data back.
 
 ### startHonoSSE()
 
@@ -280,15 +280,15 @@ httpServer.listen(PORT, () => {
 
 Here are the details for the values needed by the `startHonoSSE` method:
 
-**url:** (`URL`): The web address the user is requesting.
+**url** (`URL`): The web address the user is requesting.
 
-**ssePath:** (`string`): The specific part of the URL where clients will connect for SSE (e.g., '/hono-sse').
+**ssePath** (`string`): The specific part of the URL where clients will connect for SSE (e.g., '/hono-sse').
 
-**messagePath:** (`string`): The specific part of the URL where clients will send messages (e.g., '/message').
+**messagePath** (`string`): The specific part of the URL where clients will send messages (e.g., '/message').
 
-**req:** (`any`): The incoming request object from your web server.
+**req** (`any`): The incoming request object from your web server.
 
-**res:** (`any`): The response object from your web server, used to send data back.
+**res** (`any`): The response object from your web server, used to send data back.
 
 ### startHTTP()
 
@@ -402,27 +402,27 @@ serve(async req => {
 
 Here are the details for the values needed by the `startHTTP` method:
 
-**url:** (`URL`): The web address the user is requesting.
+**url** (`URL`): The web address the user is requesting.
 
-**httpPath:** (`string`): The specific part of the URL where the MCP server will handle HTTP requests (e.g., '/mcp').
+**httpPath** (`string`): The specific part of the URL where the MCP server will handle HTTP requests (e.g., '/mcp').
 
-**req:** (`http.IncomingMessage`): The incoming request object from your web server.
+**req** (`http.IncomingMessage`): The incoming request object from your web server.
 
-**res:** (`http.ServerResponse`): The response object from your web server, used to send data back.
+**res** (`http.ServerResponse`): The response object from your web server, used to send data back.
 
-**options:** (`StreamableHTTPServerTransportOptions`): Optional configuration for the HTTP transport. See the options table below for more details.
+**options** (`StreamableHTTPServerTransportOptions`): Optional configuration for the HTTP transport. See the options table below for more details.
 
 The `StreamableHTTPServerTransportOptions` object allows you to customize the behavior of the HTTP transport. Here are the available options:
 
-**serverless:** (`boolean`): If \`true\`, runs in stateless mode without session management. Each request is handled independently with a fresh server instance. Essential for serverless environments (Cloudflare Workers, Supabase Edge Functions, Vercel Edge, etc.) where sessions cannot persist between invocations. Defaults to \`false\`.
+**serverless** (`boolean`): If \`true\`, runs in stateless mode without session management. Each request is handled independently with a fresh server instance. Essential for serverless environments (Cloudflare Workers, Supabase Edge Functions, Vercel Edge, etc.) where sessions cannot persist between invocations. Defaults to \`false\`.
 
-**sessionIdGenerator:** (`(() => string) | undefined`): A function that generates a unique session ID. This should be a cryptographically secure, globally unique string. Return \`undefined\` to disable session management.
+**sessionIdGenerator** (`(() => string) | undefined`): A function that generates a unique session ID. This should be a cryptographically secure, globally unique string. Return \`undefined\` to disable session management.
 
-**onsessioninitialized:** (`(sessionId: string) => void`): A callback that is invoked when a new session is initialized. This is useful for tracking active MCP sessions.
+**onsessioninitialized** (`(sessionId: string) => void`): A callback that is invoked when a new session is initialized. This is useful for tracking active MCP sessions.
 
-**enableJsonResponse:** (`boolean`): If \`true\`, the server will return plain JSON responses instead of using Server-Sent Events (SSE) for streaming. Defaults to \`false\`.
+**enableJsonResponse** (`boolean`): If \`true\`, the server will return plain JSON responses instead of using Server-Sent Events (SSE) for streaming. Defaults to \`false\`.
 
-**eventStore:** (`EventStore`): An event store for message resumability. Providing this enables clients to reconnect and resume message streams.
+**eventStore** (`EventStore`): An event store for message resumability. Providing this enables clients to reconnect and resume message streams.
 
 ### close()
 
@@ -516,11 +516,11 @@ async executeTool(
 ): Promise<any>
 ```
 
-**toolId:** (`string`): The ID/name of the tool to execute.
+**toolId** (`string`): The ID/name of the tool to execute.
 
-**args:** (`any`): The arguments to pass to the tool's execute function.
+**args** (`any`): The arguments to pass to the tool's execute function.
 
-**executionContext?:** (`object`): Optional context for the tool execution, like messages or a toolCallId.
+**executionContext** (`object`): Optional context for the tool execution, like messages or a toolCallId.
 
 ## Resource Handling
 
@@ -1073,17 +1073,17 @@ const customMiddleware = createOAuthMiddleware({
 
 ### OAuth Middleware Options
 
-**oauth.resource:** (`string`): The canonical URL of your MCP server. This is returned in Protected Resource Metadata.
+**oauth.resource** (`string`): The canonical URL of your MCP server. This is returned in Protected Resource Metadata.
 
-**oauth.authorizationServers:** (`string[]`): URLs of authorization servers that can issue tokens for this resource.
+**oauth.authorizationServers** (`string[]`): URLs of authorization servers that can issue tokens for this resource.
 
-**oauth.scopesSupported?:** (`string[]`): Scopes supported by this MCP server. (Default: `['mcp:read', 'mcp:write']`)
+**oauth.scopesSupported** (`string[]`): Scopes supported by this MCP server. (Default: `['mcp:read', 'mcp:write']`)
 
-**oauth.resourceName?:** (`string`): Human-readable name for this resource server.
+**oauth.resourceName** (`string`): Human-readable name for this resource server.
 
-**oauth.validateToken?:** (`(token: string, resource: string) => Promise<TokenValidationResult>`): Function to validate access tokens. If not provided, tokens are accepted without validation (NOT recommended for production).
+**oauth.validateToken** (`(token: string, resource: string) => Promise<TokenValidationResult>`): Function to validate access tokens. If not provided, tokens are accepted without validation (NOT recommended for production).
 
-**mcpPath?:** (`string`): Path where the MCP endpoint is served. Only requests to this path require authentication. (Default: `'/mcp'`)
+**mcpPath** (`string`): Path where the MCP endpoint is served. Only requests to this path require authentication. (Default: `'/mcp'`)
 
 ## Authentication Context
 

package/dist/docs/references/reference-tools-vector-query-tool.md

@@ -19,53 +19,65 @@ const queryTool = createVectorQueryTool({
 
 > **Note:** **Parameter Requirements:** Most fields can be set at creation as defaults. Some fields can be overridden at runtime via the request context or input. If a required field is missing from both creation and runtime, an error will be thrown. Note that `model`, `id`, and `description` can only be set at creation time.
 
-**id?:** (`string`): Custom ID for the tool. By default: 'VectorQuery {vectorStoreName} {indexName} Tool'. (Set at creation only.)
+**id** (`string`): Custom ID for the tool. By default: 'VectorQuery {vectorStoreName} {indexName} Tool'. (Set at creation only.)
 
-**description?:** (`string`): Custom description for the tool. By default: 'Access the knowledge base to find information needed to answer user questions' (Set at creation only.)
+**description** (`string`): Custom description for the tool. By default: 'Access the knowledge base to find information needed to answer user questions' (Set at creation only.)
 
-**model:** (`EmbeddingModel`): Embedding model to use for vector search. (Set at creation only.)
+**model** (`EmbeddingModel`): Embedding model to use for vector search. (Set at creation only.)
 
-**vectorStoreName:** (`string`): Name of the vector store to query. (Can be set at creation or overridden at runtime.)
+**vectorStoreName** (`string`): Name of the vector store to query. (Can be set at creation or overridden at runtime.)
 
-**indexName:** (`string`): Name of the index within the vector store. (Can be set at creation or overridden at runtime.)
+**indexName** (`string`): Name of the index within the vector store. (Can be set at creation or overridden at runtime.)
 
-**enableFilter?:** (`boolean`): Enable filtering of results based on metadata. (Set at creation only, but will be automatically enabled if a filter is provided in the request context.) (Default: `false`)
+**enableFilter** (`boolean`): Enable filtering of results based on metadata. (Set at creation only, but will be automatically enabled if a filter is provided in the request context.) (Default: `false`)
 
-**includeVectors?:** (`boolean`): Include the embedding vectors in the results. (Can be set at creation or overridden at runtime.) (Default: `false`)
+**includeVectors** (`boolean`): Include the embedding vectors in the results. (Can be set at creation or overridden at runtime.) (Default: `false`)
 
-**includeSources?:** (`boolean`): Include the full retrieval objects in the results. (Can be set at creation or overridden at runtime.) (Default: `true`)
+**includeSources** (`boolean`): Include the full retrieval objects in the results. (Can be set at creation or overridden at runtime.) (Default: `true`)
 
-**reranker?:** (`RerankConfig`): Options for reranking results. (Can be set at creation or overridden at runtime.)
+**reranker** (`RerankConfig`): Options for reranking results. (Can be set at creation or overridden at runtime.)
 
-**databaseConfig?:** (`DatabaseConfig`): Database-specific configuration options for optimizing queries. (Can be set at creation or overridden at runtime.)
+**reranker.model** (`MastraLanguageModel`): Language model to use for reranking
 
-**providerOptions?:** (`Record<string, Record<string, any>>`): Provider-specific options for the embedding model (e.g., outputDimensionality). \*\*Important\*\*: Only works with AI SDK EmbeddingModelV2 models. For V1 models, configure options when creating the model itself.
+**reranker.options** (`RerankerOptions`): Options for the reranking process
 
-**vectorStore?:** (`MastraVector | VectorStoreResolver`): Direct vector store instance or a resolver function for dynamic selection. Use a function for multi-tenant applications where the vector store is selected based on request context. When provided, \`vectorStoreName\` becomes optional.
+**reranker.options.weights** (`WeightConfig`): Weights for scoring components (semantic: 0.4, vector: 0.4, position: 0.2)
 
-### DatabaseConfig
+**reranker.options.topK** (`number`): Number of top results to return
 
-The `DatabaseConfig` type allows you to specify database-specific configurations that are automatically applied to query operations. This enables you to take advantage of unique features and optimizations offered by different vector stores.
+**databaseConfig** (`DatabaseConfig`): Database-specific configuration options for optimizing queries. (Can be set at creation or overridden at runtime.)
 
-**pinecone?:** (`PineconeConfig`): objectnamespace?:stringPinecone namespace for organizing vectorssparseVector?:{ indices: number\[]; values: number\[]; }Sparse vector for hybrid search
+**databaseConfig.pinecone** (`PineconeConfig`): Configuration specific to Pinecone vector store
 
-**pgvector?:** (`PgVectorConfig`): objectminScore?:numberMinimum similarity score threshold for resultsef?:numberHNSW search parameter - controls accuracy vs speed tradeoffprobes?:numberIVFFlat probe parameter - number of cells to visit during search
+**databaseConfig.pinecone.namespace** (`string`): Pinecone namespace for organizing vectors
 
-**chroma?:** (`ChromaConfig`): objectwhere?:Record\<string, any>Metadata filtering conditionswhereDocument?:Record\<string, any>Document content filtering conditions
+**databaseConfig.pinecone.sparseVector** (`{ indices: number[]; values: number[]; }`): Sparse vector for hybrid search
 
-### RerankConfig
+**databaseConfig.pgvector** (`PgVectorConfig`): Configuration specific to PostgreSQL with pgvector extension
 
-**model:** (`MastraLanguageModel`): Language model to use for reranking
+**databaseConfig.pgvector.minScore** (`number`): Minimum similarity score threshold for results
 
-**options?:** (`RerankerOptions`): objectweights?:WeightConfigWeights for scoring components (semantic: 0.4, vector: 0.4, position: 0.2)topK?:numberNumber of top results to return
+**databaseConfig.pgvector.ef** (`number`): HNSW search parameter - controls accuracy vs speed tradeoff
+
+**databaseConfig.pgvector.probes** (`number`): IVFFlat probe parameter - number of cells to visit during search
+
+**databaseConfig.chroma** (`ChromaConfig`): Configuration specific to Chroma vector store
+
+**databaseConfig.chroma.where** (`Record<string, any>`): Metadata filtering conditions
+
+**databaseConfig.chroma.whereDocument** (`Record<string, any>`): Document content filtering conditions
+
+**providerOptions** (`Record<string, Record<string, any>>`): Provider-specific options for the embedding model (e.g., outputDimensionality). \*\*Important\*\*: Only works with AI SDK EmbeddingModelV2 models. For V1 models, configure options when creating the model itself.
+
+**vectorStore** (`MastraVector | VectorStoreResolver`): Direct vector store instance or a resolver function for dynamic selection. Use a function for multi-tenant applications where the vector store is selected based on request context. When provided, \`vectorStoreName\` becomes optional.
 
 ## Returns
 
 The tool returns an object with:
 
-**relevantContext:** (`string`): Combined text from the most relevant document chunks
+**relevantContext** (`string`): Combined text from the most relevant document chunks
 
-**sources:** (`QueryResult[]`): Array of full retrieval result objects. Each object contains all information needed to reference the original document, chunk, and similarity score.
+**sources** (`QueryResult[]`): Array of full retrieval result objects. Each object contains all information needed to reference the original document, chunk, and similarity score.
 
 ### QueryResult object structure
 

package/dist/docs/references/reference-vectors-libsql.md

@@ -71,13 +71,13 @@ const results = await store.query({
 
 ## Constructor Options
 
-**url:** (`string`): libSQL database URL. Use ':memory:' for in-memory database, 'file:dbname.db' for local file, or a libSQL-compatible connection string like 'libsql://your-database.turso.io'.
+**url** (`string`): libSQL database URL. Use ':memory:' for in-memory database, 'file:dbname.db' for local file, or a libSQL-compatible connection string like 'libsql://your-database.turso.io'.
 
-**authToken?:** (`string`): Authentication token for Turso cloud databases
+**authToken** (`string`): Authentication token for Turso cloud databases
 
-**syncUrl?:** (`string`): URL for database replication (Turso specific)
+**syncUrl** (`string`): URL for database replication (Turso specific)
 
-**syncInterval?:** (`number`): Interval in milliseconds for database sync (Turso specific)
+**syncInterval** (`number`): Interval in milliseconds for database sync (Turso specific)
 
 ## Methods
 
@@ -85,45 +85,45 @@ const results = await store.query({
 
 Creates a new vector collection. The index name must start with a letter or underscore and can only contain letters, numbers, and underscores. The dimension must be a positive integer.
 
-**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. Note: Currently only cosine similarity is supported by libSQL. (Default: `cosine`)
+**metric** (`'cosine' | 'euclidean' | 'dotproduct'`): Distance metric for similarity search. Note: Currently only cosine similarity is supported by libSQL. (Default: `cosine`)
 
 ### upsert()
 
 Adds or updates vectors and their metadata in the index. Uses a transaction to ensure all vectors are inserted atomically - if any insert fails, the entire operation is rolled back.
 
-**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?:** (`Filter`): Metadata filters
+**filter** (`Filter`): 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()
 
 Gets information about an index.
 
-**indexName:** (`string`): Name of the index to describe
+**indexName** (`string`): Name of the index to describe
 
 Returns:
 
@@ -139,7 +139,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()
 
@@ -151,41 +151,41 @@ Returns: `Promise<string[]>`
 
 Removes all vectors from an index while keeping the index structure.
 
-**indexName:** (`string`): Name of the index to truncate
+**indexName** (`string`): Name of the index to truncate
 
 ### 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 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)
 
 ## Response Types
 

package/dist/docs/references/reference-vectors-mongodb.md

@@ -57,15 +57,15 @@ const store = new MongoDBVector({
 
 ## Constructor Options
 
-**id:** (`string`): Unique identifier for this vector store instance
+**id** (`string`): Unique identifier for this vector store instance
 
-**uri:** (`string`): MongoDB connection string
+**uri** (`string`): MongoDB connection string
 
-**dbName:** (`string`): Name of the MongoDB database to use
+**dbName** (`string`): Name of the MongoDB database to use
 
-**options?:** (`MongoClientOptions`): Optional MongoDB client options
+**options** (`MongoClientOptions`): Optional MongoDB client options
 
-**embeddingFieldPath?:** (`string`): Path to the field that stores vector embeddings. Supports nested paths using dot notation (e.g., 'text.contentEmbedding'). (Default: `embedding`)
+**embeddingFieldPath** (`string`): Path to the field that stores vector embeddings. Supports nested paths using dot notation (e.g., 'text.contentEmbedding'). (Default: `embedding`)
 
 ## Methods
 
@@ -73,47 +73,47 @@ const store = new MongoDBVector({
 
 Creates a new vector index (collection) in MongoDB.
 
-**indexName:** (`string`): Name of the collection to create
+**indexName** (`string`): Name of the collection 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 collection.
 
-**indexName:** (`string`): Name of the collection to insert into
+**indexName** (`string`): Name of the collection 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 collection to search in
+**indexName** (`string`): Name of the collection 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 (applies to the \`metadata\` field)
+**filter** (`Record<string, any>`): Metadata filters (applies to the \`metadata\` field)
 
-**documentFilter?:** (`Record<string, any>`): Filters on original document fields (not just metadata)
+**documentFilter** (`Record<string, any>`): Filters on original document fields (not just metadata)
 
-**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 (collection).
 
-**indexName:** (`string`): Name of the collection to describe
+**indexName** (`string`): Name of the collection to describe
 
 Returns:
 
@@ -129,7 +129,7 @@ interface IndexStats {
 
 Deletes a collection and all its data.
 
-**indexName:** (`string`): Name of the collection to delete
+**indexName** (`string`): Name of the collection 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 collection containing the vector
+**indexName** (`string`): Name of the collection 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 collection containing the vector
+**indexName** (`string`): Name of the collection 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 collection containing the vectors to delete
+**indexName** (`string`): Name of the collection 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()