@mastra/mcp-docs-server 1.1.8 → 1.1.9-alpha.1

package/.docs/reference/storage/mssql.md

@@ -1,4 +1,4 @@
-# MSSQL Storage
+# MSSQL storage
 
 The MSSQL storage implementation provides a production-ready storage solution using Microsoft SQL Server databases.
 
@@ -45,7 +45,7 @@ const storage = new MSSQLStore({
 
 **schemaName** (`string`): The name of the schema you want the storage to use. Will use the default schema if not provided.
 
-## Constructor Examples
+## Constructor examples
 
 You can instantiate `MSSQLStore` in the following ways:
 
@@ -89,7 +89,7 @@ const store5 = new MSSQLStore({
 })
 ```
 
-## Additional Notes
+## Additional notes
 
 ### Schema Management
 
@@ -138,7 +138,7 @@ const memoryStore = await storage.getStore('memory')
 const thread = await memoryStore?.getThreadById({ threadId: '...' })
 ```
 
-> **Warning:** If `init()` is not called, tables won't be created and storage operations will fail silently or throw errors.
+> **Warning:** If `init()` isn't called, tables won't be created and storage operations will fail silently or throw errors.
 
 ### Direct Database and Pool Access
 

package/.docs/reference/storage/overview.md

@@ -1,8 +1,8 @@
-# Storage Overview
+# Storage overview
 
 Mastra requires the following tables to be present in the database.
 
-## Core Schema
+## Core schema
 
 **Messages**:
 

package/.docs/reference/storage/postgresql.md

@@ -1,4 +1,4 @@
-# PostgreSQL Storage
+# PostgreSQL storage
 
 The PostgreSQL storage implementation provides a production-ready storage solution using PostgreSQL databases.
 
@@ -71,7 +71,7 @@ const storage = new PostgresStore({
 
 **indexes** (`CreateIndexOptions[]`): Custom indexes to create during initialization.
 
-## Constructor Examples
+## Constructor examples
 
 You can instantiate `PostgresStore` in the following ways:
 
@@ -119,7 +119,7 @@ const store4 = new PostgresStore({
 })
 ```
 
-## Additional Notes
+## Additional notes
 
 ### Schema Management
 
@@ -177,7 +177,7 @@ const memoryStore = await storage.getStore('memory')
 const thread = await memoryStore?.getThreadById({ threadId: '...' })
 ```
 
-> **Warning:** If `init()` is not called, tables won't be created and storage operations will fail silently or throw errors.
+> **Warning:** If `init()` isn't called, tables won't be created and storage operations will fail silently or throw errors.
 
 ### Using an Existing Pool
 
@@ -201,7 +201,7 @@ const storage = new PostgresStore({
 
 **Pool lifecycle behavior:**
 
-- When you **provide a pool**: Mastra uses your pool but does **not** close it when `store.close()` is called. You manage the pool lifecycle.
+- When you **provide a pool**: Mastra uses your pool but **doesn't** close it when `store.close()` is called. You manage the pool lifecycle.
 - When Mastra **creates a pool**: Mastra owns the pool and will close it when `store.close()` is called.
 
 ### Direct Database and Pool Access
@@ -316,7 +316,7 @@ This pattern ensures only one `PostgresStore` instance is created regardless of
 
 > **Tip:** This singleton pattern is only necessary during local development with HMR. In production builds, modules are only loaded once.
 
-## Usage Example
+## Usage example
 
 ### Adding memory to an agent
 
@@ -387,7 +387,7 @@ for await (const chunk of stream.textStream) {
 }
 ```
 
-## Index Management
+## Index management
 
 PostgreSQL storage provides index management to optimize query performance.
 

package/.docs/reference/storage/upstash.md

@@ -1,10 +1,10 @@
-# Upstash Storage
+# Upstash storage
 
 The Upstash storage implementation provides a serverless-friendly storage solution using Upstash's Redis-compatible key-value store.
 
 > **Pricing:** When using Mastra with Upstash, the pay-as-you-go model can result in unexpectedly high costs due to the high volume of Redis commands generated during agent conversations. We strongly recommend using a **fixed pricing plan** for predictable costs. See [Upstash pricing](https://upstash.com/pricing/redis) for details and [GitHub issue #5850](https://github.com/mastra-ai/mastra/issues/5850) for context.
 
-> **Observability Not Supported:** Upstash storage **does not support the observability domain**. Traces from the `DefaultExporter` cannot be persisted to Upstash, and Mastra Studio's observability features won't work with Upstash as your only storage provider. To enable observability, use [composite storage](https://mastra.ai/reference/storage/composite) to route observability data to a supported provider like ClickHouse or PostgreSQL.
+> **Observability Not Supported:** Upstash storage **doesn't support the observability domain**. Traces from the `DefaultExporter` can't be persisted to Upstash, and Mastra Studio's observability features won't work with Upstash as your only storage provider. To enable observability, use [composite storage](https://mastra.ai/reference/storage/composite) to route observability data to a supported provider like ClickHouse or PostgreSQL.
 
 ## Installation
 
@@ -52,7 +52,7 @@ const storage = new UpstashStore({
 
 **prefix** (`string`): Key prefix for all stored items (Default: `mastra:`)
 
-## Additional Notes
+## Additional notes
 
 ### Key Structure
 
@@ -87,7 +87,7 @@ For optimal performance:
 - Monitor Redis memory usage
 - Consider data expiration policies if needed
 
-## Usage Example
+## Usage example
 
 ### Adding memory to an agent
 

package/.docs/reference/streaming/ChunkType.md

@@ -2,7 +2,7 @@
 
 The `ChunkType` type defines the mastra format of stream chunks that can be emitted during streaming responses from agents.
 
-## Base Properties
+## Base properties
 
 All chunks include these base properties:
 
@@ -20,7 +20,7 @@ All chunks include these base properties:
 
 **from.WORKFLOW** (`'WORKFLOW'`): Chunk from workflow execution
 
-## Text Chunks
+## Text chunks
 
 ### text-start
 
@@ -60,7 +60,7 @@ Signals the end of text generation.
 
 **payload.providerMetadata** (`SharedV2ProviderMetadata`): Provider-specific metadata
 
-## Reasoning Chunks
+## Reasoning chunks
 
 ### reasoning-start
 
@@ -118,7 +118,7 @@ Contains the reasoning signature from models that support advanced reasoning (li
 
 **payload.providerMetadata** (`SharedV2ProviderMetadata`): Provider-specific metadata
 
-## Tool Chunks
+## Tool chunks
 
 ### tool-call
 
@@ -162,7 +162,7 @@ Result from a tool execution.
 
 **payload.providerMetadata** (`SharedV2ProviderMetadata`): Provider-specific metadata
 
-### tool-call-input-streaming-start
+### `tool-call-input-streaming-start`
 
 Signals the start of streaming tool call arguments.
 
@@ -180,7 +180,7 @@ Signals the start of streaming tool call arguments.
 
 **payload.providerMetadata** (`SharedV2ProviderMetadata`): Provider-specific metadata
 
-### tool-call-delta
+### `tool-call-delta`
 
 Incremental tool call arguments during streaming.
 
@@ -196,7 +196,7 @@ Incremental tool call arguments during streaming.
 
 **payload.providerMetadata** (`SharedV2ProviderMetadata`): Provider-specific metadata
 
-### tool-call-input-streaming-end
+### `tool-call-input-streaming-end`
 
 Signals the end of streaming tool call arguments.
 
@@ -230,7 +230,7 @@ An error occurred during tool execution.
 
 **payload.providerMetadata** (`SharedV2ProviderMetadata`): Provider-specific metadata
 
-## Source and File Chunks
+## Source and file chunks
 
 ### source
 
@@ -270,7 +270,7 @@ Contains file data.
 
 **payload.providerMetadata** (`SharedV2ProviderMetadata`): Provider-specific metadata
 
-## Control Chunks
+## Control chunks
 
 ### start
 
@@ -368,7 +368,7 @@ Stream was aborted.
 
 **payload.\[key: string]** (`any`): Additional abort data
 
-## Object and Output Chunks
+## Object and output chunks
 
 ### object
 
@@ -398,7 +398,7 @@ Contains output from workflow step execution, used primarily for usage tracking
 
 **payload.output** (`ChunkType`): Nested chunk data from step execution, typically containing finish events or other step results
 
-## Metadata and Special Chunks
+## Metadata and special chunks
 
 ### response-metadata
 
@@ -442,7 +442,7 @@ Emitted when the stream is forcibly terminated due to content being blocked by a
 
 **payload.processorId** (`string`): ID of the processor that triggered the tripwire
 
-## Usage Example
+## Usage example
 
 ```typescript
 const stream = await agent.stream('Hello')
@@ -477,7 +477,7 @@ for await (const chunk of stream.fullStream) {
 }
 ```
 
-## Related Types
+## Related types
 
 - [.stream()](https://mastra.ai/reference/streaming/agents/stream) - Method that returns streams emitting these chunks
 - [MastraModelOutput](https://mastra.ai/reference/streaming/agents/MastraModelOutput) - The stream object that emits these chunks

package/.docs/reference/streaming/agents/MastraModelOutput.md

@@ -9,7 +9,7 @@ const stream = await agent.stream('Hello world')
 
 For setup and basic usage, see the [.stream()](https://mastra.ai/reference/streaming/agents/stream) method documentation.
 
-## Streaming Properties
+## Streaming properties
 
 These properties provide real-time access to model outputs as they're generated:
 
@@ -25,7 +25,7 @@ These properties provide real-time access to model outputs as they're generated:
 
 **elementStream** (`ReadableStream<OUTPUT extends (infer T)[] ? T : never>`): Stream of individual array elements when the output schema defines an array type. Each element is emitted as it's completed rather than waiting for the entire array.
 
-## Promise-based Properties
+## Promise-based properties
 
 These properties resolve to final values after the stream completes:
 
@@ -95,7 +95,7 @@ These properties resolve to final values after the stream completes:
 
 **response.uiMessages** (`UIMessage[]`): Response messages in UI format, includes any metadata added by output processors
 
-## Error Properties
+## Error properties
 
 **error** (`string | Error | { message: string; stack: string; } | undefined`): Error information if the stream encountered an error. Undefined if no errors occurred. Can be a string message, Error object, or serialized error with stack trace.
 
@@ -123,7 +123,7 @@ These properties resolve to final values after the stream completes:
 
 **consumeStream.onError** (`(error: Error) => void`): Callback for handling stream errors
 
-## Usage Examples
+## Usage examples
 
 ### Basic Text Streaming
 
@@ -221,7 +221,7 @@ for await (const chunk of stream.fullStream) {
 }
 ```
 
-### Error Handling
+### Error handling
 
 ```typescript
 const stream = await agent.stream('Analyze this data')
@@ -246,7 +246,7 @@ if (stream.error) {
 }
 ```
 
-## Related Types
+## Related types
 
 - [.stream()](https://mastra.ai/reference/streaming/agents/stream) - Method that returns MastraModelOutput
 - [ChunkType](https://mastra.ai/reference/streaming/ChunkType) - All possible chunk types in the full stream

package/.docs/reference/streaming/agents/stream.md

@@ -290,7 +290,7 @@ for await (const chunk of stream.textStream) {
 }
 ```
 
-### Advanced Example with Options
+### Advanced example with Options
 
 ```ts
 import { z } from 'zod'
@@ -323,7 +323,7 @@ await agent.stream('message for agent', {
 })
 ```
 
-## OpenAI WebSocket Transport
+## OpenAI WebSocket transport
 
 Opt into OpenAI Responses WebSocket streaming via `providerOptions.openai.transport`. This only applies to streaming calls and is currently supported for direct OpenAI models (for example, `openai/gpt-4o`). If WebSocket streaming is unavailable, Mastra falls back to HTTP streaming. By default, Mastra closes the WebSocket when the stream finishes.
 

package/.docs/reference/streaming/agents/streamLegacy.md

@@ -146,7 +146,7 @@ await agent.streamLegacy('message for agent', {
 })
 ```
 
-## Migration to New API
+## Migration to new API
 
 > **Info:** The new `.stream()` method offers enhanced capabilities including AI SDK v5+ compatibility, better structured output handling, and improved callback system. See the [migration guide](https://mastra.ai/guides/migrations/vnext-to-standard-apis) for detailed migration instructions.
 

package/.docs/reference/streaming/workflows/observeStream.md

@@ -1,6 +1,6 @@
 # Run.observeStream()
 
-The `.observeStream()` method opens a new `ReadableStream` to a workflow run that is currently running, allowing you to observe the stream of events if the original stream is no longer available.
+The `.observeStream()` method opens a new `ReadableStream` to a workflow run that's currently running, allowing you to observe the stream of events if the original stream is no longer available.
 
 ## Usage example
 
@@ -24,7 +24,7 @@ for await (const chunk of stream) {
 
 `ReadableStream<ChunkType>`
 
-## Stream Events
+## Stream events
 
 The stream emits various event types during workflow execution. Each event has a `type` field and a `payload` containing relevant data:
 

package/.docs/reference/streaming/workflows/resumeStream.md

@@ -54,7 +54,7 @@ if (result!.status === 'suspended') {
 
 **stream.usage** (`Promise<{ inputTokens: number; outputTokens: number; totalTokens: number, reasoningTokens?: number, cacheInputTokens?: number }>`): A promise that resolves to token usage statistics
 
-## Stream Events
+## Stream events
 
 The stream emits various event types during workflow execution. Each event has a `type` field and a `payload` containing relevant data:
 

package/.docs/reference/streaming/workflows/stream.md

@@ -82,7 +82,7 @@ console.log('Token usage:', usage)
 console.log('Status:', stream.status)
 ```
 
-## Stream Events
+## Stream events
 
 The stream emits various event types during workflow execution. Each event has a `type` field and a `payload` containing relevant data:
 

package/.docs/reference/templates/overview.md

@@ -9,7 +9,7 @@ Mastra templates are pre-built project structures that demonstrate specific use
 - **Educational resources** - Learn Mastra patterns through real implementations
 - **Quick starts** - Bootstrap projects faster than building from scratch
 
-## Using Templates
+## Using templates
 
 ### Installation
 
@@ -55,7 +55,7 @@ After installation:
 
 All templates follow this standardized structure:
 
-## Creating Templates
+## Creating templates
 
 ### Requirements
 
@@ -130,7 +130,7 @@ Templates must be:
 - **Single projects** - Not monorepos with multiple applications
 - **Framework-free** - No Next.js, Express, or other web framework boilerplate
 - **Mastra-focused** - Demonstrate Mastra functionality without additional layers
-- **Mergeable** - Structure code for easy integration into existing projects
+- **Mergeable** - Structure code for seamless integration into existing projects
 - **Node.js compatible** - Support Node.js v22.13.0 and later
 - **ESM modules** - Use ES modules (`"type": "module"` in package.json)
 
@@ -155,7 +155,7 @@ Detailed explanation of the template's functionality and use case.
 2. Install dependencies: `npm install`
 3. Run the project: `npm run dev`
 
-## Environment Variables
+## Environment variables
 
 - `OPENAI_API_KEY`: Your OpenAI API key. Get one at [OpenAI Platform](https://platform.openai.com/api-keys)
 - `ANTHROPIC_API_KEY`: Your Anthropic API key. Get one at [Anthropic Console](https://console.anthropic.com/settings/keys)

package/.docs/reference/tools/create-tool.md

@@ -73,7 +73,7 @@ The tool still returns the full `execute` result to your application, while the
 - `type: 'json'`
 - `type: 'content'` with parts like `text`, `image-url`, `image-data`, `file-url`, `file-data`, `file-id`, `image-file-id`, or `custom`
 
-## Example with MCP Annotations
+## Example with MCP annotations
 
 When exposing tools via MCP (Model Context Protocol), you can add annotations to describe tool behavior and customize how clients display the tool. These MCP-specific properties are grouped under the `mcp` property:
 
@@ -152,13 +152,13 @@ The `createTool()` function returns a `Tool` object.
 
 **Tool** (`object`): An object representing the defined tool, ready to be added to an agent.
 
-## Tool Lifecycle Hooks
+## Tool lifecycle hooks
 
 Tools support lifecycle hooks that allow you to monitor and react to different stages of tool execution. These hooks are particularly useful for logging, analytics, validation, and real-time updates during streaming.
 
 ### Available Hooks
 
-#### onInputStart
+#### `onInputStart`
 
 Called when tool call input streaming begins, before any input data is received.
 
@@ -172,7 +172,7 @@ export const tool = createTool({
 })
 ```
 
-#### onInputDelta
+#### `onInputDelta`
 
 Called for each incremental chunk of input text as it streams in. Useful for showing real-time progress or parsing partial JSON.
 
@@ -186,7 +186,7 @@ export const tool = createTool({
 })
 ```
 
-#### onInputAvailable
+#### `onInputAvailable`
 
 Called when the complete tool input is available and has been parsed and validated against the `inputSchema`.
 
@@ -204,7 +204,7 @@ export const tool = createTool({
 })
 ```
 
-#### onOutput
+#### `onOutput`
 
 Called after the tool has successfully executed and returned output. Useful for logging results, triggering follow-up actions, or analytics.
 
@@ -249,11 +249,11 @@ Additionally:
 - `onInputAvailable` receives `input`: The validated input data (typed according to `inputSchema`)
 - `onOutput` receives `output`: The tool's return value (typed according to `outputSchema`) and `toolName` (string): The name of the tool
 
-### Error Handling
+### Error handling
 
-Hook errors are caught and logged automatically, but do not prevent tool execution from continuing. If a hook throws an error, it will be logged to the console but will not fail the tool call.
+Hook errors are caught and logged automatically, but don't prevent tool execution from continuing. If a hook throws an error, it will be logged to the console but won't fail the tool call.
 
-## MCP Tool Annotations
+## MCP tool annotations
 
 When exposing tools via the Model Context Protocol (MCP), you can provide annotations that describe tool behavior. These annotations help MCP clients like OpenAI Apps SDK understand how to present and handle your tools.
 
@@ -266,7 +266,7 @@ mcp: {
 }
 ```
 
-### ToolAnnotations Properties
+### `ToolAnnotations` Properties
 
 **title** (`string`): A human-readable title for the tool. Used for display purposes in UI components.
 

package/.docs/reference/tools/document-chunker-tool.md

@@ -2,7 +2,7 @@
 
 The `createDocumentChunkerTool()` function creates a tool for splitting documents into smaller chunks for efficient processing and retrieval. It supports different chunking strategies and configurable parameters.
 
-## Basic Usage
+## Basic usage
 
 ```typescript
 import { createDocumentChunkerTool, MDocument } from '@mastra/rag'
@@ -31,7 +31,7 @@ const { chunks } = await chunker.execute()
 
 **params** (`ChunkParams`): Configuration parameters for chunking (Default: `Default chunking parameters`)
 
-### ChunkParams
+### `ChunkParams`
 
 **strategy** (`'recursive'`): The chunking strategy to use (Default: `'recursive'`)
 
@@ -45,7 +45,7 @@ const { chunks } = await chunker.execute()
 
 **chunks** (`DocumentChunk[]`): Array of document chunks with their content and metadata
 
-## Example with Custom Parameters
+## Example with custom parameters
 
 ```typescript
 const technicalDoc = new MDocument({
@@ -74,7 +74,7 @@ chunks.forEach((chunk, index) => {
 })
 ```
 
-## Tool Details
+## Tool details
 
 The chunker is created as a Mastra tool with the following properties:
 

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

@@ -2,7 +2,7 @@
 
 The `createGraphRAGTool()` creates a tool that enhances RAG by building a graph of semantic relationships between documents. It uses the `GraphRAG` system under the hood to provide graph-based retrieval, finding relevant content through both direct similarity and connected relationships.
 
-## Usage Example
+## Usage example
 
 ```typescript
 import { createGraphRAGTool } from '@mastra/rag'
@@ -61,7 +61,7 @@ The tool returns an object with:
 
 **sources** (`QueryResult[]`): Array of full retrieval result objects. Each object contains all information needed to reference the original document, chunk, and similarity score.
 
-### QueryResult object structure
+### `QueryResult` object structure
 
 ```typescript
 {
@@ -73,7 +73,7 @@ The tool returns an object with:
 }
 ```
 
-## Default Tool Description
+## Default tool description
 
 The default description focuses on:
 
@@ -81,7 +81,7 @@ The default description focuses on:
 - Finding patterns and connections
 - Answering complex queries
 
-## Advanced Example
+## Advanced example
 
 ```typescript
 const graphTool = createGraphRAGTool({
@@ -97,7 +97,7 @@ const graphTool = createGraphRAGTool({
 })
 ```
 
-## Example with Custom Description
+## Example with custom description
 
 ```typescript
 const graphTool = createGraphRAGTool({
@@ -111,7 +111,7 @@ const graphTool = createGraphRAGTool({
 
 This example shows how to customize the tool description for a specific use case while maintaining its core purpose of relationship analysis.
 
-## Example: Using Request Context
+## Example: Using request context
 
 ```typescript
 const graphTool = createGraphRAGTool({
@@ -147,7 +147,7 @@ For more information on request context, please see:
 - [Agent Request Context](https://mastra.ai/docs/server/request-context)
 - [Request Context](https://mastra.ai/docs/server/request-context)
 
-## Dynamic Vector Store for Multi-Tenant Applications
+## Dynamic vector store for multi-tenant applications
 
 For multi-tenant applications where each tenant has isolated data, you can pass a resolver function instead of a static vector store: