@mastra/mcp-docs-server 0.13.37 → 0.13.39-alpha.0

package/.docs/raw/reference/rag/database-config.mdx

@@ -3,8 +3,8 @@ title: "Reference: DatabaseConfig | RAG | Mastra Docs"
 description: API reference for database-specific configuration types used with vector query tools in Mastra RAG systems.
 ---
 
-import { Callout } from "nextra/components";
-import { Tabs } from "nextra/components";
+import Tabs from "@theme/Tabs";
+import TabItem from "@theme/TabItem";
 
 # DatabaseConfig
 
@@ -32,13 +32,15 @@ Configuration options specific to Pinecone vector store.
     {
       name: "namespace",
       type: "string",
-      description: "Pinecone namespace for organizing and isolating vectors within the same index. Useful for multi-tenancy or environment separation.",
+      description:
+        "Pinecone namespace for organizing and isolating vectors within the same index. Useful for multi-tenancy or environment separation.",
       isOptional: true,
     },
     {
       name: "sparseVector",
       type: "{ indices: number[]; values: number[]; }",
-      description: "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.",
+      description:
+        "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.",
       isOptional: true,
       properties: [
         {
@@ -64,6 +66,7 @@ Configuration options specific to Pinecone vector store.
 />
 
 **Use Cases:**
+
 - Multi-tenant applications (separate namespaces per tenant)
 - Environment isolation (dev/staging/prod namespaces)
 - Hybrid search combining semantic and keyword matching
@@ -77,30 +80,35 @@ Configuration options specific to PostgreSQL with pgvector extension.
     {
       name: "minScore",
       type: "number",
-      description: "Minimum similarity score threshold for results. Only vectors with similarity scores above this value will be returned.",
+      description:
+        "Minimum similarity score threshold for results. Only vectors with similarity scores above this value will be returned.",
       isOptional: true,
     },
     {
       name: "ef",
       type: "number",
-      description: "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.",
+      description:
+        "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.",
       isOptional: true,
     },
     {
       name: "probes",
       type: "number",
-      description: "IVFFlat probe parameter that specifies the number of index cells to visit during search. Higher values improve recall at the cost of speed.",
+      description:
+        "IVFFlat probe parameter that specifies the number of index cells to visit during search. Higher values improve recall at the cost of speed.",
       isOptional: true,
     },
   ]}
 />
 
 **Performance Guidelines:**
+
 - **ef**: Start with 2-4x your topK value, increase for better accuracy
 - **probes**: Start with 1-10, increase for better recall
 - **minScore**: Use values between 0.5-0.9 depending on your quality requirements
 
 **Use Cases:**
+
 - Performance optimization for high-load scenarios
 - Quality filtering to remove irrelevant results
 - Fine-tuning search accuracy vs speed tradeoffs
@@ -114,19 +122,22 @@ Configuration options specific to Chroma vector store.
     {
       name: "where",
       type: "Record<string, any>",
-      description: "Metadata filtering conditions using MongoDB-style query syntax. Filters results based on metadata fields.",
+      description:
+        "Metadata filtering conditions using MongoDB-style query syntax. Filters results based on metadata fields.",
       isOptional: true,
     },
     {
       name: "whereDocument",
       type: "Record<string, any>",
-      description: "Document content filtering conditions. Allows filtering based on the actual document text content.",
+      description:
+        "Document content filtering conditions. Allows filtering based on the actual document text content.",
       isOptional: true,
     },
   ]}
 />
 
 **Filter Syntax Examples:**
+
 ```typescript
 // Simple equality
 where: { "category": "technical" }
@@ -135,9 +146,9 @@ where: { "category": "technical" }
 where: { "price": { "$gt": 100 } }
 
 // Multiple conditions
-where: { 
+where: {
   "category": "electronics",
-  "inStock": true 
+  "inStock": true
 }
 
 // Document content filtering
@@ -145,19 +156,20 @@ whereDocument: { "$contains": "API documentation" }
 ```
 
 **Use Cases:**
+
 - Advanced metadata filtering
 - Content-based document filtering
 - Complex query combinations
 
 ## Usage Examples
 
-<Tabs items={['Basic Usage', 'Runtime Override', 'Multi-Database', 'Performance Tuning']}>
-  <Tabs.Tab>
+<Tabs>
+  <TabItem value="basic-usage" label="Basic Usage">
     ### Basic Database Configuration
 
     ```typescript
     import { createVectorQueryTool } from '@mastra/rag';
-    
+
     const vectorTool = createVectorQueryTool({
       vectorStoreName: 'pinecone',
       indexName: 'documents',
@@ -169,18 +181,19 @@ whereDocument: { "$contains": "API documentation" }
       }
     });
     ```
-  </Tabs.Tab>
 
-  <Tabs.Tab>
+  </TabItem>
+
+  <TabItem value="runtime-override" label="Runtime Override">
     ### Runtime Configuration Override
 
     ```typescript
     import { RuntimeContext } from '@mastra/core/runtime-context';
-    
+
     // Initial configuration
     const vectorTool = createVectorQueryTool({
       vectorStoreName: 'pinecone',
-      indexName: 'documents', 
+      indexName: 'documents',
       model: embedModel,
       databaseConfig: {
         pinecone: {
@@ -188,7 +201,7 @@ whereDocument: { "$contains": "API documentation" }
         }
       }
     });
-    
+
     // Override at runtime
     const runtimeContext = new RuntimeContext();
     runtimeContext.set('databaseConfig', {
@@ -196,16 +209,17 @@ whereDocument: { "$contains": "API documentation" }
         namespace: 'production'
       }
     });
-    
+
     await vectorTool.execute({
       context: { queryText: 'search query' },
       mastra,
       runtimeContext
     });
     ```
-  </Tabs.Tab>
 
-  <Tabs.Tab>
+  </TabItem>
+
+  <TabItem value="multi-database" label="Multi-Database">
     ### Multi-Database Configuration
 
     ```typescript
@@ -228,12 +242,15 @@ whereDocument: { "$contains": "API documentation" }
     });
     ```
 
-    <Callout>
-      **Multi-Database Support**: When you configure multiple databases, only the configuration matching the actual vector store being used will be applied.
-    </Callout>
-  </Tabs.Tab>
+    :::note
+
+**Multi-Database Support**: When you configure multiple databases, only the configuration matching the actual vector store being used will be applied.
+
+:::
+
+  </TabItem>
 
-  <Tabs.Tab>
+  <TabItem value="performance-tuning" label="Performance Tuning">
     ### Performance Tuning
 
     ```typescript
@@ -250,8 +267,8 @@ whereDocument: { "$contains": "API documentation" }
         }
       }
     });
-    
-    // High speed configuration  
+
+    // High speed configuration
     const highSpeedTool = createVectorQueryTool({
       vectorStoreName: 'postgres',
       indexName: 'embeddings',
@@ -265,7 +282,8 @@ whereDocument: { "$contains": "API documentation" }
       }
     });
     ```
-  </Tabs.Tab>
+
+  </TabItem>
 </Tabs>
 
 ## Extensibility
@@ -290,15 +308,15 @@ export type DatabaseConfig = {
 
 // 3. Use in vector query tool
 const vectorTool = createVectorQueryTool({
-  vectorStoreName: 'newdatabase',
-  indexName: 'documents',
+  vectorStoreName: "newdatabase",
+  indexName: "documents",
   model: embedModel,
   databaseConfig: {
     newdatabase: {
-      customParam1: 'value',
-      customParam2: 42
-    }
-  }
+      customParam1: "value",
+      customParam2: 42,
+    },
+  },
 });
 ```
 
@@ -330,5 +348,5 @@ const vectorTool = createVectorQueryTool({
 ## Related
 
 - [createVectorQueryTool()](/reference/tools/vector-query-tool)
-- [Hybrid Vector Search](/examples/rag/query/hybrid-vector-search.mdx)
-- [Metadata Filters](/reference/rag/metadata-filters) 
+- [Hybrid Vector Search](/examples/rag/query/hybrid-vector-search)
+- [Metadata Filters](/reference/rag/metadata-filters)

package/.docs/raw/reference/rag/embeddings.mdx

@@ -1,5 +1,5 @@
 ---
-title: "Reference: embed() | Document Embedding | RAG | Mastra Docs"
+title: "Reference: Embed | RAG | Mastra Docs"
 description: Documentation for embedding functionality in Mastra using the AI SDK.
 ---
 

package/.docs/raw/reference/rag/extract-params.mdx

@@ -1,5 +1,5 @@
 ---
-title: "Reference: ExtractParams | Document Processing | RAG | Mastra Docs"
+title: "Reference: ExtractParams | RAG | Mastra Docs"
 description: Documentation for metadata extraction configuration in Mastra.
 ---
 

package/.docs/raw/reference/rag/graph-rag.mdx

@@ -1,5 +1,5 @@
 ---
-title: "Reference: GraphRAG | Graph-based RAG | RAG | Mastra Docs"
+title: "Reference: GraphRAG | RAG | Mastra Docs"
 description: Documentation for the GraphRAG class in Mastra, which implements a graph-based approach to retrieval augmented generation.
 ---
 

package/.docs/raw/reference/rag/metadata-filters.mdx

@@ -1,5 +1,5 @@
 ---
-title: "Reference: Metadata Filters | Metadata Filtering | RAG | Mastra Docs"
+title: "Reference: Metadata Filters | RAG | Mastra Docs"
 description: Documentation for metadata filtering capabilities in Mastra, which allow for precise querying of vector search results across different vector stores.
 ---
 
@@ -200,19 +200,16 @@ const results = await store.query({
 ## Common Rules and Restrictions
 
 1. Field names cannot:
-
    - Contain dots (.) unless referring to nested fields
    - Start with $ or contain null characters
    - Be empty strings
 
 2. Values must be:
-
    - Valid JSON types (string, number, boolean, object, array)
    - Not undefined
    - Properly typed for the operator (e.g., numbers for numeric comparisons)
 
 3. Logical operators:
-
    - Must contain valid conditions
    - Cannot be empty
    - Must be properly nested
@@ -225,7 +222,6 @@ const results = await store.query({
    - Invalid: `{ "field": { "$gt": { "$and": [{...}] } } }`
 
 4. $not operator:
-
    - Must be an object
    - Cannot be empty
    - Can be used at field level or top level
@@ -317,31 +313,32 @@ const results = await store.query({
 - Indexing metadata fields is recommended for optimal performance
 
 ### Couchbase
+
 - Currently does not have support for metadata filters. Filtering must be done client-side after retrieving results or by using the Couchbase SDK's Search capabilities directly for more complex queries.
 
 ### Amazon S3 Vectors
 
-* Equality values must be primitives (string/number/boolean). `null`/`undefined`, arrays, objects, and Date are not allowed for equality. Range operators accept numbers or Date (Dates are normalized to epoch ms).
-* `$in`/`$nin` require **non-empty arrays of primitives**; Date elements are allowed and normalized to epoch ms. **Array equality** is not supported.
-* Implicit AND is canonicalized (`{a:1,b:2}` → `{$and:[{a:1},{b:2}]}`). Logical operators must contain field conditions, use non-empty arrays, and appear only at the root or within other logical operators (not inside field values).
-* Keys listed in `nonFilterableMetadataKeys` at index creation are stored but not filterable; this setting is immutable.
-* $exists requires a boolean value.
-* undefined/null/empty filters are treated as no filter.
-* Each metadata key name limited to 63 characters.
-* Total metadata per vector: Up to 40 KB (filterable + non-filterable)
-* Total metadata keys per vector: Up to 10
-* Filterable metadata per vector: Up to 2 KB
-* Non-filterable metadata keys per vector index: Up to 10
+- Equality values must be primitives (string/number/boolean). `null`/`undefined`, arrays, objects, and Date are not allowed for equality. Range operators accept numbers or Date (Dates are normalized to epoch ms).
+- `$in`/`$nin` require **non-empty arrays of primitives**; Date elements are allowed and normalized to epoch ms. **Array equality** is not supported.
+- Implicit AND is canonicalized (`{a:1,b:2}` → `{$and:[{a:1},{b:2}]}`). Logical operators must contain field conditions, use non-empty arrays, and appear only at the root or within other logical operators (not inside field values).
+- Keys listed in `nonFilterableMetadataKeys` at index creation are stored but not filterable; this setting is immutable.
+- $exists requires a boolean value.
+- undefined/null/empty filters are treated as no filter.
+- Each metadata key name limited to 63 characters.
+- Total metadata per vector: Up to 40 KB (filterable + non-filterable)
+- Total metadata keys per vector: Up to 10
+- Filterable metadata per vector: Up to 2 KB
+- Non-filterable metadata keys per vector index: Up to 10
 
 ## Related
 
-- [Astra](./astra)
-- [Chroma](./chroma)
-- [Cloudflare Vectorize](./vectorize)
-- [LibSQL](./libsql)
-- [MongoDB](./mongodb)
-- [PgStore](./pg)
-- [Pinecone](./pinecone)
-- [Qdrant](./qdrant)
-- [Upstash](./upstash)
-- [Amazon S3 Vectors](./s3vectors)
+- [Astra](/reference/vectors/astra)
+- [Chroma](/reference/vectors/chroma)
+- [Cloudflare Vectorize](/reference/vectors/vectorize)
+- [LibSQL](/reference/vectors/libsql)
+- [MongoDB](/reference/vectors/mongodb)
+- [PgStore](/reference/vectors/pg)
+- [Pinecone](/reference/vectors/pinecone)
+- [Qdrant](/reference/vectors/qdrant)
+- [Upstash](/reference/vectors/upstash)
+- [Amazon S3 Vectors](/reference/vectors/s3vectors)

package/.docs/raw/reference/rag/rerank.mdx

@@ -1,5 +1,5 @@
 ---
-title: "Reference: Rerank | Document Retrieval | RAG | Mastra Docs"
+title: "Reference: rerank() | RAG | Mastra Docs"
 description: Documentation for the rerank function in Mastra, which provides advanced reranking capabilities for vector search results.
 ---
 

package/.docs/raw/reference/rag/rerankWithScorer.mdx

@@ -1,5 +1,5 @@
 ---
-title: "Reference: Rerank | Document Retrieval | RAG | Mastra Docs"
+title: "Reference: rerankWithScorer() | RAG | Mastra Docs"
 description: Documentation for the rerank function in Mastra, which provides advanced reranking capabilities for vector search results.
 ---
 
@@ -22,7 +22,7 @@ function rerankWithScorer({
 import { openai } from "@ai-sdk/openai";
 import { rerankWithScorer as rerank, CohereRelevanceScorer } from "@mastra/rag";
 
-const scorer = new CohereRelevanceScorer('rerank-v3.5');
+const scorer = new CohereRelevanceScorer("rerank-v3.5");
 
 const rerankedResults = await rerank({
   results: vectorSearchResults,

package/.docs/raw/reference/scorers/answer-relevancy.mdx

@@ -1,5 +1,5 @@
 ---
-title: "Reference: Answer Relevancy | Scorers | Mastra Docs"
+title: "Reference: Answer Relevancy Scorer | Scorers | Mastra Docs"
 description: Documentation for the Answer Relevancy Scorer in Mastra, which evaluates how well LLM outputs address the input query.
 ---
 
@@ -53,7 +53,8 @@ This function returns an instance of the MastraScorer class. The `.run()` method
     {
       name: "preprocessPrompt",
       type: "string",
-      description: "The prompt sent to the LLM for the preprocess step (optional).",
+      description:
+        "The prompt sent to the LLM for the preprocess step (optional).",
     },
     {
       name: "preprocessStepResult",
@@ -63,12 +64,14 @@ This function returns an instance of the MastraScorer class. The `.run()` method
     {
       name: "analyzePrompt",
       type: "string",
-      description: "The prompt sent to the LLM for the analyze step (optional).",
+      description:
+        "The prompt sent to the LLM for the analyze step (optional).",
     },
     {
       name: "analyzeStepResult",
       type: "object",
-      description: "Object with results: { results: Array<{ result: 'yes' | 'unsure' | 'no', reason: string }> }",
+      description:
+        "Object with results: { results: Array<{ result: 'yes' | 'unsure' | 'no', reason: string }> }",
     },
     {
       name: "generateReasonPrompt",
@@ -115,13 +118,20 @@ A relevancy score between 0 and 1:
 
 In this example, the response accurately addresses the input query with specific and relevant information.
 
-```typescript filename="src/example-high-answer-relevancy.ts" showLineNumbers copy
+```typescript title="src/example-high-answer-relevancy.ts" showLineNumbers copy
 import { createAnswerRelevancyScorer } from "@mastra/evals/scorers/llm";
 
-const scorer = createAnswerRelevancyScorer({ model: 'openai/gpt-4o-mini' });
+const scorer = createAnswerRelevancyScorer({ model: "openai/gpt-4o-mini" });
 
-const inputMessages = [{ role: 'user', content: "What are the health benefits of regular exercise?" }];
-const outputMessage = { text: "Regular exercise improves cardiovascular health, strengthens muscles, boosts metabolism, and enhances mental well-being through the release of endorphins." };
+const inputMessages = [
+  {
+    role: "user",
+    content: "What are the health benefits of regular exercise?",
+  },
+];
+const outputMessage = {
+  text: "Regular exercise improves cardiovascular health, strengthens muscles, boosts metabolism, and enhances mental well-being through the release of endorphins.",
+};
 
 const result = await scorer.run({
   input: inputMessages,
@@ -146,13 +156,17 @@ The output receives a high score because it accurately answers the query without
 
 In this example, the response addresses the query in part but includes additional information that isn’t directly relevant.
 
-```typescript filename="src/example-partial-answer-relevancy.ts" showLineNumbers copy
+```typescript title="src/example-partial-answer-relevancy.ts" showLineNumbers copy
 import { createAnswerRelevancyScorer } from "@mastra/evals/scorers/llm";
 
-const scorer = createAnswerRelevancyScorer({ model: 'openai/gpt-4o-mini' });
+const scorer = createAnswerRelevancyScorer({ model: "openai/gpt-4o-mini" });
 
-const inputMessages = [{ role: 'user', content: "What should a healthy breakfast include?" }];
-const outputMessage = { text: "A nutritious breakfast should include whole grains and protein. However, the timing of your breakfast is just as important - studies show eating within 2 hours of waking optimizes metabolism and energy levels throughout the day." };
+const inputMessages = [
+  { role: "user", content: "What should a healthy breakfast include?" },
+];
+const outputMessage = {
+  text: "A nutritious breakfast should include whole grains and protein. However, the timing of your breakfast is just as important - studies show eating within 2 hours of waking optimizes metabolism and energy levels throughout the day.",
+};
 
 const result = await scorer.run({
   input: inputMessages,
@@ -177,13 +191,17 @@ The output receives a lower score because it partially answers the query. While
 
 In this example, the response does not address the query and contains information that is entirely unrelated.
 
-```typescript filename="src/example-low-answer-relevancy.ts" showLineNumbers copy
+```typescript title="src/example-low-answer-relevancy.ts" showLineNumbers copy
 import { createAnswerRelevancyScorer } from "@mastra/evals/scorers/llm";
 
-const scorer = createAnswerRelevancyScorer({ model: 'openai/gpt-4o-mini' });
+const scorer = createAnswerRelevancyScorer({ model: "openai/gpt-4o-mini" });
 
-const inputMessages = [{ role: 'user', content: "What are the benefits of meditation?" }];
-const outputMessage = { text: "The Great Wall of China is over 13,000 miles long and was built during the Ming Dynasty to protect against invasions." };
+const inputMessages = [
+  { role: "user", content: "What are the benefits of meditation?" },
+];
+const outputMessage = {
+  text: "The Great Wall of China is over 13,000 miles long and was built during the Ming Dynasty to protect against invasions.",
+};
 
 const result = await scorer.run({
   input: inputMessages,
@@ -206,4 +224,4 @@ The output receives a score of 0 because it fails to answer the query or provide
 
 ## Related
 
-- [Faithfulness Scorer](./faithfulness)
+- [Faithfulness Scorer](./faithfulness)