@mastra/mcp-docs-server 0.0.0-commonjs-20250414101718

package/.docs/raw/reference/observability/providers/langwatch.mdx

@@ -0,0 +1,45 @@
+---
+title: "Reference: LangWatch Integration | Mastra Observability Docs"
+description: Documentation for integrating LangWatch with Mastra, a specialized observability platform for LLM applications.
+---
+
+# LangWatch
+
+LangWatch is a specialized observability platform for LLM applications.
+
+## Configuration
+
+To use LangWatch with Mastra, configure these environment variables:
+
+```env
+LANGWATCH_API_KEY=your_api_key
+LANGWATCH_PROJECT_ID=your_project_id
+```
+
+## Implementation
+
+Here's how to configure Mastra to use LangWatch:
+
+```typescript
+import { Mastra } from "@mastra/core";
+import { LangWatchExporter } from "langwatch";
+
+export const mastra = new Mastra({
+  // ... other config
+  telemetry: {
+    serviceName: "your-service-name",
+    enabled: true,
+    export: {
+      type: "custom",
+      exporter: new LangWatchExporter({
+        apiKey: process.env.LANGWATCH_API_KEY,
+        projectId: process.env.LANGWATCH_PROJECT_ID,
+      }),
+    },
+  },
+});
+```
+
+## Dashboard
+
+Access your LangWatch dashboard at [app.langwatch.ai](https://app.langwatch.ai)

package/.docs/raw/reference/observability/providers/new-relic.mdx

@@ -0,0 +1,40 @@
+---
+title: "Reference: New Relic Integration | Mastra Observability Docs"
+description: Documentation for integrating New Relic with Mastra, a comprehensive observability platform supporting OpenTelemetry for full-stack monitoring.
+---
+
+# New Relic
+
+New Relic is a comprehensive observability platform that supports OpenTelemetry (OTLP) for full-stack monitoring.
+
+## Configuration
+
+To use New Relic with Mastra via OTLP, configure these environment variables:
+
+```env
+OTEL_EXPORTER_OTLP_ENDPOINT=https://otlp.nr-data.net:4317
+OTEL_EXPORTER_OTLP_HEADERS="api-key=your_license_key"
+```
+
+## Implementation
+
+Here's how to configure Mastra to use New Relic:
+
+```typescript
+import { Mastra } from "@mastra/core";
+
+export const mastra = new Mastra({
+  // ... other config
+  telemetry: {
+    serviceName: "your-service-name",
+    enabled: true,
+    export: {
+      type: "otlp",
+    },
+  },
+});
+```
+
+## Dashboard
+
+View your telemetry data in the New Relic One dashboard at [one.newrelic.com](https://one.newrelic.com)

package/.docs/raw/reference/observability/providers/signoz.mdx

@@ -0,0 +1,40 @@
+---
+title: "Reference: SigNoz Integration | Mastra Observability Docs"
+description: Documentation for integrating SigNoz with Mastra, an open-source APM and observability platform providing full-stack monitoring through OpenTelemetry.
+---
+
+# SigNoz
+
+SigNoz is an open-source APM and observability platform that provides full-stack monitoring capabilities through OpenTelemetry.
+
+## Configuration
+
+To use SigNoz with Mastra, configure these environment variables:
+
+```env
+OTEL_EXPORTER_OTLP_ENDPOINT=https://ingest.{region}.signoz.cloud:443
+OTEL_EXPORTER_OTLP_HEADERS=signoz-ingestion-key=your_signoz_token
+```
+
+## Implementation
+
+Here's how to configure Mastra to use SigNoz:
+
+```typescript
+import { Mastra } from "@mastra/core";
+
+export const mastra = new Mastra({
+  // ... other config
+  telemetry: {
+    serviceName: "your-service-name",
+    enabled: true,
+    export: {
+      type: "otlp",
+    },
+  },
+});
+```
+
+## Dashboard
+
+Access your SigNoz dashboard at [signoz.io](https://signoz.io/)

package/.docs/raw/reference/observability/providers/traceloop.mdx

@@ -0,0 +1,40 @@
+---
+title: "Reference: Traceloop Integration | Mastra Observability Docs"
+description: Documentation for integrating Traceloop with Mastra, an OpenTelemetry-native observability platform for LLM applications.
+---
+
+# Traceloop
+
+Traceloop is an OpenTelemetry-native observability platform specifically designed for LLM applications.
+
+## Configuration
+
+To use Traceloop with Mastra, configure these environment variables:
+
+```env
+OTEL_EXPORTER_OTLP_ENDPOINT=https://api.traceloop.com
+OTEL_EXPORTER_OTLP_HEADERS="Authorization=Bearer your_api_key, x-traceloop-destination-id=your_destination_id"
+```
+
+## Implementation
+
+Here's how to configure Mastra to use Traceloop:
+
+```typescript
+import { Mastra } from "@mastra/core";
+
+export const mastra = new Mastra({
+  // ... other config
+  telemetry: {
+    serviceName: "your-service-name",
+    enabled: true,
+    export: {
+      type: "otlp",
+    },
+  },
+});
+```
+
+## Dashboard
+
+Access your traces and analytics in the Traceloop dashboard at [app.traceloop.com](https://app.traceloop.com)

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

@@ -0,0 +1,258 @@
+---
+title: "Reference: Astra Vector Store | Vector Databases | RAG | Mastra Docs"
+description: Documentation for the AstraVector class in Mastra, which provides vector search using DataStax Astra DB.
+---
+
+# 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
+
+<PropertiesTable
+  content={[
+    {
+      name: "token",
+      type: "string",
+      description: "Astra DB API token",
+    },
+    {
+      name: "endpoint",
+      type: "string",
+      description: "Astra DB API endpoint",
+    },
+    {
+      name: "keyspace",
+      type: "string",
+      isOptional: true,
+      description: "Optional keyspace name",
+    },
+  ]}
+/>
+
+## Methods
+
+### createIndex()
+
+<PropertiesTable
+  content={[
+    {
+      name: "indexName",
+      type: "string",
+      description: "Name of the index to create",
+    },
+    {
+      name: "dimension",
+      type: "number",
+      description: "Vector dimension (must match your embedding model)",
+    },
+    {
+      name: "metric",
+      type: "'cosine' | 'euclidean' | 'dotproduct'",
+      isOptional: true,
+      defaultValue: "cosine",
+      description:
+        "Distance metric for similarity search (maps to dot_product for dotproduct)",
+    },
+  ]}
+/>
+
+### upsert()
+
+<PropertiesTable
+  content={[
+    {
+      name: "indexName",
+      type: "string",
+      description: "Name of the index to upsert into",
+    },
+    {
+      name: "vectors",
+      type: "number[][]",
+      description: "Array of embedding vectors",
+    },
+    {
+      name: "metadata",
+      type: "Record<string, any>[]",
+      isOptional: true,
+      description: "Metadata for each vector",
+    },
+    {
+      name: "ids",
+      type: "string[]",
+      isOptional: true,
+      description: "Optional vector IDs (auto-generated if not provided)",
+    },
+  ]}
+/>
+
+### query()
+
+<PropertiesTable
+  content={[
+    {
+      name: "indexName",
+      type: "string",
+      description: "Name of the index to query",
+    },
+    {
+      name: "queryVector",
+      type: "number[]",
+      description: "Query vector to find similar vectors",
+    },
+    {
+      name: "topK",
+      type: "number",
+      isOptional: true,
+      defaultValue: "10",
+      description: "Number of results to return",
+    },
+    {
+      name: "filter",
+      type: "Record<string, any>",
+      isOptional: true,
+      description: "Metadata filters for the query",
+    },
+    {
+      name: "includeVector",
+      type: "boolean",
+      isOptional: true,
+      defaultValue: "false",
+      description: "Whether to include vectors in the results",
+    },
+  ]}
+/>
+
+### listIndexes()
+
+Returns an array of index names as strings.
+
+### describeIndex()
+
+<PropertiesTable
+  content={[
+    {
+      name: "indexName",
+      type: "string",
+      description: "Name of the index to describe",
+    },
+  ]}
+/>
+
+Returns:
+
+```typescript copy
+interface IndexStats {
+  dimension: number;
+  count: number;
+  metric: "cosine" | "euclidean" | "dotproduct";
+}
+```
+
+### deleteIndex()
+
+<PropertiesTable
+  content={[
+    {
+      name: "indexName",
+      type: "string",
+      description: "Name of the index to delete",
+    },
+  ]}
+/>
+
+### updateIndexById()
+
+<PropertiesTable
+  content={[
+    {
+      name: "indexName",
+      type: "string",
+      description: "Name of the index containing the vector",
+    },
+    {
+      name: "id",
+      type: "string",
+      description: "ID of the vector to update",
+    },
+    {
+      name: "update",
+      type: "object",
+      description: "Update object containing vector and/or metadata changes",
+      properties: [
+        {
+          name: "vector",
+          type: "number[]",
+          isOptional: true,
+          description: "New vector values",
+        },
+        {
+          name: "metadata",
+          type: "Record<string, any>",
+          isOptional: true,
+          description: "New metadata values",
+        },
+      ],
+    },
+  ]}
+/>
+
+### deleteIndexById()
+
+<PropertiesTable
+  content={[
+    {
+      name: "indexName",
+      type: "string",
+      description: "Name of the index containing the vector",
+    },
+    {
+      name: "id",
+      type: "string",
+      description: "ID of the vector to delete",
+    },
+  ]}
+/>
+
+## Response Types
+
+Query results are returned in this format:
+
+```typescript copy
+interface QueryResult {
+  id: string;
+  score: number;
+  metadata: Record<string, any>;
+  vector?: number[]; // Only included if includeVector is true
+}
+```
+
+## Error Handling
+
+The store throws typed errors that can be caught:
+
+```typescript copy
+try {
+  await store.query({
+    indexName: "index_name",
+    queryVector: queryVector,
+  });
+} catch (error) {
+  if (error instanceof VectorStoreError) {
+    console.log(error.code); // 'connection_failed' | 'invalid_dimension' | etc
+    console.log(error.details); // Additional error context
+  }
+}
+```
+
+## Environment Variables
+
+Required environment variables:
+
+- `ASTRA_DB_TOKEN`: Your Astra DB API token
+- `ASTRA_DB_ENDPOINT`: Your Astra DB API endpoint
+
+## Related
+
+- [Metadata Filters](./metadata-filters)

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

@@ -0,0 +1,281 @@
+---
+title: "Reference: Chroma Vector Store | Vector Databases | RAG | Mastra Docs"
+description: Documentation for the ChromaVector class in Mastra, which provides vector search using ChromaDB.
+---
+
+# Chroma Vector Store
+
+The ChromaVector class provides vector search using [ChromaDB](https://www.trychroma.com/), an open-source embedding database.
+It offers efficient vector search with metadata filtering and hybrid search capabilities.
+
+## Constructor Options
+
+<PropertiesTable
+  content={[
+    {
+      name: "path",
+      type: "string",
+      description: "URL path to ChromaDB instance",
+    },
+    {
+      name: "auth",
+      type: "object",
+      isOptional: true,
+      description: "Authentication configuration",
+    },
+  ]}
+/>
+
+### auth
+
+<PropertiesTable
+  content={[
+    {
+      name: "provider",
+      type: "string",
+      description: "Authentication provider",
+    },
+    {
+      name: "credentials",
+      type: "string",
+      description: "Authentication credentials",
+    },
+  ]}
+/>
+
+## Methods
+
+### createIndex()
+
+<PropertiesTable
+  content={[
+    {
+      name: "indexName",
+      type: "string",
+      description: "Name of the index to create",
+    },
+    {
+      name: "dimension",
+      type: "number",
+      description: "Vector dimension (must match your embedding model)",
+    },
+    {
+      name: "metric",
+      type: "'cosine' | 'euclidean' | 'dotproduct'",
+      isOptional: true,
+      defaultValue: "cosine",
+      description: "Distance metric for similarity search",
+    },
+  ]}
+/>
+
+### upsert()
+
+<PropertiesTable
+  content={[
+    {
+      name: "indexName",
+      type: "string",
+      description: "Name of the index to upsert into",
+    },
+    {
+      name: "vectors",
+      type: "number[][]",
+      description: "Array of embedding vectors",
+    },
+    {
+      name: "metadata",
+      type: "Record<string, any>[]",
+      isOptional: true,
+      description: "Metadata for each vector",
+    },
+    {
+      name: "ids",
+      type: "string[]",
+      isOptional: true,
+      description: "Optional vector IDs (auto-generated if not provided)",
+    },
+    {
+      name: "documents",
+      type: "string[]",
+      isOptional: true,
+      description:
+        "Chroma-specific: Original text documents associated with the vectors",
+    },
+  ]}
+/>
+
+### query()
+
+<PropertiesTable
+  content={[
+    {
+      name: "indexName",
+      type: "string",
+      description: "Name of the index to query",
+    },
+    {
+      name: "queryVector",
+      type: "number[]",
+      description: "Query vector to find similar vectors",
+    },
+    {
+      name: "topK",
+      type: "number",
+      isOptional: true,
+      defaultValue: "10",
+      description: "Number of results to return",
+    },
+    {
+      name: "filter",
+      type: "Record<string, any>",
+      isOptional: true,
+      description: "Metadata filters for the query",
+    },
+    {
+      name: "includeVector",
+      type: "boolean",
+      isOptional: true,
+      defaultValue: "false",
+      description: "Whether to include vectors in the results",
+    },
+    {
+      name: "documentFilter",
+      type: "Record<string, any>",
+      isOptional: true,
+      description: "Chroma-specific: Filter to apply on the document content",
+    },
+  ]}
+/>
+
+### listIndexes()
+
+Returns an array of index names as strings.
+
+### describeIndex()
+
+<PropertiesTable
+  content={[
+    {
+      name: "indexName",
+      type: "string",
+      description: "Name of the index to describe",
+    },
+  ]}
+/>
+
+Returns:
+
+```typescript copy
+interface IndexStats {
+  dimension: number;
+  count: number;
+  metric: "cosine" | "euclidean" | "dotproduct";
+}
+```
+
+### deleteIndex()
+
+<PropertiesTable
+  content={[
+    {
+      name: "indexName",
+      type: "string",
+      description: "Name of the index to delete",
+    },
+  ]}
+/>
+
+### updateIndexById()
+
+<PropertiesTable
+  content={[
+    {
+      name: "indexName",
+      type: "string",
+      description: "Name of the index containing the vector to update",
+    },
+    {
+      name: "id",
+      type: "string",
+      description: "ID of the vector to update",
+    },
+    {
+      name: "update",
+      type: "object",
+      description: "Update parameters",
+    },
+  ]}
+/>
+
+The `update` object can contain:
+
+<PropertiesTable
+  content={[
+    {
+      name: "vector",
+      type: "number[]",
+      isOptional: true,
+      description: "New vector to replace the existing one",
+    },
+    {
+      name: "metadata",
+      type: "Record<string, any>",
+      isOptional: true,
+      description: "New metadata to replace the existing metadata",
+    },
+  ]}
+/>
+
+### deleteIndexById()
+
+<PropertiesTable
+  content={[
+    {
+      name: "indexName",
+      type: "string",
+      description: "Name of the index containing the vector to delete",
+    },
+    {
+      name: "id",
+      type: "string",
+      description: "ID of the vector to delete",
+    },
+  ]}
+/>
+
+## Response Types
+
+Query results are returned in this format:
+
+```typescript copy
+interface QueryResult {
+  id: string;
+  score: number;
+  metadata: Record<string, any>;
+  document?: string; // Chroma-specific: Original document if it was stored
+  vector?: number[]; // Only included if includeVector is true
+}
+```
+
+## Error Handling
+
+The store throws typed errors that can be caught:
+
+```typescript copy
+try {
+  await store.query({
+    indexName: "index_name",
+    queryVector: queryVector,
+  });
+} catch (error) {
+  if (error instanceof VectorStoreError) {
+    console.log(error.code); // 'connection_failed' | 'invalid_dimension' | etc
+    console.log(error.details); // Additional error context
+  }
+}
+```
+
+## Related
+
+- [Metadata Filters](./metadata-filters)