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

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

@@ -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
 
@@ -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 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:
 

package/.docs/reference/tools/mcp-client.md

@@ -22,7 +22,7 @@ constructor({
 
 **timeout** (`number`): Global timeout value in milliseconds for all servers unless overridden in individual server configs. (Default: `60000`)
 
-### MastraMCPServerDefinition
+### `MastraMCPServerDefinition`
 
 Each server in the `servers` map is configured using the `MastraMCPServerDefinition` type. The transport type is detected based on the provided parameters:
 
@@ -55,7 +55,7 @@ Each server in the `servers` map is configured using the `MastraMCPServerDefinit
 
 ## Methods
 
-### listTools()
+### `listTools()`
 
 Retrieves all tools from all configured servers, with tool names namespaced by their server name (in the format `serverName_toolName`) to prevent conflicts. Intended to be passed onto an Agent definition.
 
@@ -63,7 +63,7 @@ Retrieves all tools from all configured servers, with tool names namespaced by t
 new Agent({ id: 'agent', tools: await mcp.listTools() })
 ```
 
-### listToolsets()
+### `listToolsets()`
 
 Returns an object mapping namespaced tool names (in the format `serverName.toolName`) to their tool implementations. Intended to be passed dynamically into the generate or stream method.
 
@@ -73,7 +73,7 @@ const res = await agent.stream(prompt, {
 })
 ```
 
-### disconnect()
+### `disconnect()`
 
 Disconnects from all MCP servers and cleans up resources.
 
@@ -239,7 +239,7 @@ mcpClient.elicitation.onRequest('serverName', async request => {
 
 Sets up a handler function that will be called when any connected MCP server sends an elicitation request. The handler receives the request and must return a response.
 
-##### ElicitationHandler Function
+##### `ElicitationHandler` Function
 
 The handler function receives a request object with:
 
@@ -534,7 +534,7 @@ mcpClient.elicitation.onRequest('interactiveServer', async request => {
 })
 ```
 
-### Response Types
+### Response types
 
 Your elicitation handler must return one of three response types:
 
@@ -592,7 +592,7 @@ await mcpClient.elicitation.onRequest('interactiveServer', async request => {
 })
 ```
 
-### Best Practices
+### Best practices
 
 - **Always handle elicitation**: Set up your handler before calling tools that might use elicitation
 - **Validate input**: Check that required fields are provided
@@ -600,7 +600,7 @@ await mcpClient.elicitation.onRequest('interactiveServer', async request => {
 - **Clear UI**: Make it obvious what information is being requested and why
 - **Security**: Never auto-accept requests for sensitive information
 
-## OAuth Authentication
+## OAuth authentication
 
 For connecting to MCP servers that require OAuth authentication per the [MCP Auth Specification](https://modelcontextprotocol.io/specification/2025-06-18/basic/authorization), use the `MCPOAuthClientProvider`:
 
@@ -819,7 +819,7 @@ const response = await agent.stream('How is AAPL doing and what is the weather?'
 })
 ```
 
-## Instance Management
+## Instance management
 
 The `MCPClient` class includes built-in memory leak prevention for managing multiple instances:
 
@@ -863,7 +863,7 @@ const mcp4 = new MCPClient({
 })
 ```
 
-## Server Lifecycle
+## Server lifecycle
 
 MCPClient handles server connections gracefully:
 
@@ -871,7 +871,7 @@ MCPClient handles server connections gracefully:
 2. Graceful server shutdown to prevent error messages during development
 3. Proper cleanup of resources when disconnecting
 
-## Using Custom Fetch for Dynamic Authentication
+## Using custom fetch for dynamic authentication
 
 For HTTP servers, you can provide a custom `fetch` function to handle dynamic authentication, request interception, or other custom behavior. This is particularly useful when you need to refresh tokens on each request or forward user credentials from the incoming request to the MCP server.
 
@@ -910,7 +910,7 @@ await agent.generate('Hello!', {
 })
 ```
 
-## Using SSE Request Headers
+## Using SSE request headers
 
 When using the legacy SSE MCP transport, you must configure both `requestInit` and `eventSourceInit` due to a bug in the MCP SDK. Alternatively, you can use a custom `fetch` function which will be automatically used for both POST requests and SSE connections:
 
@@ -959,7 +959,7 @@ const sseClientWithFetch = new MCPClient({
 })
 ```
 
-## Related Information
+## Related information
 
 - For creating MCP servers, see the [MCPServer documentation](https://mastra.ai/reference/tools/mcp-server).
 - For more about the Model Context Protocol, see the [@modelcontextprotocol/sdk documentation](https://github.com/modelcontextprotocol/typescript-sdk).

package/.docs/reference/tools/mcp-server.md

@@ -83,7 +83,7 @@ The constructor accepts an `MCPServerConfig` object with the following propertie
 
 **prompts** (`MCPServerPrompts`): An object defining how the server should handle MCP prompts. See Prompt Handling section for details.
 
-## Exposing Agents as Tools
+## Exposing agents as tools
 
 A powerful feature of `MCPServer` is its ability to automatically expose your Mastra Agents as callable tools. When you provide agents in the `agents` property of the configuration:
 
@@ -164,7 +164,7 @@ const fetchUserData = createTool({
 
 These are the functions you can call on an `MCPServer` instance to control its behavior and get information.
 
-### startStdio()
+### `startStdio()`
 
 Use this method to start the server so it communicates using standard input and output (stdio). This is typical when running the server as a command-line program.
 
@@ -186,7 +186,7 @@ const server = new MCPServer({
 await server.startStdio()
 ```
 
-### startSSE()
+### `startSSE()`
 
 This method helps you integrate the MCP server with an existing web server to use Server-Sent Events (SSE) for communication. You'll call this from your web server's code when it receives a request for the SSE or message paths.
 
@@ -238,7 +238,7 @@ Here are the details for the values needed by the `startSSE` method:
 
 **res** (`any`): The response object from your web server, used to send data back.
 
-### startHonoSSE()
+### `startHonoSSE()`
 
 This method helps you integrate the MCP server with an existing web server to use Server-Sent Events (SSE) for communication. You'll call this from your web server's code when it receives a request for the SSE or message paths.
 
@@ -290,7 +290,7 @@ Here are the details for the values needed by the `startHonoSSE` method:
 
 **res** (`any`): The response object from your web server, used to send data back.
 
-### startHTTP()
+### `startHTTP()`
 
 This method helps you integrate the MCP server with an existing web server to use streamable HTTP for communication. You'll call this from your web server's code when it receives HTTP requests.
 
@@ -424,7 +424,7 @@ The `StreamableHTTPServerTransportOptions` object allows you to customize the be
 
 **eventStore** (`EventStore`): An event store for message resumability. Providing this enables clients to reconnect and resume message streams.
 
-### close()
+### `close()`
 
 This method closes the server and releases all resources.
 
@@ -432,7 +432,7 @@ This method closes the server and releases all resources.
 async close(): Promise<void>
 ```
 
-### getServerInfo()
+### `getServerInfo()`
 
 This method gives you a look at the server's basic information.
 
@@ -440,7 +440,7 @@ This method gives you a look at the server's basic information.
 getServerInfo(): ServerInfo
 ```
 
-### getServerDetail()
+### `getServerDetail()`
 
 This method gives you a detailed look at the server's information.
 
@@ -448,7 +448,7 @@ This method gives you a detailed look at the server's information.
 getServerDetail(): ServerDetail
 ```
 
-### getToolListInfo()
+### `getToolListInfo()`
 
 This method gives you a look at the tools that were set up when you created the server. It's a read-only list, useful for debugging purposes.
 
@@ -456,7 +456,7 @@ This method gives you a look at the tools that were set up when you created the
 getToolListInfo(): ToolListInfo
 ```
 
-### getToolInfo()
+### `getToolInfo()`
 
 This method gives you detailed information about a specific tool.
 
@@ -464,7 +464,7 @@ This method gives you detailed information about a specific tool.
 getToolInfo(toolName: string): ToolInfo
 ```
 
-### executeTool()
+### `executeTool()`
 
 This method executes a specific tool and returns the result.
 
@@ -472,7 +472,7 @@ This method executes a specific tool and returns the result.
 executeTool(toolName: string, input: any): Promise<any>
 ```
 
-### getStdioTransport()
+### `getStdioTransport()`
 
 If you started the server with `startStdio()`, you can use this to get the object that manages the stdio communication. This is mostly for checking things internally or for testing.
 
@@ -480,7 +480,7 @@ If you started the server with `startStdio()`, you can use this to get the objec
 getStdioTransport(): StdioServerTransport | undefined
 ```
 
-### getSseTransport()
+### `getSseTransport()`
 
 If you started the server with `startSSE()`, you can use this to get the object that manages the SSE communication. Like `getStdioTransport`, this is mainly for internal checks or testing.
 
@@ -488,7 +488,7 @@ If you started the server with `startSSE()`, you can use this to get the object
 getSseTransport(): SSEServerTransport | undefined
 ```
 
-### getSseHonoTransport()
+### `getSseHonoTransport()`
 
 If you started the server with `startHonoSSE()`, you can use this to get the object that manages the SSE communication. Like `getSseTransport`, this is mainly for internal checks or testing.
 
@@ -496,7 +496,7 @@ If you started the server with `startHonoSSE()`, you can use this to get the obj
 getSseHonoTransport(): SSETransport | undefined
 ```
 
-### getStreamableHTTPTransport()
+### `getStreamableHTTPTransport()`
 
 If you started the server with `startHTTP()`, you can use this to get the object that manages the HTTP communication. Like `getSseTransport`, this is mainly for internal checks or testing.
 
@@ -504,7 +504,7 @@ If you started the server with `startHTTP()`, you can use this to get the object
 getStreamableHTTPTransport(): StreamableHTTPServerTransport | undefined
 ```
 
-### tools()
+### `tools()`
 
 Executes a specific tool provided by this MCP server.
 
@@ -522,7 +522,7 @@ async executeTool(
 
 **executionContext** (`object`): Optional context for the tool execution, like messages or a toolCallId.
 
-## Resource Handling
+## Resource handling
 
 ### What are MCP Resources?
 
@@ -649,7 +649,7 @@ Example:
 await serverWithResources.resources.notifyListChanged()
 ```
 
-## Prompt Handling
+## Prompt handling
 
 ### What are MCP Prompts?
 
@@ -758,7 +758,7 @@ Call this method when the overall list of available prompts has changed (e.g., a
 await serverWithPrompts.prompts.notifyListChanged()
 ```
 
-### Best Practices for Prompt Handling
+### Best practices for Prompt Handling
 
 - Use clear, descriptive prompt names and descriptions.
 - Validate all required arguments in `getPromptMessages`.
@@ -982,7 +982,7 @@ type ElicitResult = {
 }
 ```
 
-## OAuth Protection
+## OAuth protection
 
 To protect your MCP server with OAuth authentication per the [MCP Auth Specification](https://modelcontextprotocol.io/specification/2025-06-18/basic/authorization), use the `createOAuthMiddleware` function:
 
@@ -1085,11 +1085,11 @@ const customMiddleware = createOAuthMiddleware({
 
 **mcpPath** (`string`): Path where the MCP endpoint is served. Only requests to this path require authentication. (Default: `'/mcp'`)
 
-## Authentication Context
+## Authentication context
 
 Tools can access request metadata via `context.mcp.extra` when using HTTP-based transports. This allows you to pass authentication info, user context, or any custom data from your HTTP middleware to your MCP tools.
 
-### How It Works
+### How it works
 
 Whatever you set on `req.auth` in your HTTP middleware becomes available as `context.mcp.extra.authInfo` in your tools:
 
@@ -1265,7 +1265,7 @@ app.all('/mcp', async (req, res) => {
 app.listen(3000)
 ```
 
-## Related Information
+## Related information
 
 - For connecting to MCP servers in Mastra, see the [MCPClient documentation](https://mastra.ai/reference/tools/mcp-client).
 - For more about the Model Context Protocol, see the [@modelcontextprotocol/sdk documentation](https://github.com/modelcontextprotocol/typescript-sdk).

package/.docs/reference/tools/vector-query-tool.md

@@ -2,7 +2,7 @@
 
 The `createVectorQueryTool()` function creates a tool for semantic search over vector stores. It supports filtering, reranking, database-specific configurations, and integrates with various vector store backends.
 
-## Basic Usage
+## Basic usage
 
 ```typescript
 import { createVectorQueryTool } from '@mastra/rag'
@@ -79,7 +79,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
 {
@@ -91,7 +91,7 @@ The tool returns an object with:
 }
 ```
 
-## Default Tool Description
+## Default tool description
 
 The default description focuses on:
 
@@ -99,11 +99,11 @@ The default description focuses on:
 - Answering user questions
 - Retrieving factual content
 
-## Result Handling
+## Result handling
 
 The tool determines the number of results to return based on the user's query, with a default of 10 results. This can be adjusted based on the query requirements.
 
-## Example with Filters
+## Example with filters
 
 ```typescript
 const queryTool = createVectorQueryTool({
@@ -134,7 +134,7 @@ For detailed filter syntax and store-specific capabilities, see the [Metadata Fi
 
 For an example of how agent-driven filtering works, see the [Agent-Driven Metadata Filtering](https://github.com/mastra-ai/mastra/tree/main/examples/basics/rag/filter-rag) example.
 
-## Example with Reranking
+## Example with reranking
 
 ```typescript
 const queryTool = createVectorQueryTool({
@@ -164,7 +164,7 @@ Reranking improves result quality by combining:
 
 The reranker processes the initial vector search results and returns a reordered list optimized for relevance.
 
-## Example with Custom Description
+## Example with custom description
 
 ```typescript
 const queryTool = createVectorQueryTool({
@@ -178,7 +178,7 @@ const queryTool = createVectorQueryTool({
 
 This example shows how to customize the tool description for a specific use case while maintaining its core purpose of information retrieval.
 
-## Database-Specific Configuration Examples
+## Database-specific configuration examples
 
 The `databaseConfig` parameter allows you to leverage unique features and optimizations specific to each vector database. These configurations are automatically applied during query execution.
 
@@ -335,7 +335,7 @@ This approach allows you to:
 - Adjust performance parameters based on load
 - Apply different filtering strategies per request
 
-## Example: Using Request Context
+## Example: Using request context
 
 ```typescript
 const queryTool = createVectorQueryTool({
@@ -374,7 +374,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)
 
-## Usage Without a Mastra Server
+## Usage without a Mastra server
 
 The tool can be used by itself to retrieve documents matching a query:
 
@@ -401,7 +401,7 @@ const queryResult = await vectorQueryTool.execute({ queryText: 'foo', topK: 1 },
 console.log(queryResult.sources)
 ```
 
-## Dynamic Vector Store for Multi-Tenant Applications
+## Dynamic vector store for multi-tenant applications
 
 For multi-tenant applications where each tenant has isolated data (e.g., separate PostgreSQL schemas), you can pass a resolver function instead of a static vector store instance. The function receives the request context and can return the appropriate vector store for the current tenant:
 
@@ -457,7 +457,7 @@ This pattern is similar to how `Agent.memory` supports dynamic configuration and
 - **Database isolation**: Route to different database instances per tenant
 - **Dynamic configuration**: Adjust vector store settings based on request context
 
-## Tool Details
+## Tool details
 
 The tool is created with: