@mastra/mcp-docs-server 1.1.7 → 1.1.8

package/.docs/reference/processors/unicode-normalizer.md

@@ -15,25 +15,23 @@ const processor = new UnicodeNormalizer({
 
 ## Constructor parameters
 
-**options?:** (`Options`): Configuration options for Unicode text normalization
+**options** (`Options`): Configuration options for Unicode text normalization
 
-### Options
+**options.stripControlChars** (`boolean`): Whether to strip control characters. When enabled, removes control characters except , ,
 
-**stripControlChars?:** (`boolean`): Whether to strip control characters. When enabled, removes control characters except , ,
+**options.preserveEmojis** (`boolean`): Whether to preserve emojis. When disabled, emojis may be removed if they contain control characters
 
-**preserveEmojis?:** (`boolean`): Whether to preserve emojis. When disabled, emojis may be removed if they contain control characters
+**options.collapseWhitespace** (`boolean`): Whether to collapse consecutive whitespace. When enabled, multiple spaces/tabs/newlines are collapsed to single instances
 
-**collapseWhitespace?:** (`boolean`): Whether to collapse consecutive whitespace. When enabled, multiple spaces/tabs/newlines are collapsed to single instances
-
-**trim?:** (`boolean`): Whether to trim leading and trailing whitespace
+**options.trim** (`boolean`): Whether to trim leading and trailing whitespace
 
 ## Returns
 
-**id:** (`string`): Processor identifier set to 'unicode-normalizer'
+**id** (`string`): Processor identifier set to 'unicode-normalizer'
 
-**name?:** (`string`): Optional processor display name
+**name** (`string`): Optional processor display name
 
-**processInput:** (`(args: { messages: MastraDBMessage[]; abort: (reason?: string) => never }) => MastraDBMessage[]`): Processes input messages to normalize Unicode text
+**processInput** (`(args: { messages: MastraDBMessage[]; abort: (reason?: string) => never }) => MastraDBMessage[]`): Processes input messages to normalize Unicode text
 
 ## Extended usage example
 

package/.docs/reference/processors/working-memory-processor.md

@@ -23,39 +23,35 @@ const processor = new WorkingMemory({
 
 ## Constructor parameters
 
-**options:** (`Options`): Configuration options for the working memory processor
+**options** (`Options`): Configuration options for the working memory processor
 
-### Options
+**options.storage** (`MemoryStorage`): Storage instance for retrieving working memory data
 
-**storage:** (`MemoryStorage`): Storage instance for retrieving working memory data
+**options.template** (`WorkingMemoryTemplate`): Template defining the format and structure of working memory
 
-**template?:** (`WorkingMemoryTemplate`): Template defining the format and structure of working memory
+**options.template.format** (`'markdown' | 'json'`): Format of the working memory content
 
-**scope?:** (`'thread' | 'resource'`): Scope of working memory. 'thread' scopes to current thread, 'resource' shares across all threads for the resource
+**options.template.content** (`string`): Template content defining the structure of working memory data
 
-**useVNext?:** (`boolean`): Use the next-generation instruction format with improved guidelines
+**options.scope** (`'thread' | 'resource'`): Scope of working memory. 'thread' scopes to current thread, 'resource' shares across all threads for the resource
 
-**readOnly?:** (`boolean`): When true, working memory is provided as read-only context. The data is injected into the conversation but without the updateWorkingMemory tool or update instructions. Useful for agents that should reference working memory without modifying it.
+**options.useVNext** (`boolean`): Use the next-generation instruction format with improved guidelines
 
-**templateProvider?:** (`{ getWorkingMemoryTemplate(args: { memoryConfig?: MemoryConfig }): Promise<WorkingMemoryTemplate | null> }`): Dynamic template provider for runtime template resolution
+**options.readOnly** (`boolean`): When true, working memory is provided as read-only context. The data is injected into the conversation but without the updateWorkingMemory tool or update instructions. Useful for agents that should reference working memory without modifying it.
 
-**logger?:** (`IMastraLogger`): Optional logger instance for structured logging
+**options.templateProvider** (`{ getWorkingMemoryTemplate(args: { memoryConfig?: MemoryConfig }): Promise<WorkingMemoryTemplate | null> }`): Dynamic template provider for runtime template resolution
 
-### WorkingMemoryTemplate
-
-**format:** (`'markdown' | 'json'`): Format of the working memory content
-
-**content:** (`string`): Template content defining the structure of working memory data
+**options.logger** (`IMastraLogger`): Optional logger instance for structured logging
 
 ## Returns
 
-**id:** (`string`): Processor identifier set to 'working-memory'
+**id** (`string`): Processor identifier set to 'working-memory'
 
-**name:** (`string`): Processor display name set to 'WorkingMemory'
+**name** (`string`): Processor display name set to 'WorkingMemory'
 
-**defaultWorkingMemoryTemplate:** (`string`): The default markdown template used when no custom template is provided
+**defaultWorkingMemoryTemplate** (`string`): The default markdown template used when no custom template is provided
 
-**processInput:** (`(args: { messages: MastraDBMessage[]; messageList: MessageList; abort: (reason?: string) => never; requestContext?: RequestContext }) => Promise<MessageList | MastraDBMessage[]>`): Retrieves working memory and adds it as a system message to the message list
+**processInput** (`(args: { messages: MastraDBMessage[]; messageList: MessageList; abort: (reason?: string) => never; requestContext?: RequestContext }) => Promise<MessageList | MastraDBMessage[]>`): Retrieves working memory and adds it as a system message to the message list
 
 ## Extended usage example
 

package/.docs/reference/rag/chunk.md

@@ -39,21 +39,21 @@ const chunksWithMetadata = await doc.chunk({
 
 The following parameters are available for all chunking strategies. **Important:** Each strategy will only utilize a subset of these parameters relevant to its specific use case.
 
-**strategy?:** (`'recursive' | 'character' | 'token' | 'markdown' | 'semantic-markdown' | 'html' | 'json' | 'latex' | 'sentence'`): The chunking strategy to use. If not specified, defaults based on document type. Depending on the chunking strategy, there are additional optionals. Defaults: .md files → 'markdown', .html/.htm → 'html', .json → 'json', .tex → 'latex', others → 'recursive'
+**strategy** (`'recursive' | 'character' | 'token' | 'markdown' | 'semantic-markdown' | 'html' | 'json' | 'latex' | 'sentence'`): The chunking strategy to use. If not specified, defaults based on document type. Depending on the chunking strategy, there are additional optionals. Defaults: .md files → 'markdown', .html/.htm → 'html', .json → 'json', .tex → 'latex', others → 'recursive'
 
-**maxSize?:** (`number`): Maximum size of each chunk. \*\*Note:\*\* Some strategy configurations (markdown with headers, HTML with headers) ignore this parameter. (Default: `4000`)
+**maxSize** (`number`): Maximum size of each chunk. \*\*Note:\*\* Some strategy configurations (markdown with headers, HTML with headers) ignore this parameter. (Default: `4000`)
 
-**overlap?:** (`number`): Number of characters/tokens that overlap between chunks. (Default: `50`)
+**overlap** (`number`): Number of characters/tokens that overlap between chunks. (Default: `50`)
 
-**lengthFunction?:** (`(text: string) => number`): Function to calculate text length. Defaults to character count.
+**lengthFunction** (`(text: string) => number`): Function to calculate text length. Defaults to character count.
 
-**separatorPosition?:** (`'start' | 'end'`): Where to position the separator in chunks. 'start' attaches to beginning of next chunk, 'end' attaches to end of current chunk. If not specified, separators are discarded.
+**separatorPosition** (`'start' | 'end'`): Where to position the separator in chunks. 'start' attaches to beginning of next chunk, 'end' attaches to end of current chunk. If not specified, separators are discarded.
 
-**addStartIndex?:** (`boolean`): Whether to add start index metadata to chunks. (Default: `false`)
+**addStartIndex** (`boolean`): Whether to add start index metadata to chunks. (Default: `false`)
 
-**stripWhitespace?:** (`boolean`): Whether to strip whitespace from chunks. (Default: `true`)
+**stripWhitespace** (`boolean`): Whether to strip whitespace from chunks. (Default: `true`)
 
-**extract?:** (`ExtractParams`): Metadata extraction configuration.
+**extract** (`ExtractParams`): Metadata extraction configuration.
 
 See [ExtractParams reference](https://mastra.ai/reference/rag/extract-params) for details on the `extract` parameter.
 
@@ -126,83 +126,83 @@ The options documented below are passed directly at the top level of the configu
 
 ### Character
 
-**separators?:** (`string[]`): Array of separators to try in order of preference. The strategy will attempt to split on the first separator, then fall back to subsequent ones.
+**separators** (`string[]`): Array of separators to try in order of preference. The strategy will attempt to split on the first separator, then fall back to subsequent ones.
 
-**isSeparatorRegex?:** (`boolean`): Whether the separator is a regex pattern (Default: `false`)
+**isSeparatorRegex** (`boolean`): Whether the separator is a regex pattern (Default: `false`)
 
 ### Recursive
 
-**separators?:** (`string[]`): Array of separators to try in order of preference. The strategy will attempt to split on the first separator, then fall back to subsequent ones.
+**separators** (`string[]`): Array of separators to try in order of preference. The strategy will attempt to split on the first separator, then fall back to subsequent ones.
 
-**isSeparatorRegex?:** (`boolean`): Whether the separators are regex patterns (Default: `false`)
+**isSeparatorRegex** (`boolean`): Whether the separators are regex patterns (Default: `false`)
 
-**language?:** (`Language`): Programming or markup language for language-specific splitting behavior. See Language enum for supported values.
+**language** (`Language`): Programming or markup language for language-specific splitting behavior. See Language enum for supported values.
 
 ### Sentence
 
-**maxSize:** (`number`): Maximum size of each chunk (required for sentence strategy)
+**maxSize** (`number`): Maximum size of each chunk (required for sentence strategy)
 
-**minSize?:** (`number`): Minimum size of each chunk. Chunks smaller than this will be merged with adjacent chunks when possible. (Default: `50`)
+**minSize** (`number`): Minimum size of each chunk. Chunks smaller than this will be merged with adjacent chunks when possible. (Default: `50`)
 
-**targetSize?:** (`number`): Preferred target size for chunks. Defaults to 80% of maxSize. The strategy will try to create chunks close to this size.
+**targetSize** (`number`): Preferred target size for chunks. Defaults to 80% of maxSize. The strategy will try to create chunks close to this size.
 
-**sentenceEnders?:** (`string[]`): Array of characters that mark sentence endings for splitting boundaries. (Default: `['.', '!', '?']`)
+**sentenceEnders** (`string[]`): Array of characters that mark sentence endings for splitting boundaries. (Default: `['.', '!', '?']`)
 
-**fallbackToWords?:** (`boolean`): Whether to fall back to word-level splitting for sentences that exceed maxSize. (Default: `true`)
+**fallbackToWords** (`boolean`): Whether to fall back to word-level splitting for sentences that exceed maxSize. (Default: `true`)
 
-**fallbackToCharacters?:** (`boolean`): Whether to fall back to character-level splitting for words that exceed maxSize. Only applies if fallbackToWords is enabled. (Default: `true`)
+**fallbackToCharacters** (`boolean`): Whether to fall back to character-level splitting for words that exceed maxSize. Only applies if fallbackToWords is enabled. (Default: `true`)
 
 ### HTML
 
-**headers:** (`Array<[string, string]>`): Array of \[selector, metadata key] pairs for header-based splitting
+**headers** (`Array<[string, string]>`): Array of \[selector, metadata key] pairs for header-based splitting
 
-**sections:** (`Array<[string, string]>`): Array of \[selector, metadata key] pairs for section-based splitting
+**sections** (`Array<[string, string]>`): Array of \[selector, metadata key] pairs for section-based splitting
 
-**returnEachLine?:** (`boolean`): Whether to return each line as a separate chunk
+**returnEachLine** (`boolean`): Whether to return each line as a separate chunk
 
 **Important:** When using the HTML strategy, all general options are ignored. Use `headers` for header-based splitting or `sections` for section-based splitting. If used together, `sections` will be ignored.
 
 ### Markdown
 
-**headers?:** (`Array<[string, string]>`): Array of \[header level, metadata key] pairs
+**headers** (`Array<[string, string]>`): Array of \[header level, metadata key] pairs
 
-**stripHeaders?:** (`boolean`): Whether to remove headers from the output
+**stripHeaders** (`boolean`): Whether to remove headers from the output
 
-**returnEachLine?:** (`boolean`): Whether to return each line as a separate chunk
+**returnEachLine** (`boolean`): Whether to return each line as a separate chunk
 
 **Important:** When using the `headers` option, the markdown strategy ignores all general options and content is split based on the markdown header structure. To use size-based chunking with markdown, omit the `headers` parameter.
 
 ### Semantic Markdown
 
-**joinThreshold?:** (`number`): Maximum token count for merging related sections. Sections exceeding this limit individually are left intact, but smaller sections are merged with siblings or parents if the combined size stays under this threshold. (Default: `500`)
+**joinThreshold** (`number`): Maximum token count for merging related sections. Sections exceeding this limit individually are left intact, but smaller sections are merged with siblings or parents if the combined size stays under this threshold. (Default: `500`)
 
-**modelName?:** (`string`): Name of the model for tokenization. If provided, the model's underlying tokenization \`encodingName\` will be used.
+**modelName** (`string`): Name of the model for tokenization. If provided, the model's underlying tokenization \`encodingName\` will be used.
 
-**encodingName?:** (`string`): Name of the token encoding to use. Derived from \`modelName\` if available. (Default: `cl100k_base`)
+**encodingName** (`string`): Name of the token encoding to use. Derived from \`modelName\` if available. (Default: `cl100k_base`)
 
-**allowedSpecial?:** (`Set<string> | 'all'`): Set of special tokens allowed during tokenization, or 'all' to allow all special tokens
+**allowedSpecial** (`Set<string> | 'all'`): Set of special tokens allowed during tokenization, or 'all' to allow all special tokens
 
-**disallowedSpecial?:** (`Set<string> | 'all'`): Set of special tokens to disallow during tokenization, or 'all' to disallow all special tokens (Default: `all`)
+**disallowedSpecial** (`Set<string> | 'all'`): Set of special tokens to disallow during tokenization, or 'all' to disallow all special tokens (Default: `all`)
 
 ### Token
 
-**encodingName?:** (`string`): Name of the token encoding to use
+**encodingName** (`string`): Name of the token encoding to use
 
-**modelName?:** (`string`): Name of the model for tokenization
+**modelName** (`string`): Name of the model for tokenization
 
-**allowedSpecial?:** (`Set<string> | 'all'`): Set of special tokens allowed during tokenization, or 'all' to allow all special tokens
+**allowedSpecial** (`Set<string> | 'all'`): Set of special tokens allowed during tokenization, or 'all' to allow all special tokens
 
-**disallowedSpecial?:** (`Set<string> | 'all'`): Set of special tokens to disallow during tokenization, or 'all' to disallow all special tokens
+**disallowedSpecial** (`Set<string> | 'all'`): Set of special tokens to disallow during tokenization, or 'all' to disallow all special tokens
 
 ### JSON
 
-**maxSize:** (`number`): Maximum size of each chunk
+**maxSize** (`number`): Maximum size of each chunk
 
-**minSize?:** (`number`): Minimum size of each chunk
+**minSize** (`number`): Minimum size of each chunk
 
-**ensureAscii?:** (`boolean`): Whether to ensure ASCII encoding
+**ensureAscii** (`boolean`): Whether to ensure ASCII encoding
 
-**convertLists?:** (`boolean`): Whether to convert lists in the JSON
+**convertLists** (`boolean`): Whether to convert lists in the JSON
 
 ### Latex
 

package/.docs/reference/rag/database-config.md

@@ -19,9 +19,13 @@ export type DatabaseConfig = {
 
 Configuration options specific to Pinecone vector store.
 
-**namespace?:** (`string`): Pinecone namespace for organizing and isolating vectors within the same index. Useful for multi-tenancy or environment separation.
+**namespace** (`string`): Pinecone namespace for organizing and isolating vectors within the same index. Useful for multi-tenancy or environment separation.
 
-**sparseVector?:** (`{ indices: number[]; values: number[]; }`): objectindices:number\[]Array of indices for sparse vector componentsvalues:number\[]Array of values corresponding to the indices
+**sparseVector** (`{ indices: number[]; values: number[]; }`): Sparse vector for hybrid search combining dense and sparse embeddings. Enables better search quality for keyword-based queries. The indices and values arrays must be the same length.
+
+**sparseVector.indices** (`number[]`): Array of indices for sparse vector components
+
+**sparseVector.values** (`number[]`): Array of values corresponding to the indices
 
 **Use Cases:**
 
@@ -33,11 +37,11 @@ Configuration options specific to Pinecone vector store.
 
 Configuration options specific to PostgreSQL with pgvector extension.
 
-**minScore?:** (`number`): Minimum similarity score threshold for results. Only vectors with similarity scores above this value will be returned.
+**minScore** (`number`): Minimum similarity score threshold for results. Only vectors with similarity scores above this value will be returned.
 
-**ef?:** (`number`): HNSW search parameter that controls the size of the dynamic candidate list during search. Higher values improve accuracy at the cost of speed. Typically set between topK and 200.
+**ef** (`number`): HNSW search parameter that controls the size of the dynamic candidate list during search. Higher values improve accuracy at the cost of speed. Typically set between topK and 200.
 
-**probes?:** (`number`): IVFFlat probe parameter that specifies the number of index cells to visit during search. Higher values improve recall at the cost of speed.
+**probes** (`number`): IVFFlat probe parameter that specifies the number of index cells to visit during search. Higher values improve recall at the cost of speed.
 
 **Performance Guidelines:**
 
@@ -55,9 +59,9 @@ Configuration options specific to PostgreSQL with pgvector extension.
 
 Configuration options specific to Chroma vector store.
 
-**where?:** (`Record<string, any>`): Metadata filtering conditions using MongoDB-style query syntax. Filters results based on metadata fields.
+**where** (`Record<string, any>`): Metadata filtering conditions using MongoDB-style query syntax. Filters results based on metadata fields.
 
-**whereDocument?:** (`Record<string, any>`): Document content filtering conditions. Allows filtering based on the actual document text content.
+**whereDocument** (`Record<string, any>`): Document content filtering conditions. Allows filtering based on the actual document text content.
 
 **Filter Syntax Examples:**
 

package/.docs/reference/rag/document.md

@@ -4,9 +4,9 @@ The MDocument class processes documents for RAG applications. The main methods a
 
 ## Constructor
 
-**docs:** (`Array<{ text: string, metadata?: Record<string, any> }>`): Array of document chunks with their text content and optional metadata
+**docs** (`Array<{ text: string, metadata?: Record<string, any> }>`): Array of document chunks with their text content and optional metadata
 
-**type:** (`'text' | 'html' | 'markdown' | 'json' | 'latex'`): Type of document content
+**type** (`'text' | 'html' | 'markdown' | 'json' | 'latex'`): Type of document content
 
 ## Static Methods
 

package/.docs/reference/rag/embeddings.md

@@ -19,19 +19,19 @@ const result = await embed({
 
 ### Parameters
 
-**model:** (`EmbeddingModel`): The embedding model to use (e.g. openai.embedding('text-embedding-3-small'))
+**model** (`EmbeddingModel`): The embedding model to use (e.g. openai.embedding('text-embedding-3-small'))
 
-**value:** (`string | Record<string, any>`): The text content or object to embed
+**value** (`string | Record<string, any>`): The text content or object to embed
 
-**maxRetries?:** (`number`): Maximum number of retries per embedding call. Set to 0 to disable retries. (Default: `2`)
+**maxRetries** (`number`): Maximum number of retries per embedding call. Set to 0 to disable retries. (Default: `2`)
 
-**abortSignal?:** (`AbortSignal`): Optional abort signal to cancel the request
+**abortSignal** (`AbortSignal`): Optional abort signal to cancel the request
 
-**headers?:** (`Record<string, string>`): Additional HTTP headers for the request (only for HTTP-based providers)
+**headers** (`Record<string, string>`): Additional HTTP headers for the request (only for HTTP-based providers)
 
 ### Return Value
 
-**embedding:** (`number[]`): The embedding vector for the input
+**embedding** (`number[]`): The embedding vector for the input
 
 ## Multiple Embeddings
 
@@ -49,19 +49,19 @@ const result = await embedMany({
 
 ### Parameters
 
-**model:** (`EmbeddingModel`): The embedding model to use (e.g. openai.embedding('text-embedding-3-small'))
+**model** (`EmbeddingModel`): The embedding model to use (e.g. openai.embedding('text-embedding-3-small'))
 
-**values:** (`string[] | Record<string, any>[]`): Array of text content or objects to embed
+**values** (`string[] | Record<string, any>[]`): Array of text content or objects to embed
 
-**maxRetries?:** (`number`): Maximum number of retries per embedding call. Set to 0 to disable retries. (Default: `2`)
+**maxRetries** (`number`): Maximum number of retries per embedding call. Set to 0 to disable retries. (Default: `2`)
 
-**abortSignal?:** (`AbortSignal`): Optional abort signal to cancel the request
+**abortSignal** (`AbortSignal`): Optional abort signal to cancel the request
 
-**headers?:** (`Record<string, string>`): Additional HTTP headers for the request (only for HTTP-based providers)
+**headers** (`Record<string, string>`): Additional HTTP headers for the request (only for HTTP-based providers)
 
 ### Return Value
 
-**embeddings:** (`number[][]`): Array of embedding vectors corresponding to the input values
+**embeddings** (`number[][]`): Array of embedding vectors corresponding to the input values
 
 ## Example Usage
 

package/.docs/reference/rag/extract-params.md

@@ -28,63 +28,63 @@ const chunks = await doc.chunk({
 
 The `extract` parameter accepts the following fields:
 
-**title?:** (`boolean | TitleExtractorsArgs`): Enable title extraction. Set to true for default settings, or provide custom configuration.
+**title** (`boolean | TitleExtractorsArgs`): Enable title extraction. Set to true for default settings, or provide custom configuration.
 
-**summary?:** (`boolean | SummaryExtractArgs`): Enable summary extraction. Set to true for default settings, or provide custom configuration.
+**summary** (`boolean | SummaryExtractArgs`): Enable summary extraction. Set to true for default settings, or provide custom configuration.
 
-**questions?:** (`boolean | QuestionAnswerExtractArgs`): Enable question generation. Set to true for default settings, or provide custom configuration.
+**questions** (`boolean | QuestionAnswerExtractArgs`): Enable question generation. Set to true for default settings, or provide custom configuration.
 
-**keywords?:** (`boolean | KeywordExtractArgs`): Enable keyword extraction. Set to true for default settings, or provide custom configuration.
+**keywords** (`boolean | KeywordExtractArgs`): Enable keyword extraction. Set to true for default settings, or provide custom configuration.
 
-**schema?:** (`SchemaExtractArgs`): Enable structured metadata extraction using a Zod schema.
+**schema** (`SchemaExtractArgs`): Enable structured metadata extraction using a Zod schema.
 
 ## Extractor Arguments
 
 ### TitleExtractorsArgs
 
-**llm?:** (`MastraLanguageModel`): AI SDK language model to use for title extraction
+**llm** (`MastraLanguageModel`): AI SDK language model to use for title extraction
 
-**nodes?:** (`number`): Number of title nodes to extract
+**nodes** (`number`): Number of title nodes to extract
 
-**nodeTemplate?:** (`string`): Custom prompt template for title node extraction. Must include {context} placeholder
+**nodeTemplate** (`string`): Custom prompt template for title node extraction. Must include {context} placeholder
 
-**combineTemplate?:** (`string`): Custom prompt template for combining titles. Must include {context} placeholder
+**combineTemplate** (`string`): Custom prompt template for combining titles. Must include {context} placeholder
 
 ### SummaryExtractArgs
 
-**llm?:** (`MastraLanguageModel`): AI SDK language model to use for summary extraction
+**llm** (`MastraLanguageModel`): AI SDK language model to use for summary extraction
 
-**summaries?:** (`('self' | 'prev' | 'next')[]`): List of summary types to generate. Can only include 'self' (current chunk), 'prev' (previous chunk), or 'next' (next chunk)
+**summaries** (`('self' | 'prev' | 'next')[]`): List of summary types to generate. Can only include 'self' (current chunk), 'prev' (previous chunk), or 'next' (next chunk)
 
-**promptTemplate?:** (`string`): Custom prompt template for summary generation. Must include {context} placeholder
+**promptTemplate** (`string`): Custom prompt template for summary generation. Must include {context} placeholder
 
 ### QuestionAnswerExtractArgs
 
-**llm?:** (`MastraLanguageModel`): AI SDK language model to use for question generation
+**llm** (`MastraLanguageModel`): AI SDK language model to use for question generation
 
-**questions?:** (`number`): Number of questions to generate
+**questions** (`number`): Number of questions to generate
 
-**promptTemplate?:** (`string`): Custom prompt template for question generation. Must include both {context} and {numQuestions} placeholders
+**promptTemplate** (`string`): Custom prompt template for question generation. Must include both {context} and {numQuestions} placeholders
 
-**embeddingOnly?:** (`boolean`): If true, only generate embeddings without actual questions
+**embeddingOnly** (`boolean`): If true, only generate embeddings without actual questions
 
 ### KeywordExtractArgs
 
-**llm?:** (`MastraLanguageModel`): AI SDK language model to use for keyword extraction
+**llm** (`MastraLanguageModel`): AI SDK language model to use for keyword extraction
 
-**keywords?:** (`number`): Number of keywords to extract
+**keywords** (`number`): Number of keywords to extract
 
-**promptTemplate?:** (`string`): Custom prompt template for keyword extraction. Must include both {context} and {maxKeywords} placeholders
+**promptTemplate** (`string`): Custom prompt template for keyword extraction. Must include both {context} and {maxKeywords} placeholders
 
 ### SchemaExtractArgs
 
-**schema:** (`ZodType`): Zod schema defining the structure of the data to extract.
+**schema** (`ZodType`): Zod schema defining the structure of the data to extract.
 
-**llm?:** (`MastraLanguageModel`): AI SDK language model to use for extraction.
+**llm** (`MastraLanguageModel`): AI SDK language model to use for extraction.
 
-**instructions?:** (`string`): Instructions for the LLM on what to extract.
+**instructions** (`string`): Instructions for the LLM on what to extract.
 
-**metadataKey?:** (`string`): Key to nest extraction results under. If omitted, results are spread into the metadata object.
+**metadataKey** (`string`): Key to nest extraction results under. If omitted, results are spread into the metadata object.
 
 ## Advanced Example
 

package/.docs/reference/rag/graph-rag.md

@@ -26,9 +26,9 @@ const results = await graphRag.query({
 
 ## Constructor Parameters
 
-**dimension?:** (`number`): Dimension of the embedding vectors (Default: `1536`)
+**dimension** (`number`): Dimension of the embedding vectors (Default: `1536`)
 
-**threshold?:** (`number`): Similarity threshold for creating edges between nodes (0-1) (Default: `0.7`)
+**threshold** (`number`): Similarity threshold for creating edges between nodes (0-1) (Default: `0.7`)
 
 ## Methods
 
@@ -42,9 +42,9 @@ createGraph(chunks: GraphChunk[], embeddings: GraphEmbedding[]): void
 
 #### Parameters
 
-**chunks:** (`GraphChunk[]`): Array of document chunks with text and metadata
+**chunks** (`GraphChunk[]`): Array of document chunks with text and metadata
 
-**embeddings:** (`GraphEmbedding[]`): Array of embeddings corresponding to chunks
+**embeddings** (`GraphEmbedding[]`): Array of embeddings corresponding to chunks
 
 ### query
 
@@ -66,25 +66,25 @@ query({
 
 #### Parameters
 
-**query:** (`number[]`): Query embedding vector
+**query** (`number[]`): Query embedding vector
 
-**topK?:** (`number`): Number of results to return (Default: `10`)
+**topK** (`number`): Number of results to return (Default: `10`)
 
-**randomWalkSteps?:** (`number`): Number of steps in random walk (Default: `100`)
+**randomWalkSteps** (`number`): Number of steps in random walk (Default: `100`)
 
-**restartProb?:** (`number`): Probability of restarting walk from query node (Default: `0.15`)
+**restartProb** (`number`): Probability of restarting walk from query node (Default: `0.15`)
 
 #### Returns
 
 Returns an array of `RankedNode` objects, where each node contains:
 
-**id:** (`string`): Unique identifier for the node
+**id** (`string`): Unique identifier for the node
 
-**content:** (`string`): Text content of the document chunk
+**content** (`string`): Text content of the document chunk
 
-**metadata:** (`Record<string, any>`): Additional metadata associated with the chunk
+**metadata** (`Record<string, any>`): Additional metadata associated with the chunk
 
-**score:** (`number`): Combined relevance score from graph traversal
+**score** (`number`): Combined relevance score from graph traversal
 
 ## Advanced Example
 

package/.docs/reference/rag/rerank.md

@@ -30,45 +30,53 @@ const rerankedResults = await rerank(vectorSearchResults, 'How do I deploy to pr
 
 ## Parameters
 
-**results:** (`QueryResult[]`): The vector search results to rerank
+**results** (`QueryResult[]`): The vector search results to rerank
 
-**query:** (`string`): The search query text used to evaluate relevance
+**query** (`string`): The search query text used to evaluate relevance
 
-**model:** (`MastraLanguageModel`): The language Model to use for reranking
+**model** (`MastraLanguageModel`): The language Model to use for reranking
 
-**options?:** (`RerankerFunctionOptions`): Options for the reranking model
+**options** (`RerankerFunctionOptions`): Options for the reranking model
 
-The rerank function accepts any LanguageModel from the Vercel AI SDK. When using the Cohere model `rerank-v3.5`, it will automatically use Cohere's reranking capabilities.
+**options.weights** (`WeightConfig`): Weights for different scoring components (must add up to 1)
 
-> **Note:** For semantic scoring to work properly during re-ranking, each result must include the text content in its `metadata.text` field.
+**options.weights.semantic** (`number (default: 0.4)`): Weight for semantic relevance
+
+**options.weights.vector** (`number (default: 0.4)`): Weight for vector similarity
+
+**options.weights.position** (`number (default: 0.2)`): Weight for position-based scoring
 
-### RerankerFunctionOptions
+**options.queryEmbedding** (`number[]`): Embedding of the query
 
-**weights?:** (`WeightConfig`): numbersemantic?:number (default: 0.4)Weight for semantic relevancenumbervector?:number (default: 0.4)Weight for vector similaritynumberposition?:number (default: 0.2)Weight for position-based scoring
+**options.topK** (`number`): Number of top results to return
 
-**queryEmbedding?:** (`number[]`): Embedding of the query
+The rerank function accepts any LanguageModel from the Vercel AI SDK. When using the Cohere model `rerank-v3.5`, it will automatically use Cohere's reranking capabilities.
 
-**topK?:** (`number`): Number of top results to return (Default: `3`)
+> **Note:** For semantic scoring to work properly during re-ranking, each result must include the text content in its `metadata.text` field.
 
 ## Returns
 
 The function returns an array of `RerankResult` objects:
 
-**result:** (`QueryResult`): The original query result
+**result** (`QueryResult`): The original query result
 
-**score:** (`number`): Combined reranking score (0-1)
+**score** (`number`): Combined reranking score (0-1)
 
-**details:** (`ScoringDetails`): Detailed scoring information
+**details** (`ScoringDetails`): Detailed scoring information
 
 ### ScoringDetails
 
-**semantic:** (`number`): Semantic relevance score (0-1)
+**semantic** (`number`): Semantic relevance score (0-1)
+
+**vector** (`number`): Vector similarity score (0-1)
+
+**position** (`number`): Position-based score (0-1)
 
-**vector:** (`number`): Vector similarity score (0-1)
+**queryAnalysis** (`object`): Query analysis details
 
-**position:** (`number`): Position-based score (0-1)
+**queryAnalysis.magnitude**: Magnitude of the query
 
-**queryAnalysis?:** (`object`): numbermagnitude:Magnitude of the querynumber\[]dominantFeatures:Dominant features of the query
+**queryAnalysis.dominantFeatures**: Dominant features of the query
 
 ## Related