@mastra/mcp-docs-server 1.1.9-alpha.0 → 1.1.9-alpha.2

package/.docs/reference/observability/tracing/exporters/langsmith.md

@@ -8,7 +8,7 @@ Sends Tracing data to LangSmith for observability.
 new LangSmithExporter(config: LangSmithExporterConfig)
 ```
 
-## LangSmithExporterConfig
+## `LangSmithExporterConfig`
 
 ```typescript
 interface LangSmithExporterConfig extends ClientConfig, BaseExporterConfig {
@@ -24,7 +24,7 @@ Extends both `ClientConfig` (from LangSmith SDK) and `BaseExporterConfig`:
 
 ## Methods
 
-### exportTracingEvent
+### `exportTracingEvent`
 
 ```typescript
 async exportTracingEvent(event: TracingEvent): Promise<void>
@@ -61,7 +61,7 @@ const exporter = new LangSmithExporter({
 })
 ```
 
-## Environment Variables
+## Environment variables
 
 | Variable             | Description                                                           |
 | -------------------- | --------------------------------------------------------------------- |
@@ -69,7 +69,7 @@ const exporter = new LangSmithExporter({
 | `LANGCHAIN_PROJECT`  | Default project name for traces (used if `projectName` not specified) |
 | `LANGSMITH_BASE_URL` | API URL for self-hosted instances                                     |
 
-## Span Type Mapping
+## Span type mapping
 
 | Span Type          | LangSmith Type |
 | ------------------ | -------------- |
@@ -79,7 +79,7 @@ const exporter = new LangSmithExporter({
 | `MCP_TOOL_CALL`    | `tool`         |
 | All others         | `chain`        |
 
-## withLangsmithMetadata
+## `withLangsmithMetadata`
 
 Helper function to add LangSmith-specific metadata to tracing options.
 
@@ -87,7 +87,7 @@ Helper function to add LangSmith-specific metadata to tracing options.
 function withLangsmithMetadata(metadata: LangSmithMetadataInput): TracingOptionsUpdater
 ```
 
-### LangSmithMetadataInput
+### `LangSmithMetadataInput`
 
 ### Usage
 

package/.docs/reference/observability/tracing/exporters/otel.md

@@ -8,7 +8,7 @@ Sends Tracing data to any OpenTelemetry-compatible observability platform using
 new OtelExporter(config: OtelExporterConfig)
 ```
 
-## OtelExporterConfig
+## `OtelExporterConfig`
 
 ```typescript
 interface OtelExporterConfig {
@@ -19,9 +19,9 @@ interface OtelExporterConfig {
 }
 ```
 
-## Provider Configurations
+## Provider configurations
 
-### Dash0Config
+### `Dash0Config`
 
 ```typescript
 interface Dash0Config {
@@ -31,7 +31,7 @@ interface Dash0Config {
 }
 ```
 
-### SignozConfig
+### `SignozConfig`
 
 ```typescript
 interface SignozConfig {
@@ -41,7 +41,7 @@ interface SignozConfig {
 }
 ```
 
-### NewRelicConfig
+### `NewRelicConfig`
 
 ```typescript
 interface NewRelicConfig {
@@ -50,7 +50,7 @@ interface NewRelicConfig {
 }
 ```
 
-### TraceloopConfig
+### `TraceloopConfig`
 
 ```typescript
 interface TraceloopConfig {
@@ -60,7 +60,7 @@ interface TraceloopConfig {
 }
 ```
 
-### LaminarConfig
+### `LaminarConfig`
 
 ```typescript
 interface LaminarConfig {
@@ -69,7 +69,7 @@ interface LaminarConfig {
 }
 ```
 
-### CustomConfig
+### `CustomConfig`
 
 ```typescript
 interface CustomConfig {
@@ -81,7 +81,7 @@ interface CustomConfig {
 
 ## Methods
 
-### exportTracingEvent
+### `exportTracingEvent`
 
 ```typescript
 async exportTracingEvent(event: TracingEvent): Promise<void>
@@ -105,7 +105,7 @@ async shutdown(): Promise<void>
 
 Flushes pending traces and shuts down the exporter.
 
-## Usage Examples
+## Usage examples
 
 ### Zero-Config (using environment variables)
 
@@ -155,7 +155,7 @@ const exporter = new OtelExporter({
 })
 ```
 
-## Protocol Requirements
+## Protocol requirements
 
 Different providers require different OTEL exporter packages:
 
@@ -166,7 +166,7 @@ Different providers require different OTEL exporter packages:
 | HTTP/JSON     | `@opentelemetry/exporter-trace-otlp-http`  | Traceloop, Custom          |
 | Zipkin        | `@opentelemetry/exporter-zipkin`           | Zipkin collectors          |
 
-## Tags Support
+## Tags support
 
 The OtelExporter supports trace tagging for categorization and filtering. Tags are only applied to root spans and are stored as the `mastra.tags` attribute.
 

package/.docs/reference/observability/tracing/exporters/posthog.md

@@ -8,7 +8,7 @@ Sends Tracing data to PostHog for AI observability and analytics.
 new PosthogExporter(config: PosthogExporterConfig)
 ```
 
-## PosthogExporterConfig
+## `PosthogExporterConfig`
 
 ```typescript
 interface PosthogExporterConfig extends BaseExporterConfig {
@@ -29,7 +29,7 @@ Extends `BaseExporterConfig`, which includes:
 
 ## Methods
 
-### exportTracingEvent
+### `exportTracingEvent`
 
 ```typescript
 async exportTracingEvent(event: TracingEvent): Promise<void>
@@ -76,7 +76,7 @@ const exporter = new PosthogExporter({
 })
 ```
 
-## Span Type Mapping
+## Span type mapping
 
 | Mastra Span Type    | PostHog Event Type |
 | ------------------- | ------------------ |

package/.docs/reference/observability/tracing/exporters/sentry.md

@@ -8,7 +8,7 @@ Sends Tracing data to Sentry for AI tracing and monitoring using OpenTelemetry s
 new SentryExporter(config: SentryExporterConfig)
 ```
 
-## SentryExporterConfig
+## `SentryExporterConfig`
 
 ```typescript
 interface SentryExporterConfig extends BaseExporterConfig {
@@ -27,7 +27,7 @@ Extends `BaseExporterConfig`, which includes:
 
 ## Methods
 
-### exportTracingEvent
+### `exportTracingEvent`
 
 ```typescript
 async exportTracingEvent(event: TracingEvent): Promise<void>
@@ -103,7 +103,7 @@ const exporter = new SentryExporter({
 })
 ```
 
-## Span Mapping
+## Span mapping
 
 Mastra span types are mapped to Sentry operations:
 
@@ -128,7 +128,7 @@ Mastra span types are mapped to Sentry operations:
 
 MODEL\_STEP and MODEL\_CHUNK spans are skipped to simplify trace hierarchy. Their data is aggregated into MODEL\_GENERATION spans.
 
-## Environment Variables
+## Environment variables
 
 The exporter reads configuration from these environment variables:
 
@@ -138,7 +138,7 @@ The exporter reads configuration from these environment variables:
 | `SENTRY_ENVIRONMENT` | Deployment environment name                           |
 | `SENTRY_RELEASE`     | Version of your code deployed                         |
 
-## OpenTelemetry Attributes
+## `OpenTelemetry` attributes
 
 The exporter sets these standard OpenTelemetry attributes:
 

package/.docs/reference/observability/tracing/instances.md

@@ -1,6 +1,6 @@
 # Observability Instances
 
-## DefaultObservabilityInstance
+## `DefaultObservabilityInstance`
 
 Default implementation of the ObservabilityInstance interface.
 
@@ -16,13 +16,13 @@ Creates a new DefaultObservabilityInstance with the specified configuration.
 
 Inherits all properties and methods from BaseObservabilityInstance.
 
-## BaseObservabilityInstance
+## `BaseObservabilityInstance`
 
 Base class for custom ObservabilityInstance implementations.
 
 ### Methods
 
-#### getConfig
+#### `getConfig`
 
 ```typescript
 getConfig(): Readonly<Required<ObservabilityInstanceConfig>>
@@ -30,7 +30,7 @@ getConfig(): Readonly<Required<ObservabilityInstanceConfig>>
 
 Returns the current observability configuration.
 
-#### getExporters
+#### `getExporters`
 
 ```typescript
 getExporters(): readonly ObservabilityExporter[]
@@ -38,7 +38,7 @@ getExporters(): readonly ObservabilityExporter[]
 
 Returns all configured exporters.
 
-#### getSpanOutputProcessors
+#### `getSpanOutputProcessors`
 
 ```typescript
 getSpanOutputProcessors(): readonly SpanOutputProcessor[]
@@ -46,7 +46,7 @@ getSpanOutputProcessors(): readonly SpanOutputProcessor[]
 
 Returns all configured span output processors.
 
-#### getLogger
+#### `getLogger`
 
 ```typescript
 getLogger(): IMastraLogger
@@ -54,7 +54,7 @@ getLogger(): IMastraLogger
 
 Returns the logger instance for exporters and other components.
 
-#### startSpan
+#### `startSpan`
 
 ```typescript
 startSpan<TType extends SpanType>(
@@ -72,7 +72,7 @@ async shutdown(): Promise<void>
 
 Shuts down all exporters and processors, cleaning up resources.
 
-## Custom Implementation
+## Custom implementation
 
 To create a custom ObservabilityInstance implementation, extend BaseObservabilityInstance:
 
@@ -91,7 +91,7 @@ class CustomObservabilityInstance extends BaseObservabilityInstance {
 }
 ```
 
-## See Also
+## See also
 
 ### Documentation
 

package/.docs/reference/observability/tracing/interfaces.md

@@ -1,8 +1,8 @@
 # Interfaces
 
-## Core Interfaces
+## Core interfaces
 
-### ObservabilityInstance
+### `ObservabilityInstance`
 
 Primary interface for observability.
 
@@ -31,7 +31,7 @@ interface ObservabilityInstance {
 }
 ```
 
-### SpanTypeMap
+### `SpanTypeMap`
 
 Mapping of span types to their corresponding attribute interfaces.
 
@@ -114,7 +114,7 @@ interface Span<TType extends SpanType> {
 }
 ```
 
-### ObservabilityExporter
+### `ObservabilityExporter`
 
 Interface for observability exporters.
 
@@ -154,7 +154,7 @@ interface ObservabilityExporter {
 }
 ```
 
-### SpanOutputProcessor
+### `SpanOutputProcessor`
 
 Interface for span output processors.
 
@@ -171,9 +171,9 @@ interface SpanOutputProcessor {
 }
 ```
 
-## Span Types
+## Span types
 
-### SpanType
+### `SpanType`
 
 AI-specific span types with their associated metadata.
 
@@ -229,7 +229,7 @@ enum SpanType {
 }
 ```
 
-### AnySpan
+### `AnySpan`
 
 Union type for cases that need to handle any span.
 
@@ -237,9 +237,9 @@ Union type for cases that need to handle any span.
 type AnySpan = Span<keyof SpanTypeMap>
 ```
 
-## Span Attributes
+## Span attributes
 
-### AgentRunAttributes
+### `AgentRunAttributes`
 
 Agent Run attributes.
 
@@ -262,7 +262,7 @@ interface AgentRunAttributes {
 }
 ```
 
-### ModelGenerationAttributes
+### `ModelGenerationAttributes`
 
 Model Generation attributes.
 
@@ -307,7 +307,7 @@ interface ModelGenerationAttributes {
 }
 ```
 
-### ModelStepAttributes
+### `ModelStepAttributes`
 
 Model Step attributes - for a single model execution within a generation.
 
@@ -330,7 +330,7 @@ interface ModelStepAttributes {
 }
 ```
 
-### ModelChunkAttributes
+### `ModelChunkAttributes`
 
 Model Chunk attributes - for individual streaming chunks/events.
 
@@ -344,7 +344,7 @@ interface ModelChunkAttributes {
 }
 ```
 
-### ToolCallAttributes
+### `ToolCallAttributes`
 
 Tool Call attributes.
 
@@ -377,7 +377,7 @@ interface MCPToolCallAttributes {
 }
 ```
 
-### ProcessorRunAttributes
+### `ProcessorRunAttributes`
 
 Processor attributes.
 
@@ -394,7 +394,7 @@ interface ProcessorRunAttributes {
 }
 ```
 
-### WorkflowRunAttributes
+### `WorkflowRunAttributes`
 
 Workflow Run attributes.
 
@@ -408,7 +408,7 @@ interface WorkflowRunAttributes {
 }
 ```
 
-### WorkflowStepAttributes
+### `WorkflowStepAttributes`
 
 Workflow Step attributes.
 
@@ -422,9 +422,9 @@ interface WorkflowStepAttributes {
 }
 ```
 
-## Options Types
+## Options types
 
-### StartSpanOptions
+### `StartSpanOptions`
 
 Options for starting new spans.
 
@@ -456,7 +456,7 @@ interface StartSpanOptions<TType extends SpanType> {
 }
 ```
 
-### UpdateSpanOptions
+### `UpdateSpanOptions`
 
 Options for updating spans.
 
@@ -476,7 +476,7 @@ interface UpdateSpanOptions<TType extends SpanType> {
 }
 ```
 
-### EndSpanOptions
+### `EndSpanOptions`
 
 Options for ending spans.
 
@@ -493,7 +493,7 @@ interface EndSpanOptions<TType extends SpanType> {
 }
 ```
 
-### ErrorSpanOptions
+### `ErrorSpanOptions`
 
 Options for recording span errors.
 
@@ -513,9 +513,9 @@ interface ErrorSpanOptions<TType extends SpanType> {
 }
 ```
 
-## Context Types
+## Context types
 
-### TracingContext
+### `TracingContext`
 
 Context for Tracing that flows through workflow and agent execution.
 
@@ -526,7 +526,7 @@ interface TracingContext {
 }
 ```
 
-### TracingProperties
+### `TracingProperties`
 
 Properties returned to the user for working with traces externally.
 
@@ -537,7 +537,7 @@ type TracingProperties = {
 }
 ```
 
-### TracingOptions
+### `TracingOptions`
 
 Options passed when starting a new agent or workflow execution.
 
@@ -586,7 +586,7 @@ interface TracingOptions {
 }
 ```
 
-### TracingPolicy
+### `TracingPolicy`
 
 Policy-level tracing configuration applied when creating a workflow or agent.
 
@@ -601,9 +601,9 @@ interface TracingPolicy {
 }
 ```
 
-## Configuration Types
+## Configuration types
 
-### ObservabilityInstanceConfig
+### `ObservabilityInstanceConfig`
 
 Configuration for a single observability instance.
 
@@ -632,7 +632,7 @@ interface ObservabilityInstanceConfig {
 }
 ```
 
-### ObservabilityRegistryConfig
+### `ObservabilityRegistryConfig`
 
 Complete observability registry configuration.
 
@@ -651,9 +651,9 @@ interface ObservabilityRegistryConfig {
 }
 ```
 
-## Sampling Types
+## Sampling types
 
-### SamplingStrategy
+### `SamplingStrategy`
 
 Sampling strategy configuration.
 
@@ -665,7 +665,7 @@ type SamplingStrategy =
   | { type: 'custom'; sampler: (options?: CustomSamplerOptions) => boolean }
 ```
 
-### CustomSamplerOptions
+### `CustomSamplerOptions`
 
 Options passed when using a custom sampler strategy.
 
@@ -676,9 +676,9 @@ interface CustomSamplerOptions {
 }
 ```
 
-## Config Selector Types
+## Config selector types
 
-### ConfigSelector
+### `ConfigSelector`
 
 Function to select which observability instance to use for a given span.
 
@@ -689,7 +689,7 @@ type ConfigSelector = (
 ) => string | undefined
 ```
 
-### ConfigSelectorOptions
+### `ConfigSelectorOptions`
 
 Options passed when using a custom tracing config selector.
 
@@ -700,9 +700,9 @@ interface ConfigSelectorOptions {
 }
 ```
 
-## Internal Spans
+## Internal spans
 
-### InternalSpans
+### `InternalSpans`
 
 Bitwise options to set different types of spans as internal in a workflow or agent execution.
 
@@ -728,7 +728,7 @@ enum InternalSpans {
 }
 ```
 
-## See Also
+## See also
 
 ### Documentation
 

package/.docs/reference/observability/tracing/processors/sensitive-data-filter.md

@@ -8,7 +8,7 @@ A SpanOutputProcessor that redacts sensitive information from span fields.
 new SensitiveDataFilter(options?: SensitiveDataFilterOptions)
 ```
 
-## SensitiveDataFilterOptions
+## `SensitiveDataFilterOptions`
 
 ```typescript
 interface SensitiveDataFilterOptions {
@@ -38,7 +38,7 @@ interface SensitiveDataFilterOptions {
 }
 ```
 
-## RedactionStyle
+## `RedactionStyle`
 
 ```typescript
 type RedactionStyle = 'full' | 'partial'
@@ -70,7 +70,7 @@ No cleanup needed for this processor.
 readonly name = 'sensitive-data-filter';
 ```
 
-## Default Sensitive Fields
+## Default sensitive fields
 
 When no custom fields are provided:
 
@@ -94,7 +94,7 @@ When no custom fields are provided:
 ]
 ```
 
-## Processing Behavior
+## Processing behavior
 
 ### Field Matching
 
@@ -119,7 +119,7 @@ All matched values replaced with redactionToken.
 - Values ≤ 6 characters are fully redacted
 - Non-string values are converted to strings before partial redaction
 
-### Error Handling
+### Error handling
 
 If filtering a field fails, the field is replaced with: