@mastra/mcp-docs-server 1.1.22-alpha.9 → 1.1.23-alpha.0

package/.docs/reference/browser/mastra-browser.md

@@ -0,0 +1,284 @@
+# MastraBrowser class
+
+The `MastraBrowser` class is the abstract base class for browser automation providers. It defines the common interface for launching browsers, managing thread isolation, streaming screencasts, and handling input events.
+
+You don't instantiate `MastraBrowser` directly. Instead, use a provider implementation:
+
+- [`AgentBrowser`](https://mastra.ai/reference/browser/agent-browser): Deterministic browser automation using refs
+- [`StagehandBrowser`](https://mastra.ai/reference/browser/stagehand-browser): AI-powered browser automation using natural language
+
+## Usage example
+
+```typescript
+import { Agent } from '@mastra/core/agent'
+import { AgentBrowser } from '@mastra/agent-browser'
+
+const browser = new AgentBrowser({
+  headless: true,
+  viewport: { width: 1280, height: 720 },
+  scope: 'thread',
+})
+
+export const browserAgent = new Agent({
+  name: 'browser-agent',
+  instructions: 'You can browse the web to find information.',
+  model: 'openai/gpt-5.4',
+  browser,
+})
+```
+
+## Constructor parameters
+
+**headless** (`boolean`): Whether to run the browser in headless mode (no visible UI). (Default: `true`)
+
+**viewport** (`{ width: number; height: number }`): Browser viewport dimensions. Controls the size of the browser window. (Default: `{ width: 1280, height: 720 }`)
+
+**timeout** (`number`): Default timeout in milliseconds for browser operations. (Default: `10000`)
+
+**cdpUrl** (`string | (() => string | Promise<string>)`): CDP WebSocket URL, HTTP endpoint, or sync/async provider function. When provided, connects to an existing browser instead of launching a new one. HTTP endpoints are resolved to WebSocket internally. Can't be used with scope: 'thread' (automatically uses shared scope).
+
+**scope** (`'shared' | 'thread'`): Browser instance scope across threads. 'shared' means all threads share a single browser instance. 'thread' means each thread gets its own browser instance (full isolation). (Default: `'thread' (or 'shared' when cdpUrl is provided)`)
+
+**onLaunch** (`(args: { browser: MastraBrowser }) => void | Promise<void>`): Callback invoked after the browser reaches 'ready' status.
+
+**onClose** (`(args: { browser: MastraBrowser }) => void | Promise<void>`): Callback invoked before the browser is closed.
+
+**screencast** (`ScreencastOptions`): Configuration for streaming browser frames.
+
+**screencast.format** (`'jpeg' | 'png'`): Image format for screencast frames.
+
+**screencast.quality** (`number`): Image quality (1-100). Only applies to JPEG format.
+
+**screencast.maxWidth** (`number`): Maximum width for screencast frames.
+
+**screencast.maxHeight** (`number`): Maximum height for screencast frames.
+
+**screencast.everyNthFrame** (`number`): Capture every Nth frame to reduce bandwidth.
+
+## Properties
+
+The following properties (`id`, `name`, `provider`) are abstract and must be defined by concrete provider implementations:
+
+**id** (`string`): Unique identifier for this browser instance. Abstract - defined by provider.
+
+**name** (`string`): Human-readable name of the browser provider (e.g., 'AgentBrowser', 'StagehandBrowser'). Abstract - defined by provider.
+
+**provider** (`string`): Provider identifier (e.g., 'vercel-labs/agent-browser', 'browserbase/stagehand'). Abstract - defined by provider.
+
+**headless** (`boolean`): Whether the browser is running in headless mode.
+
+**status** (`BrowserStatus`): Current browser status: 'pending', 'launching', 'ready', 'error', 'closing', or 'closed'.
+
+## Methods
+
+### Lifecycle
+
+#### `ensureReady()`
+
+Ensures the browser is launched and ready for use. Automatically called before tool execution. Implemented in the base class.
+
+```typescript
+await browser.ensureReady()
+```
+
+#### `close()`
+
+Closes the browser and cleans up all resources. Implemented in the base class with race-condition-safe handling.
+
+```typescript
+await browser.close()
+```
+
+#### `isBrowserRunning()`
+
+Checks if the browser is currently running.
+
+```typescript
+const isRunning = browser.isBrowserRunning()
+```
+
+**Returns:** `boolean`
+
+### Thread management
+
+#### `setCurrentThread(threadId)`
+
+Sets the current thread ID for browser operations. Used internally by the agent runtime.
+
+```typescript
+browser.setCurrentThread('thread-123')
+```
+
+#### `getCurrentThread()`
+
+Gets the current thread ID.
+
+```typescript
+const threadId = browser.getCurrentThread()
+```
+
+**Returns:** `string`
+
+#### `hasThreadSession(threadId)`
+
+Checks if a thread has an active browser session.
+
+```typescript
+const hasSession = browser.hasThreadSession('thread-123')
+```
+
+**Returns:** `boolean`
+
+#### `closeThreadSession(threadId)`
+
+Closes a specific thread's browser session. For 'thread' scope, this closes that thread's browser instance. For 'shared' scope, this clears the thread's state.
+
+```typescript
+await browser.closeThreadSession('thread-123')
+```
+
+### Tools
+
+#### `getTools()`
+
+Returns the browser tools for use with agents. Each provider returns different tools based on its paradigm.
+
+```typescript
+const tools = browser.getTools()
+```
+
+**Returns:** `Record<string, Tool>`
+
+### Screencast
+
+#### `startScreencast(options?, threadId?)`
+
+Starts streaming browser frames. Returns a `ScreencastStream` that emits frame events.
+
+```typescript
+const stream = await browser.startScreencast({ format: 'jpeg', quality: 80 }, 'thread-123')
+
+stream.on('frame', frame => {
+  console.log('Frame received:', frame.data.length, 'bytes')
+})
+
+stream.on('stop', reason => {
+  console.log('Screencast stopped:', reason)
+})
+```
+
+**Returns:** `Promise<ScreencastStream>`
+
+### Input injection
+
+#### `injectMouseEvent(params, threadId?)`
+
+Injects a mouse event into the browser. Used by Studio for live interaction.
+
+```typescript
+await browser.injectMouseEvent({
+  type: 'mousePressed',
+  x: 100,
+  y: 200,
+  button: 'left',
+  clickCount: 1,
+})
+```
+
+#### `injectKeyboardEvent(params, threadId?)`
+
+Injects a keyboard event into the browser. Used by Studio for live interaction.
+
+```typescript
+await browser.injectKeyboardEvent({
+  type: 'keyDown',
+  key: 'Enter',
+  code: 'Enter',
+})
+```
+
+### State
+
+#### `getState(threadId?)`
+
+Gets the current browser state including URL and tabs.
+
+```typescript
+const state = await browser.getState('thread-123')
+console.log('Current URL:', state.currentUrl)
+console.log('Tabs:', state.tabs)
+```
+
+**Returns:** `Promise<BrowserState>`
+
+```typescript
+interface BrowserState {
+  currentUrl: string | null
+  tabs: BrowserTabState[]
+  activeTabIndex: number
+}
+
+interface BrowserTabState {
+  id: string
+  url: string
+  title: string
+}
+```
+
+#### `getCurrentUrl(threadId?)`
+
+Gets the current page URL.
+
+```typescript
+const url = await browser.getCurrentUrl()
+```
+
+**Returns:** `Promise<string | null>`
+
+## Browser scope
+
+The `scope` option controls how browser instances are shared across conversation threads:
+
+| Scope      | Description                                 | Use case                                 |
+| ---------- | ------------------------------------------- | ---------------------------------------- |
+| `'shared'` | All threads share a single browser instance | Cost-efficient for non-conflicting tasks |
+| `'thread'` | Each thread gets its own browser instance   | Full isolation for concurrent users      |
+
+```typescript
+// Shared browser for all threads
+const sharedBrowser = new AgentBrowser({
+  scope: 'shared',
+})
+
+// Isolated browser per thread
+const isolatedBrowser = new AgentBrowser({
+  scope: 'thread',
+})
+```
+
+When using `cdpUrl` to connect to an external browser, the scope automatically falls back to `'shared'` since you can't spawn new browser instances.
+
+## Cloud browser providers
+
+Connect to cloud browser services using the `cdpUrl` option:
+
+```typescript
+// Static CDP URL
+const browser = new AgentBrowser({
+  cdpUrl: 'wss://browser.example.com/ws',
+})
+
+// Dynamic CDP URL (e.g., session-based)
+const browser = new AgentBrowser({
+  cdpUrl: async () => {
+    const session = await createBrowserSession()
+    return session.wsUrl
+  },
+})
+```
+
+## Related
+
+- [AgentBrowser](https://mastra.ai/reference/browser/agent-browser): Deterministic browser automation
+- [StagehandBrowser](https://mastra.ai/reference/browser/stagehand-browser): AI-powered browser automation
+- [Browser overview](https://mastra.ai/docs/browser/overview): Conceptual guide to browser automation

package/.docs/reference/browser/stagehand-browser.md

@@ -0,0 +1,290 @@
+# StagehandBrowser class
+
+The `StagehandBrowser` class provides AI-powered browser automation using [Stagehand](https://github.com/browserbase/stagehand). It uses natural language instructions for interactions instead of element refs.
+
+Use `StagehandBrowser` when you want AI to interpret and execute browser actions from natural language. For deterministic automation using element refs, see [`AgentBrowser`](https://mastra.ai/reference/browser/agent-browser).
+
+## Usage example
+
+```typescript
+import { Agent } from '@mastra/core/agent'
+import { StagehandBrowser } from '@mastra/stagehand'
+
+const browser = new StagehandBrowser({
+  headless: true,
+  model: 'openai/gpt-5.4',
+  selfHeal: true,
+})
+
+export const browserAgent = new Agent({
+  name: 'browser-agent',
+  instructions: `You can browse the web using natural language.
+Use stagehand_act to perform actions like "click the login button".
+Use stagehand_extract to get data from pages.`,
+  model: 'openai/gpt-5.4',
+  browser,
+})
+```
+
+## Constructor parameters
+
+**headless** (`boolean`): Whether to run the browser in headless mode. (Default: `true`)
+
+**viewport** (`{ width: number; height: number }`): Browser viewport dimensions. (Default: `{ width: 1280, height: 720 }`)
+
+**env** (`'LOCAL' | 'BROWSERBASE'`): Environment to run the browser in. Use 'BROWSERBASE' for cloud execution. (Default: `'LOCAL'`)
+
+**apiKey** (`string`): Browserbase API key. Required when env is 'BROWSERBASE'.
+
+**projectId** (`string`): Browserbase project ID. Required when env is 'BROWSERBASE'.
+
+**model** (`string | ModelConfiguration`): Model configuration for AI operations. Can be a string like 'openai/gpt-5.4' or an object with modelName, apiKey, and baseURL. (Default: `'openai/gpt-5.4'`)
+
+**selfHeal** (`boolean`): Enable self-healing selectors. When enabled, Stagehand uses AI to find elements even when initial selectors fail. (Default: `true`)
+
+**domSettleTimeout** (`number`): Timeout in milliseconds for DOM to settle after actions. (Default: `5000`)
+
+**verbose** (`0 | 1 | 2`): Logging verbosity level. 0 = silent, 1 = errors only, 2 = verbose. (Default: `1`)
+
+**systemPrompt** (`string`): Custom system prompt for AI operations.
+
+**cdpUrl** (`string | (() => string | Promise<string>)`): CDP WebSocket URL or HTTP endpoint for connecting to an existing browser. HTTP endpoints are resolved to WebSocket internally.
+
+**scope** (`'shared' | 'thread'`): Browser instance scope across threads. (Default: `'thread' (or 'shared' when cdpUrl is provided)`)
+
+**timeout** (`number`): Default timeout in milliseconds for browser operations. (Default: `10000`)
+
+**onLaunch** (`(args: { browser: MastraBrowser }) => void | Promise<void>`): Callback invoked after the browser is ready.
+
+**onClose** (`(args: { browser: MastraBrowser }) => void | Promise<void>`): Callback invoked before the browser closes.
+
+**screencast** (`ScreencastOptions`): Configuration for streaming browser frames to Studio.
+
+## Tools
+
+`StagehandBrowser` provides 6 AI-powered tools for browser automation:
+
+| Tool                 | Description                                         |
+| -------------------- | --------------------------------------------------- |
+| `stagehand_act`      | Perform actions using natural language instructions |
+| `stagehand_extract`  | Extract structured data from pages                  |
+| `stagehand_observe`  | Discover actionable elements on a page              |
+| `stagehand_navigate` | Navigate to a URL                                   |
+| `stagehand_tabs`     | Manage browser tabs                                 |
+| `stagehand_close`    | Close the browser                                   |
+
+## Tool reference
+
+### `stagehand_act`
+
+Perform an action using natural language instructions. The AI interprets your instruction and executes the appropriate browser action.
+
+```text
+// Tool input
+{
+  "instruction": "click the login button",
+  "variables": { "username": "john" },
+  "useVision": true,
+  "timeout": 30000
+}
+
+// With variable substitution
+{
+  "instruction": "type %email% into the email field",
+  "variables": { "email": "user@example.com" }
+}
+```
+
+| Parameter     | Type                     | Description                                          |
+| ------------- | ------------------------ | ---------------------------------------------------- |
+| `instruction` | `string`                 | Natural language instruction (required)              |
+| `variables`   | `Record<string, string>` | Variables for %variableName% substitution (optional) |
+| `useVision`   | `boolean`                | Enable vision capabilities (optional)                |
+| `timeout`     | `number`                 | Timeout in ms (optional)                             |
+
+**Returns:**
+
+```typescript
+interface ActResult {
+  success: boolean
+  message?: string
+  action?: string
+  url?: string
+}
+```
+
+### `stagehand_extract`
+
+Extract structured data from a page using natural language instructions.
+
+```text
+// Basic extraction
+{
+  "instruction": "extract all product names and prices"
+}
+
+// With schema for structured output
+{
+  "instruction": "extract the product information",
+  "schema": {
+    "type": "object",
+    "properties": {
+      "name": { "type": "string" },
+      "price": { "type": "number" },
+      "inStock": { "type": "boolean" }
+    }
+  }
+}
+```
+
+**Returns:**
+
+```typescript
+interface ExtractResult<T = unknown> {
+  success: boolean
+  data?: T
+  hint?: string
+  error?: string
+  url?: string
+}
+```
+
+### `stagehand_observe`
+
+Discover actionable elements on a page. Returns a list of elements with their selectors and descriptions.
+
+```text
+// Find specific elements
+{
+  "instruction": "find all buttons related to checkout"
+}
+
+// Find all interactive elements
+{
+  "onlyVisible": true
+}
+```
+
+| Parameter     | Type      | Description                                               |
+| ------------- | --------- | --------------------------------------------------------- |
+| `instruction` | `string`  | Natural language instruction (optional, omit to find all) |
+| `onlyVisible` | `boolean` | Only include visible elements (optional)                  |
+| `timeout`     | `number`  | Timeout in ms (optional)                                  |
+
+**Returns:**
+
+```typescript
+interface ObserveResult {
+  success: boolean
+  actions: StagehandAction[]
+  url?: string
+}
+
+interface StagehandAction {
+  selector: string
+  description: string
+  method?: string
+  arguments?: string[]
+}
+```
+
+### `stagehand_navigate`
+
+Navigate to a URL.
+
+```text
+// Tool input
+{
+  "url": "https://example.com",
+  "waitUntil": "domcontentloaded"
+}
+```
+
+| Parameter   | Type                                            | Description                                     |
+| ----------- | ----------------------------------------------- | ----------------------------------------------- |
+| `url`       | `string`                                        | URL to navigate to (required)                   |
+| `waitUntil` | `"load" \| "domcontentloaded" \| "networkidle"` | When to consider navigation complete (optional) |
+
+### `stagehand_tabs`
+
+Manage browser tabs.
+
+```text
+// List all tabs
+{ "action": "list" }
+
+// Open new tab
+{ "action": "new", "url": "https://example.com" }
+
+// Switch to tab by index
+{ "action": "switch", "index": 0 }
+
+// Close tab by index (or current if omitted)
+{ "action": "close", "index": 1 }
+```
+
+### `stagehand_close`
+
+Close the browser and clean up resources.
+
+```text
+// Tool input (no parameters required)
+
+```
+
+## Using Browserbase
+
+Run Stagehand in the cloud using Browserbase:
+
+```typescript
+const browser = new StagehandBrowser({
+  env: 'BROWSERBASE',
+  apiKey: process.env.BROWSERBASE_API_KEY,
+  projectId: process.env.BROWSERBASE_PROJECT_ID,
+  model: 'openai/gpt-5.4',
+})
+```
+
+## Model configuration
+
+Configure the AI model for Stagehand operations:
+
+```typescript
+// String format: "provider/model"
+const browser = new StagehandBrowser({
+  model: 'openai/gpt-5.4',
+})
+
+// Object format for custom configuration
+const browser = new StagehandBrowser({
+  model: {
+    modelName: 'gpt-5.4',
+    apiKey: process.env.OPENAI_API_KEY,
+    baseURL: 'https://api.openai.com/v1',
+  },
+})
+```
+
+Supported providers:
+
+- OpenAI: `"openai/gpt-5.4"`, `"openai/gpt-5.4-mini"`
+- Anthropic: `"anthropic/claude-3-5-sonnet-20241022"`
+
+## AgentBrowser vs StagehandBrowser
+
+| Aspect          | AgentBrowser               | StagehandBrowser      |
+| --------------- | -------------------------- | --------------------- |
+| **Approach**    | Deterministic refs (`@e5`) | Natural language      |
+| **Precision**   | Exact element targeting    | AI interpretation     |
+| **Flexibility** | Requires a snapshot first  | Direct instructions   |
+| **Use case**    | Reproducible automation    | Adaptive automation   |
+| **Speed**       | Faster (no AI inference)   | Slower (AI inference) |
+
+Choose `AgentBrowser` for precise, reproducible automation. Choose `StagehandBrowser` for flexible, natural language interactions.
+
+## Related
+
+- [MastraBrowser](https://mastra.ai/reference/browser/mastra-browser): Base class reference
+- [AgentBrowser](https://mastra.ai/reference/browser/agent-browser): Deterministic alternative
+- [Browser overview](https://mastra.ai/docs/browser/overview): Conceptual guide
+- [Stagehand guide](https://mastra.ai/docs/browser/stagehand): Usage guide

package/.docs/reference/index.md

@@ -39,6 +39,9 @@ The Reference section provides documentation of Mastra's API, including paramete
 - [Okta](https://mastra.ai/reference/auth/okta)
 - [Supabase](https://mastra.ai/reference/auth/supabase)
 - [WorkOS](https://mastra.ai/reference/auth/workos)
+- [AgentBrowser](https://mastra.ai/reference/browser/agent-browser)
+- [MastraBrowser Class](https://mastra.ai/reference/browser/mastra-browser)
+- [StagehandBrowser](https://mastra.ai/reference/browser/stagehand-browser)
 - [create-mastra](https://mastra.ai/reference/cli/create-mastra)
 - [mastra](https://mastra.ai/reference/cli/mastra)
 - [Agents API](https://mastra.ai/reference/client-js/agents)

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

@@ -0,0 +1,122 @@
+# ArthurExporter
+
+Sends Tracing data to [Arthur Engine](https://github.com/arthur-ai/arthur-engine) using OpenTelemetry and OpenInference semantic conventions.
+
+## Constructor
+
+```typescript
+new ArthurExporter(config: ArthurExporterConfig)
+```
+
+## `ArthurExporterConfig`
+
+```typescript
+type ArthurExporterConfig = Omit<OtelExporterConfig, 'provider' | 'exporter'> & {
+  apiKey?: string
+  endpoint?: string
+  taskId?: string
+  headers?: Record<string, string>
+}
+```
+
+Inherits from `OtelExporterConfig` (excluding `provider` and `exporter`), which includes:
+
+- `timeout?: number` - Export timeout in milliseconds (default: 30000)
+- `batchSize?: number` - Number of spans per batch (default: 512)
+- `logLevel?: LogLevel | 'debug' | 'info' | 'warn' | 'error'` - Log level (default: WARN)
+- `resourceAttributes?: Record<string, any>` - Custom resource attributes
+
+### Metadata passthrough
+
+Non-reserved span attributes are serialized into the OpenInference `metadata` payload. Add them via `tracingOptions.metadata` (e.g., `companyId`, `tier`). Reserved fields such as `input`, `output`, `sessionId`, thread/user IDs, and OpenInference IDs are excluded automatically.
+
+## Methods
+
+### `exportTracingEvent`
+
+```typescript
+async exportTracingEvent(event: TracingEvent): Promise<void>
+```
+
+Exports a tracing event to the configured endpoint.
+
+### export
+
+```typescript
+async export(spans: ReadOnlySpan[]): Promise<void>
+```
+
+Batch exports spans using OpenTelemetry with OpenInference semantic conventions.
+
+### flush
+
+```typescript
+async flush(): Promise<void>
+```
+
+Force flushes any buffered spans to the configured endpoint 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 client.
+
+## Usage
+
+### Zero-Config (using environment variables)
+
+```typescript
+import { ArthurExporter } from '@mastra/arthur'
+
+// Set ARTHUR_API_KEY and ARTHUR_BASE_URL (optionally ARTHUR_TASK_ID)
+const exporter = new ArthurExporter()
+```
+
+### Explicit Configuration
+
+```typescript
+import { ArthurExporter } from '@mastra/arthur'
+
+const exporter = new ArthurExporter({
+  apiKey: process.env.ARTHUR_API_KEY!,
+  endpoint: 'http://localhost:3030',
+  taskId: process.env.ARTHUR_TASK_ID, // Optional
+})
+```
+
+## `OpenInference` semantic conventions
+
+The ArthurExporter implements [OpenInference Semantic Conventions](https://github.com/Arize-ai/openinference/tree/main/spec) for generative AI applications, providing standardized trace structure across different observability platforms.
+
+## Tags support
+
+The ArthurExporter supports trace tagging for categorization and filtering. Tags are only applied to root spans and are mapped to the native OpenInference `tag.tags` semantic convention.
+
+### Usage
+
+```typescript
+const result = await agent.generate('Hello', {
+  tracingOptions: {
+    tags: ['production', 'experiment-v2', 'user-request'],
+  },
+})
+```
+
+### How Tags Are Stored
+
+Tags are stored using the OpenInference `tag.tags` attribute:
+
+```json
+{
+  "tag.tags": ["production", "experiment-v2", "user-request"]
+}
+```
+
+## Related
+
+- [ArthurExporter Documentation](https://mastra.ai/docs/observability/tracing/exporters/arthur)
+- [Arthur Engine documentation](https://docs.arthur.ai/)
+- [Arthur Engine repository](https://github.com/arthur-ai/arthur-engine)