@mastra/mcp-docs-server 1.0.0-beta.9 → 1.0.1

package/.docs/raw/reference/observability/tracing/exporters/datadog.mdx

@@ -0,0 +1,172 @@
+---
+title: "Reference: DatadogExporter | Observability"
+description: Datadog LLM Observability exporter for Tracing
+packages:
+  - "@mastra/core"
+  - "@mastra/observability"
+---
+
+import PropertiesTable from "@site/src/components/PropertiesTable";
+
+# DatadogExporter
+
+Sends Tracing data to Datadog's LLM Observability product for monitoring and analytics.
+
+## Constructor
+
+```typescript
+new DatadogExporter(config: DatadogExporterConfig)
+```
+
+## DatadogExporterConfig
+
+```typescript
+interface DatadogExporterConfig extends BaseExporterConfig {
+  apiKey?: string;
+  mlApp?: string;
+  site?: string;
+  service?: string;
+  env?: string;
+  agentless?: boolean;
+  integrationsEnabled?: boolean;
+}
+```
+
+Extends `BaseExporterConfig`, which includes:
+- `logger?: IMastraLogger` - Logger instance
+- `logLevel?: LogLevel | 'debug' | 'info' | 'warn' | 'error'` - Log level (default: INFO)
+
+<PropertiesTable
+  props={[
+    {
+      name: "apiKey",
+      type: "string",
+      description: "Datadog API key. Required for agentless mode. Falls back to DD_API_KEY env var.",
+      required: false,
+    },
+    {
+      name: "mlApp",
+      type: "string",
+      description: "ML application name for grouping traces. Required. Falls back to DD_LLMOBS_ML_APP env var.",
+      required: false,
+    },
+    {
+      name: "site",
+      type: "string",
+      description: "Datadog site (e.g., 'datadoghq.com', 'datadoghq.eu', 'us3.datadoghq.com'). Falls back to DD_SITE env var. Default: 'datadoghq.com'.",
+      required: false,
+    },
+    {
+      name: "service",
+      type: "string",
+      description: "Service name for the application. Defaults to mlApp value.",
+      required: false,
+    },
+    {
+      name: "env",
+      type: "string",
+      description: "Environment name (e.g., 'production', 'staging'). Falls back to DD_ENV env var.",
+      required: false,
+    },
+    {
+      name: "agentless",
+      type: "boolean",
+      description: "Use direct HTTPS intake (true) or local Datadog Agent (false). Default: true.",
+      required: false,
+    },
+    {
+      name: "integrationsEnabled",
+      type: "boolean",
+      description: "Enable dd-trace automatic integrations. Default: false.",
+      required: false,
+    },
+  ]}
+/>
+
+## Methods
+
+### exportTracingEvent
+
+```typescript
+async exportTracingEvent(event: TracingEvent): Promise<void>
+```
+
+Exports a tracing event to Datadog LLM Observability.
+
+### flush
+
+```typescript
+async flush(): Promise<void>
+```
+
+Force flushes any buffered spans to Datadog without shutting down the exporter. Useful in serverless environments where you need to ensure spans are exported before the runtime terminates.
+
+### shutdown
+
+```typescript
+async shutdown(): Promise<void>
+```
+
+Flushes pending data and shuts down the exporter. Cancels any pending cleanup timers and disables LLM Observability.
+
+## Usage
+
+### Zero-Config (using environment variables)
+
+```typescript
+import { DatadogExporter } from "@mastra/datadog";
+
+// Reads from DD_LLMOBS_ML_APP, DD_API_KEY, DD_SITE, DD_ENV
+const exporter = new DatadogExporter();
+```
+
+### Explicit Configuration
+
+```typescript
+import { DatadogExporter } from "@mastra/datadog";
+
+const exporter = new DatadogExporter({
+  mlApp: "my-llm-app",
+  apiKey: process.env.DD_API_KEY,
+  site: "datadoghq.com",
+  env: "production",
+});
+```
+
+### With Local Datadog Agent
+
+```typescript
+const exporter = new DatadogExporter({
+  mlApp: "my-llm-app",
+  agentless: false, // Use local Datadog Agent
+  env: "production",
+});
+```
+
+## Span Mapping
+
+Mastra span types are mapped to Datadog LLMObs span kinds:
+
+| Mastra SpanType | Datadog Kind |
+|-----------------|--------------|
+| `AGENT_RUN` | `agent` |
+| `MODEL_GENERATION` | `workflow` |
+| `MODEL_STEP` | `llm` |
+| `TOOL_CALL` | `tool` |
+| `MCP_TOOL_CALL` | `tool` |
+| `WORKFLOW_RUN` | `workflow` |
+| All other types | `task` |
+
+All unmapped span types (including `MODEL_CHUNK`, `WORKFLOW_STEP`, `GENERIC`, and future span types) automatically default to `task`.
+
+## Environment Variables
+
+The exporter reads configuration from these environment variables:
+
+| Variable | Description |
+|----------|-------------|
+| `DD_API_KEY` | Datadog API key |
+| `DD_LLMOBS_ML_APP` | ML application name |
+| `DD_SITE` | Datadog site |
+| `DD_ENV` | Environment name |
+| `DD_LLMOBS_AGENTLESS_ENABLED` | Set to 'false' or '0' to use local agent |

package/.docs/raw/reference/observability/tracing/exporters/default-exporter.mdx

@@ -1,6 +1,8 @@
 ---
 title: "Reference: DefaultExporter | Observability"
 description: API reference for the DefaultExporter
+packages:
+  - "@mastra/observability"
 ---
 
 import PropertiesTable from "@site/src/components/PropertiesTable";
@@ -112,6 +114,14 @@ Processes a tracing event according to the resolved strategy.
   ]}
 />
 
+### flush
+
+```typescript
+async flush(): Promise<void>
+```
+
+Force flushes any buffered events to storage without shutting down the exporter. Useful in serverless environments where you need to ensure spans are exported before the runtime terminates.
+
 ### shutdown
 
 ```typescript

package/.docs/raw/reference/observability/tracing/exporters/laminar.mdx

@@ -0,0 +1,139 @@
+---
+title: "Reference: LaminarExporter | Observability"
+description: Laminar exporter for Tracing
+packages:
+  - "@mastra/laminar"
+---
+
+import PropertiesTable from "@site/src/components/PropertiesTable";
+
+# LaminarExporter
+
+Sends Tracing data to Laminar via OTLP/HTTP (protobuf).
+
+## Constructor
+
+```typescript
+new LaminarExporter(config?: LaminarExporterConfig)
+```
+
+## LaminarExporterConfig
+
+```typescript
+interface LaminarExporterConfig extends BaseExporterConfig {
+  apiKey?: string;
+  baseUrl?: string;
+  endpoint?: string;
+  headers?: Record<string, string>;
+  realtime?: boolean;
+  disableBatch?: boolean;
+  batchSize?: number;
+  timeoutMillis?: number;
+}
+```
+
+Extends `BaseExporterConfig`, which includes:
+- `logger?: IMastraLogger` - Logger instance
+- `logLevel?: LogLevel | 'debug' | 'info' | 'warn' | 'error'` - Log level (default: INFO)
+
+<PropertiesTable
+  props={[
+    {
+      name: "apiKey",
+      type: "string",
+      description: "Laminar project API key. Falls back to LMNR_PROJECT_API_KEY env var.",
+      required: false,
+    },
+    {
+      name: "baseUrl",
+      type: "string",
+      description: "Laminar base URL (used for trace exports + scoring). Falls back to LMNR_BASE_URL env var (default: https://api.lmnr.ai).",
+      required: false,
+    },
+    {
+      name: "endpoint",
+      type: "string",
+      description: "OTLP/HTTP traces endpoint (ends with /v1/traces). Falls back to LAMINAR_ENDPOINT env var (default: `${baseUrl}/v1/traces`).",
+      required: false,
+    },
+    {
+      name: "headers",
+      type: "Record<string, string>",
+      description: "Additional headers to include in OTLP requests (merged with Authorization).",
+      required: false,
+    },
+    {
+      name: "realtime",
+      type: "boolean",
+      description: "Flush after each span for immediate visibility (default: false).",
+      required: false,
+    },
+    {
+      name: "disableBatch",
+      type: "boolean",
+      description: "Disable batching (SimpleSpanProcessor). Default: false.",
+      required: false,
+    },
+    {
+      name: "batchSize",
+      type: "number",
+      description: "Max spans per batch (BatchSpanProcessor). Default: 512.",
+      required: false,
+    },
+    {
+      name: "timeoutMillis",
+      type: "number",
+      description: "OTLP export timeout in milliseconds. Default: 30000.",
+      required: false,
+    },
+  ]}
+/>
+
+## Methods
+
+### exportTracingEvent
+
+```typescript
+async exportTracingEvent(event: TracingEvent): Promise<void>
+```
+
+Exports a tracing event to Laminar.
+
+### flush
+
+```typescript
+async flush(): Promise<void>
+```
+
+Force flushes any buffered spans to Laminar without shutting down the exporter. Useful in serverless environments where you need to ensure spans are exported before the runtime terminates.
+
+### shutdown
+
+```typescript
+async shutdown(): Promise<void>
+```
+
+Flushes pending data and shuts down the exporter.
+
+## Usage
+
+### Zero-Config (using environment variables)
+
+```typescript
+import { LaminarExporter } from "@mastra/laminar";
+
+// Reads from LMNR_PROJECT_API_KEY, LMNR_BASE_URL, LAMINAR_ENDPOINT
+const exporter = new LaminarExporter();
+```
+
+### Explicit Configuration
+
+```typescript
+import { LaminarExporter } from "@mastra/laminar";
+
+const exporter = new LaminarExporter({
+  apiKey: process.env.LMNR_PROJECT_API_KEY,
+  baseUrl: "https://api.lmnr.ai",
+  realtime: true,
+});
+```

package/.docs/raw/reference/observability/tracing/exporters/langfuse.mdx

@@ -1,6 +1,9 @@
 ---
 title: "Reference: LangfuseExporter | Observability"
 description: Langfuse exporter for Tracing
+packages:
+  - "@mastra/langfuse"
+  - "@mastra/observability"
 ---
 
 import PropertiesTable from "@site/src/components/PropertiesTable";
@@ -36,19 +39,19 @@ Extends `BaseExporterConfig`, which includes:
     {
       name: "publicKey",
       type: "string",
-      description: "Langfuse API key",
+      description: "Langfuse API key. Falls back to LANGFUSE_PUBLIC_KEY env var.",
       required: false,
     },
     {
       name: "secretKey",
       type: "string",
-      description: "Langfuse secret key",
+      description: "Langfuse secret key. Falls back to LANGFUSE_SECRET_KEY env var.",
       required: false,
     },
     {
       name: "baseUrl",
       type: "string",
-      description: "Langfuse host URL",
+      description: "Langfuse host URL. Falls back to LANGFUSE_BASE_URL env var.",
       required: false,
     },
     {
@@ -90,6 +93,14 @@ async export(spans: ReadOnlySpan[]): Promise<void>
 
 Batch exports spans to Langfuse.
 
+### flush
+
+```typescript
+async flush(): Promise<void>
+```
+
+Force flushes any buffered spans to Langfuse without shutting down the exporter. Useful in serverless environments where you need to ensure spans are exported before the runtime terminates.
+
 ### shutdown
 
 ```typescript
@@ -100,6 +111,17 @@ Flushes pending data and shuts down the client.
 
 ## Usage
 
+### Zero-Config (using environment variables)
+
+```typescript
+import { LangfuseExporter } from "@mastra/langfuse";
+
+// Reads from LANGFUSE_PUBLIC_KEY, LANGFUSE_SECRET_KEY, LANGFUSE_BASE_URL
+const exporter = new LangfuseExporter();
+```
+
+### Explicit Configuration
+
 ```typescript
 import { LangfuseExporter } from "@mastra/langfuse";
 
@@ -137,7 +159,7 @@ const prompt = await langfuse.getPrompt("customer-support");
 const agent = new Agent({
   name: "support-agent",
   instructions: prompt.prompt,
-  model: openai("gpt-4o"),
+  model: "openai/gpt-4o",
   defaultGenerateOptions: {
     tracingOptions: buildTracingOptions(withLangfusePrompt(prompt)),
   },

package/.docs/raw/reference/observability/tracing/exporters/langsmith.mdx

@@ -1,6 +1,8 @@
 ---
 title: "Reference: LangSmithExporter | Observability"
 description: LangSmith exporter for Tracing
+packages:
+  - "@mastra/langsmith"
 ---
 
 import PropertiesTable from "@site/src/components/PropertiesTable";
@@ -91,6 +93,14 @@ async exportTracingEvent(event: TracingEvent): Promise<void>
 
 Exports a tracing event to LangSmith.
 
+### flush
+
+```typescript
+async flush(): Promise<void>
+```
+
+Force flushes any pending spans to LangSmith without shutting down the exporter. Useful in serverless environments where you need to ensure spans are exported before the runtime terminates.
+
 ### shutdown
 
 ```typescript

package/.docs/raw/reference/observability/tracing/exporters/otel.mdx

@@ -1,6 +1,8 @@
 ---
 title: "Reference: OtelExporter | Observability"
 description: OpenTelemetry exporter for Tracing
+packages:
+  - "@mastra/otel-exporter"
 ---
 
 import PropertiesTable from "@site/src/components/PropertiesTable";
@@ -68,8 +70,8 @@ interface OtelExporterConfig {
 
 ```typescript
 interface Dash0Config {
-  apiKey: string;
-  endpoint: string;
+  apiKey?: string;
+  endpoint?: string;
   dataset?: string;
 }
 ```
@@ -79,20 +81,20 @@ interface Dash0Config {
     {
       name: "apiKey",
       type: "string",
-      description: "Dash0 API key",
-      required: true,
+      description: "Dash0 API key. Falls back to DASH0_API_KEY env var.",
+      required: false,
     },
     {
       name: "endpoint",
       type: "string",
       description:
-        "Dash0 ingress endpoint (e.g., ingress.us-west-2.aws.dash0.com:4317)",
-      required: true,
+        "Dash0 ingress endpoint. Falls back to DASH0_ENDPOINT env var.",
+      required: false,
     },
     {
       name: "dataset",
       type: "string",
-      description: "Optional dataset name for data organization",
+      description: "Dataset name. Falls back to DASH0_DATASET env var.",
       required: false,
     },
   ]}
@@ -102,7 +104,7 @@ interface Dash0Config {
 
 ```typescript
 interface SignozConfig {
-  apiKey: string;
+  apiKey?: string;
   region?: "us" | "eu" | "in";
   endpoint?: string;
 }
@@ -113,19 +115,19 @@ interface SignozConfig {
     {
       name: "apiKey",
       type: "string",
-      description: "SigNoz ingestion key",
-      required: true,
+      description: "SigNoz ingestion key. Falls back to SIGNOZ_API_KEY env var.",
+      required: false,
     },
     {
       name: "region",
       type: "'us' | 'eu' | 'in'",
-      description: "SigNoz cloud region (default: 'us')",
+      description: "SigNoz cloud region. Falls back to SIGNOZ_REGION env var. (default: 'us')",
       required: false,
     },
     {
       name: "endpoint",
       type: "string",
-      description: "Custom endpoint for self-hosted SigNoz",
+      description: "Custom endpoint. Falls back to SIGNOZ_ENDPOINT env var.",
       required: false,
     },
   ]}
@@ -135,7 +137,7 @@ interface SignozConfig {
 
 ```typescript
 interface NewRelicConfig {
-  apiKey: string;
+  apiKey?: string;
   endpoint?: string;
 }
 ```
@@ -145,14 +147,14 @@ interface NewRelicConfig {
     {
       name: "apiKey",
       type: "string",
-      description: "New Relic license key",
-      required: true,
+      description: "New Relic license key. Falls back to NEW_RELIC_LICENSE_KEY env var.",
+      required: false,
     },
     {
       name: "endpoint",
       type: "string",
       description:
-        "Custom endpoint (default: https://otlp.nr-data.net:443/v1/traces)",
+        "Custom endpoint. Falls back to NEW_RELIC_ENDPOINT env var. (default: https://otlp.nr-data.net:443/v1/traces)",
       required: false,
     },
   ]}
@@ -162,7 +164,7 @@ interface NewRelicConfig {
 
 ```typescript
 interface TraceloopConfig {
-  apiKey: string;
+  apiKey?: string;
   destinationId?: string;
   endpoint?: string;
 }
@@ -173,20 +175,20 @@ interface TraceloopConfig {
     {
       name: "apiKey",
       type: "string",
-      description: "Traceloop API key",
-      required: true,
+      description: "Traceloop API key. Falls back to TRACELOOP_API_KEY env var.",
+      required: false,
     },
     {
       name: "destinationId",
       type: "string",
-      description: "Optional destination identifier",
+      description: "Destination identifier. Falls back to TRACELOOP_DESTINATION_ID env var.",
       required: false,
     },
     {
       name: "endpoint",
       type: "string",
       description:
-        "Custom endpoint (default: https://api.traceloop.com/v1/traces)",
+        "Custom endpoint. Falls back to TRACELOOP_ENDPOINT env var. (default: https://api.traceloop.com/v1/traces)",
       required: false,
     },
   ]}
@@ -196,8 +198,7 @@ interface TraceloopConfig {
 
 ```typescript
 interface LaminarConfig {
-  apiKey: string;
-  teamId?: string;
+  apiKey?: string;
   endpoint?: string;
 }
 ```
@@ -207,19 +208,13 @@ interface LaminarConfig {
     {
       name: "apiKey",
       type: "string",
-      description: "Laminar project API key",
-      required: true,
-    },
-    {
-      name: "teamId",
-      type: "string",
-      description: "Optional team identifier (for backwards compatibility)",
+      description: "Laminar project API key. Falls back to LMNR_PROJECT_API_KEY env var.",
       required: false,
     },
     {
       name: "endpoint",
       type: "string",
-      description: "Custom endpoint (default: https://api.lmnr.ai/v1/traces)",
+      description: "Custom endpoint. Falls back to LAMINAR_ENDPOINT env var. (default: https://api.lmnr.ai/v1/traces)",
       required: false,
     },
   ]}
@@ -268,6 +263,14 @@ async exportTracingEvent(event: TracingEvent): Promise<void>
 
 Exports a tracing event to the configured OTEL backend.
 
+### flush
+
+```typescript
+async flush(): Promise<void>
+```
+
+Force flushes any buffered spans to the OTEL backend without shutting down the exporter. Useful in serverless environments where you need to ensure spans are exported before the runtime terminates.
+
 ### shutdown
 
 ```typescript
@@ -278,7 +281,22 @@ Flushes pending traces and shuts down the exporter.
 
 ## Usage Examples
 
-### Basic Usage
+### Zero-Config (using environment variables)
+
+```typescript
+import { OtelExporter } from "@mastra/otel-exporter";
+
+// Set SIGNOZ_API_KEY, SIGNOZ_REGION environment variables
+const exporter = new OtelExporter({ provider: { signoz: {} } });
+
+// Or for other providers:
+// Set DASH0_API_KEY, DASH0_ENDPOINT for Dash0
+// Set NEW_RELIC_LICENSE_KEY for New Relic
+// Set TRACELOOP_API_KEY for Traceloop
+// Set LMNR_PROJECT_API_KEY for Laminar
+```
+
+### Explicit Configuration
 
 ```typescript
 import { OtelExporter } from "@mastra/otel-exporter";
@@ -330,8 +348,7 @@ The OtelExporter supports trace tagging for categorization and filtering. Tags a
 ### Usage
 
 ```typescript
-const result = await agent.generate({
-  messages: [{ role: "user", content: "Hello" }],
+const result = await agent.generate("Hello", {
   tracingOptions: {
     tags: ["production", "experiment-v2", "user-request"],
   },