@mastra/mcp-docs-server 1.1.42-alpha.8 → 1.1.43-alpha.0

package/.docs/reference/agents/durable-agent.md

@@ -0,0 +1,239 @@
+# DurableAgent
+
+`DurableAgent` wraps an existing [`Agent`](https://mastra.ai/reference/agents/agent) with durable execution and resumable streams. It runs the agentic loop so that a client can disconnect and reconnect without missing events, and it streams those events over [PubSub](https://mastra.ai/docs/server/pubsub). Use it when a run must outlive a single request or survive a dropped connection.
+
+Create one with the [`createDurableAgent`](#createdurableagentoptions) factory, or use [`createEventedAgent`](#createeventedagentoptions) for fire-and-forget execution on the built-in workflow engine. For Inngest-powered execution, use `createInngestAgent` from `@mastra/inngest`.
+
+## Usage example
+
+```typescript
+import { Mastra } from '@mastra/core'
+import { Agent } from '@mastra/core/agent'
+import { createDurableAgent } from '@mastra/core/agent/durable'
+
+const agent = new Agent({
+  id: 'my-agent',
+  name: 'My Agent',
+  instructions: 'You are a helpful assistant',
+  model: 'openai/gpt-5.5',
+})
+
+const durableAgent = createDurableAgent({ agent })
+
+export const mastra = new Mastra({
+  agents: { myAgent: durableAgent },
+})
+```
+
+Stream a response and read the result. The `cleanup` function unsubscribes from PubSub when you are done with the run:
+
+```typescript
+const { output, runId, cleanup } = await durableAgent.stream('Hello!')
+
+const text = await output.text
+
+cleanup()
+```
+
+## `createDurableAgent(options)`
+
+Wraps an `Agent` with durable execution and resumable streams. This is the recommended way to create a `DurableAgent`.
+
+```typescript
+import { createDurableAgent } from '@mastra/core/agent/durable'
+
+const durableAgent = createDurableAgent({ agent })
+```
+
+Returns: `DurableAgent`
+
+### Parameters
+
+**agent** (`Agent`): The Agent to wrap with durable execution capabilities. Agent methods delegate to this agent.
+
+**id** (`string`): ID override. (Default: `agent.id`)
+
+**name** (`string`): Name override. (Default: `agent.name`)
+
+**cache** (`MastraServerCache | false`): Cache for stored stream events, which enables resumable streams. If omitted, the agent inherits the cache from the Mastra instance, or uses an InMemoryServerCache. Set to \`false\` to disable caching, which makes streams non-resumable.
+
+**pubsub** (`PubSub`): PubSub instance for streaming events. (Default: `EventEmitterPubSub`)
+
+**maxSteps** (`number`): Maximum number of steps for the agentic loop.
+
+## `createEventedAgent(options)`
+
+Wraps an `Agent` with fire-and-forget durable execution on the built-in workflow engine. Like `createDurableAgent`, it returns a result you stream from, but the underlying workflow runs non-blocking (via `startAsync`) instead of running to completion before the stream is wired up. Use it when you want the run to progress independently of the caller. It does not accept `id` or `name` overrides.
+
+```typescript
+import { createEventedAgent } from '@mastra/core/agent/durable'
+
+const eventedAgent = createEventedAgent({ agent })
+```
+
+Returns: `EventedAgent` (a subclass of `DurableAgent`)
+
+### Parameters
+
+**agent** (`Agent`): The Agent to wrap with evented durable execution capabilities.
+
+**cache** (`MastraServerCache | false`): Cache for stored stream events, which enables resumable streams. If omitted, the agent inherits the cache from the Mastra instance, or uses an InMemoryServerCache. Set to \`false\` to disable caching.
+
+**pubsub** (`PubSub`): PubSub instance for streaming events. (Default: `EventEmitterPubSub`)
+
+**maxSteps** (`number`): Maximum number of steps for the agentic loop.
+
+## Constructor parameters
+
+The `DurableAgent` class accepts the same options as `createDurableAgent`, plus `cleanupTimeoutMs`. Prefer the factory unless you need to subclass.
+
+**agent** (`Agent`): The Agent to wrap with durable execution capabilities.
+
+**id** (`string`): ID override. (Default: `agent.id`)
+
+**name** (`string`): Name override. (Default: `agent.name`)
+
+**cache** (`MastraServerCache | false`): Cache for stored stream events. If omitted, inherits from the Mastra instance or uses an InMemoryServerCache. Set to \`false\` to disable caching.
+
+**pubsub** (`PubSub`): PubSub instance for streaming events. (Default: `EventEmitterPubSub`)
+
+**maxSteps** (`number`): Maximum number of steps for the agentic loop.
+
+**cleanupTimeoutMs** (`number`): Grace period in milliseconds before registry entries are cleaned up automatically after a stream finishes or errors. Set to 0 to disable auto-cleanup and require a manual \`cleanup()\` call. Auto-cleanup does not fire on suspended events. (Default: `30000`)
+
+## Methods
+
+### Execution
+
+#### `stream(messages, options?)`
+
+Streams a response using durable execution. Returns immediately with a result whose `output` produces events as the run progresses.
+
+```typescript
+const { output, runId, cleanup } = await durableAgent.stream('Hello!', {
+  onChunk: chunk => console.log(chunk),
+  onFinish: result => console.log('done', result),
+})
+
+const text = await output.text
+cleanup()
+```
+
+Returns: [`Promise<DurableAgentStreamResult>`](#durableagentstreamresult)
+
+#### `resume(runId, resumeData, options?)`
+
+Resumes a suspended run, for example after a tool approval. Pass the `runId` from the original stream and the data the run was waiting on. Throws if no registry entry exists for the run.
+
+```typescript
+const { output, cleanup } = await durableAgent.resume(runId, {
+  approved: true,
+})
+
+await output.text
+cleanup()
+```
+
+Returns: [`Promise<DurableAgentStreamResult>`](#durableagentstreamresult)
+
+#### `observe(runId, options?)`
+
+Reconnects to an existing run, replaying cached events before delivering live ones. Use this after a network disconnection. Pass `offset` to start replay from a known position.
+
+```typescript
+const { output, cleanup } = await durableAgent.observe(runId, {
+  offset: 0,
+  onChunk: chunk => console.log(chunk),
+})
+
+await output.text
+```
+
+Returns: `Promise<DurableAgentStreamResult>`
+
+> **Warning:** The `cleanup()` returned by `observe()` destroys the run's registry entries and cached events. Only call it when you are done with the run. If the run is suspended and you intend to resume later, do not call `cleanup()` — let the auto-cleanup timer handle it after the run finishes or errors. Auto-cleanup does not fire on suspended events.
+
+## Stream options
+
+`stream()` accepts a `DurableAgentStreamOptions` object. It supports the agent execution options below, plus lifecycle callbacks.
+
+**runId** (`string`): Unique identifier for this run. Use it later with \`resume()\` or \`observe()\`.
+
+**instructions** (`AgentExecutionOptions['instructions']`): Overrides the agent's default instructions for this run. Accepts a static string or the same dynamic instructions value the agent supports.
+
+**context** (`ModelMessage[]`): Additional context messages to provide to the agent.
+
+**memory** (`object`): Memory configuration for conversation persistence and retrieval.
+
+**requestContext** (`RequestContext`): Request context carrying dynamic configuration and state for this run.
+
+**maxSteps** (`number`): Maximum number of steps to run for this stream.
+
+**toolsets** (`object`): Additional tool sets available for this run.
+
+**clientTools** (`object`): Client-side tools available during execution.
+
+**toolChoice** (`'auto' | 'none' | 'required' | { type: 'tool'; toolName: string }`): Tool selection strategy.
+
+**activeTools** (`string[]`): Restricts execution to the named subset of the agent's tools.
+
+**modelSettings** (`object`): Model-specific settings such as temperature.
+
+**requireToolApproval** (`boolean`): Require approval for all tool calls, which suspends the run until resumed.
+
+**autoResumeSuspendedTools** (`boolean`): Automatically resume tools that suspended, instead of waiting for an external \`resume()\` call.
+
+**toolCallConcurrency** (`number`): Maximum number of tool calls to execute concurrently.
+
+**includeRawChunks** (`boolean`): Include raw provider chunks in the stream output.
+
+**maxProcessorRetries** (`number`): Maximum number of processor retries per generation.
+
+**structuredOutput** (`object`): Structured output configuration.
+
+**versions** (`object`): Version overrides for sub-agent delegation.
+
+**onChunk** (`(chunk: ChunkType) => void | Promise<void>`): Called for each streamed chunk.
+
+**onStepFinish** (`(result: AgentStepFinishEventData) => void | Promise<void>`): Called when a step in the agentic loop finishes.
+
+**onFinish** (`(result: AgentFinishEventData) => void | Promise<void>`): Called when the run finishes.
+
+**onError** (`(error: Error) => void | Promise<void>`): Called when the run errors.
+
+**onSuspended** (`(data: AgentSuspendedEventData) => void | Promise<void>`): Called when the run suspends, for example for tool approval.
+
+`resume()` and `observe()` accept the same lifecycle callbacks (`onChunk`, `onStepFinish`, `onFinish`, `onError`, `onSuspended`). `observe()` also accepts an `offset` to control where replay starts.
+
+## DurableAgentStreamResult
+
+The object returned by `stream()`, `resume()`, and `observe()`.
+
+```typescript
+interface DurableAgentStreamResult<OUTPUT = undefined> {
+  output: MastraModelOutput<OUTPUT>
+  readonly fullStream: ReadableStream<any>
+  runId: string
+  threadId?: string
+  resourceId?: string
+  cleanup: () => void
+}
+```
+
+**output** (`MastraModelOutput`): The streaming output. Await \`output.text\` for the full text, or consume \`output.fullStream\`.
+
+**fullStream** (`ReadableStream`): The full event stream, delegating to \`output.fullStream\`.
+
+**runId** (`string`): The unique run ID. Pass it to \`resume()\` or \`observe()\` to reconnect.
+
+**threadId** (`string`): Thread ID when using memory.
+
+**resourceId** (`string`): Resource ID when using memory.
+
+**cleanup** (`() => void`): Unsubscribes from PubSub and clears registry entries for the run. Call it when done with the run.
+
+## Related
+
+- [Agent class](https://mastra.ai/reference/agents/agent)
+- [PubSub](https://mastra.ai/docs/server/pubsub)
+- [`.getMemory()`](https://mastra.ai/reference/agents/getMemory)

package/.docs/reference/agents/generateLegacy.md

@@ -195,7 +195,7 @@ await agent.generateLegacy(
         sentiment: z.enum(['positive', 'negative', 'neutral']),
         confidence: z.number(),
       }),
-      model: 'openai/gpt-5.4',
+      model: 'openai/gpt-5.5',
       errorStrategy: 'warn',
     },
     // Output processors for response validation

package/.docs/reference/agents/getLLM.md

@@ -10,7 +10,7 @@ await agent.getLLM()
 
 ```typescript
 await agent.getLLM({
-  model: 'openai/gpt-5.4',
+  model: 'openai/gpt-5.5',
 })
 ```
 
@@ -31,7 +31,7 @@ await agent.getLLM({
 ```typescript
 await agent.getLLM({
   requestContext: new RequestContext(),
-  model: 'openai/gpt-5.4',
+  model: 'openai/gpt-5.5',
 })
 ```
 

package/.docs/reference/agents/getMetadata.md

@@ -29,7 +29,7 @@ export const supportAgent = new Agent({
   id: 'support-agent',
   name: 'Support Agent',
   instructions: 'You help customers with support requests.',
-  model: 'openai/gpt-5.4',
+  model: 'openai/gpt-5.5',
   metadata: { type: 'support' },
 })
 
@@ -45,7 +45,7 @@ export const supportAgent = new Agent({
   id: 'support-agent',
   name: 'Support Agent',
   instructions: 'You help customers with support requests.',
-  model: 'openai/gpt-5.4',
+  model: 'openai/gpt-5.5',
   metadata: ({ requestContext }) => ({
     type: 'support',
     tenant: requestContext.get('tenant'),

package/.docs/reference/agents/network.md

@@ -16,7 +16,7 @@ const agent = new Agent({
   id: 'network-agent',
   name: 'Network Agent',
   instructions: 'You are a network agent that can help users with a variety of tasks.',
-  model: 'openai/gpt-5.4',
+  model: 'openai/gpt-5.5',
   agents: {
     agent1,
     agent2,

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

@@ -21,7 +21,7 @@ export const browserAgent = new Agent({
   name: 'Browser Agent',
   instructions: `You can browse the web. Use browser_snapshot to see the page structure,
 then interact with elements using their refs (e.g., @e5).`,
-  model: 'openai/gpt-5.4',
+  model: 'openai/gpt-5.5',
   browser,
 })
 ```

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

@@ -23,7 +23,7 @@ const workspace = new Workspace({
 
 const browserAgent = new Agent({
   id: 'browser-agent',
-  model: 'openai/gpt-5.4',
+  model: 'openai/gpt-5.5',
   workspace,
   instructions: 'You are a web automation assistant.',
 })

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

@@ -24,7 +24,7 @@ export const browserAgent = new Agent({
   id: 'browser-agent',
   name: 'Browser Agent',
   instructions: 'You can browse the web to find information.',
-  model: 'openai/gpt-5.4',
+  model: 'openai/gpt-5.5',
   browser,
 })
 ```

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

@@ -12,7 +12,7 @@ import { StagehandBrowser } from '@mastra/stagehand'
 
 const browser = new StagehandBrowser({
   headless: true,
-  model: 'openai/gpt-5.4',
+  model: 'openai/gpt-5.5',
   selfHeal: true,
 })
 
@@ -22,7 +22,7 @@ export const browserAgent = new 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',
+  model: 'openai/gpt-5.5',
   browser,
 })
 ```
@@ -39,7 +39,7 @@ Use stagehand_extract to get data from pages.`,
 
 **projectId** (`string`): Browserbase project ID. Required when env is 'BROWSERBASE'.
 
-**model** (`string | ModelConfiguration`): Model configuration for AI operations. Can be a string like '\_\_GATEWAY\_OPENAI\_MODEL\_\_' or an object with modelName, apiKey, and baseURL. (Default: `'openai/gpt-5.4'`)
+**model** (`string | ModelConfiguration`): Model configuration for AI operations. Can be a string like 'openai/gpt-5.5' or an object with modelName, apiKey, and baseURL. (Default: `'openai/gpt-5.5'`)
 
 **selfHeal** (`boolean`): Enable self-healing selectors. When enabled, Stagehand uses AI to find elements even when initial selectors fail. (Default: `true`)
 
@@ -268,7 +268,7 @@ const browser = new StagehandBrowser({
   env: 'BROWSERBASE',
   apiKey: process.env.BROWSERBASE_API_KEY,
   projectId: process.env.BROWSERBASE_PROJECT_ID,
-  model: 'openai/gpt-5.4',
+  model: 'openai/gpt-5.5',
 })
 ```
 
@@ -279,7 +279,7 @@ Configure the AI model for Stagehand operations:
 ```typescript
 // String format: "provider/model"
 const browser = new StagehandBrowser({
-  model: 'openai/gpt-5.4',
+  model: 'openai/gpt-5.5',
 })
 
 // Object format for custom configuration

package/.docs/reference/cli/mastra.md

@@ -603,10 +603,10 @@ It accepts [common flags](#common-flags).
 Calls a Mastra runtime server with JSON input and JSON output. Use it for local development servers, deployed Mastra platform projects, self-hosted Mastra servers, or hosted Mastra Platform Observability APIs.
 
 ```bash
-mastra api agent list --pretty
+mastra api agent list
 mastra api agent run weather-agent '{"messages":"What is the weather in London?"}'
 mastra api tool execute get-weather '{"location":"San Francisco"}'
-mastra api trace list '{"page":0,"perPage":20}' --pretty
+mastra api trace list '{"page":0,"perPage":20}'
 ```
 
 Use `mastra api <resource> <action> --help` to see examples for a command.
@@ -717,7 +717,7 @@ mastra api trace list '{"page":0,"perPage":20}'
 Routes that support filters accept them in the same JSON input. For example, observability trace listing supports pagination and route-supported filters:
 
 ```bash
-mastra api trace list '{"page":0,"perPage":20,"filters":{"spanType":"agent"}}' --pretty
+mastra api trace list '{"page":0,"perPage":20,"filters":{"spanType":"agent"}}'
 ```
 
 ### Get command-specific help
@@ -973,8 +973,8 @@ Lists observability traces. Pass optional JSON input for route-supported filters
 
 ```bash
 mastra api trace list [input]
-mastra api trace list '{"page":0,"perPage":20}' --pretty
-mastra api trace list '{"page":0,"perPage":20}' --verbose --pretty
+mastra api trace list '{"page":0,"perPage":20}'
+mastra api trace list '{"page":0,"perPage":20}' --verbose
 ```
 
 `trace list` returns lightweight root span records by default so you can page through traces without fetching large input, output, attributes, or metadata payloads. Pass `--verbose` to fetch the full root span records.

package/.docs/reference/client-js/agents.md

@@ -151,17 +151,51 @@ for await (const part of uiMessageStream) {
 }
 ```
 
+### `sendMessage()`
+
+Send user-authored input to an active agent run or idle memory thread. Use this with `subscribeToThread()` so the client can render the stream that wakes from, or receives, the message.
+
+```typescript
+const agent = mastraClient.getAgent('support-agent')
+
+const result = await agent.sendMessage({
+  message: {
+    contents: 'Also consider the customer note I just added.',
+    attributes: { sentFrom: 'web' },
+  },
+  resourceId: 'user-123',
+  threadId: 'thread-abc',
+})
+
+console.log(result.runId)
+```
+
+`message` accepts a string, an array of text/file parts, or an object with `contents`, `attributes`, `metadata`, and `providerOptions`.
+
+### `queueMessage()`
+
+Queue user-authored input for the next thread turn. If the thread is active, Mastra starts a new run after the current run completes. If the thread is idle, Mastra starts a run immediately.
+
+```typescript
+await agent.queueMessage({
+  message: 'Also check whether the tests need updates.',
+  resourceId: 'user-123',
+  threadId: 'thread-abc',
+})
+```
+
 ### `sendSignal()`
 
-Send a signal to an active agent run or memory thread. Use this with `subscribeToThread()` so the client can render the stream that wakes from, or receives, the signal.
+Send a lower-level signal to an active agent run or memory thread. Use this for system-generated context such as reactive reminders or notification-shaped context that doesn't need inbox storage. For durable notification records, use the server-side [`Agent.sendNotificationSignal()`](https://mastra.ai/reference/agents/agent) API. For user-authored input, prefer `sendMessage()` or `queueMessage()`.
 
 ```typescript
 const agent = mastraClient.getAgent('support-agent')
 
 const result = await agent.sendSignal({
   signal: {
-    type: 'user-message',
-    contents: 'Also consider the customer note I just added.',
+    type: 'reactive',
+    tagName: 'system-reminder',
+    contents: 'Also consider the latest customer note.',
   },
   resourceId: 'user-123',
   threadId: 'thread-abc',
@@ -174,7 +208,7 @@ Use `ifActive.behavior` and `ifIdle.behavior` to control whether Mastra delivers
 
 ```typescript
 await agent.sendSignal({
-  signal: { type: 'user-message', contents: 'Store this for later.' },
+  signal: { type: 'reactive', tagName: 'system-reminder', contents: 'Store this for later.' },
   resourceId: 'user-123',
   threadId: 'thread-abc',
   ifIdle: {
@@ -187,7 +221,7 @@ Pass `ifIdle.streamOptions` when the idle wake-up stream needs options such as m
 
 ```typescript
 await agent.sendSignal({
-  signal: { type: 'user-message', contents: 'Start from this signal.' },
+  signal: { type: 'reactive', tagName: 'system-reminder', contents: 'Start from this signal.' },
   resourceId: 'user-123',
   threadId: 'thread-abc',
   ifIdle: {
@@ -201,7 +235,7 @@ await agent.sendSignal({
 
 Returns `{ accepted: true, runId: string }`.
 
-**signal** (`{ type: 'user-message' | 'system-reminder' | string; contents: string | Array<TextPart | FilePart>; attributes?: Record<string, JSONValue>; metadata?: Record<string, unknown>; providerOptions?: ProviderMetadata }`): \`user-message\` signals without attributes are treated as plain user input. All other signals — including \`user-message\` with \`attributes\`, \`system-reminder\`, and custom types — are wrapped in an XML element named after the signal type with \`attributes\` rendered as XML attributes (e.g. \`\<user name="Devin" from="slack">message\</user>\`). The model sees the XML; the UI sees the raw contents and can read \`attributes\` for custom rendering. \`providerOptions\` is attached to the resulting prompt turn and persisted on the stored signal message.
+**signal** (`{ type: 'user' | 'reactive' | 'notification' | string; tagName?: string; contents: string | Array<TextPart | FilePart>; attributes?: Record<string, JSONValue>; metadata?: Record<string, unknown>; providerOptions?: ProviderMetadata }`): Lower-level signal payload. Use \`type\` for the semantic signal category and \`tagName\` for the XML tag shown to the model. \`providerOptions\` is attached to the resulting prompt turn and persisted on the stored signal message.
 
 **runId** (`string`): Run ID to target directly.
 
@@ -217,7 +251,7 @@ Returns `{ accepted: true, runId: string }`.
 
 ### `subscribeToThread()`
 
-Subscribe to raw stream chunks for a memory thread. Use this to render output from a thread that may be started or continued by `sendSignal()`.
+Subscribe to raw stream chunks for a memory thread. Use this to render output from a thread that may be started or continued by `sendMessage()`, `queueMessage()`, `sendSignal()`, or server-side notification dispatch.
 
 ```typescript
 const agent = mastraClient.getAgent('support-agent')

package/.docs/reference/configuration.md

@@ -30,7 +30,7 @@ export const mastra = new Mastra({
       id: 'weather-agent',
       name: 'Weather Agent',
       instructions: 'You help with weather information',
-      model: 'openai/gpt-5.4',
+      model: 'openai/gpt-5.5',
     }),
   },
 })

package/.docs/reference/evals/answer-relevancy.md

@@ -69,7 +69,7 @@ import { runEvals } from '@mastra/core/evals'
 import { createAnswerRelevancyScorer } from '@mastra/evals/scorers/prebuilt'
 import { myAgent } from './agent'
 
-const scorer = createAnswerRelevancyScorer({ model: 'openai/gpt-5.4' })
+const scorer = createAnswerRelevancyScorer({ model: 'openai/gpt-5.5' })
 
 const result = await runEvals({
   data: [

package/.docs/reference/evals/answer-similarity.md

@@ -62,7 +62,7 @@ import { runEvals } from '@mastra/core/evals'
 import { createAnswerSimilarityScorer } from '@mastra/evals/scorers/prebuilt'
 import { myAgent } from './agent'
 
-const scorer = createAnswerSimilarityScorer({ model: 'openai/gpt-5.4' })
+const scorer = createAnswerSimilarityScorer({ model: 'openai/gpt-5.5' })
 
 const result = await runEvals({
   data: [

package/.docs/reference/evals/bias.md

@@ -82,7 +82,7 @@ import { runEvals } from '@mastra/core/evals'
 import { createBiasScorer } from '@mastra/evals/scorers/prebuilt'
 import { myAgent } from './agent'
 
-const scorer = createBiasScorer({ model: 'openai/gpt-5.4' })
+const scorer = createBiasScorer({ model: 'openai/gpt-5.5' })
 
 const result = await runEvals({
   data: [

package/.docs/reference/evals/context-precision.md

@@ -98,7 +98,7 @@ MAP = (1.0 + 0.67) / 2 = 0.835 ≈ **0.83**
 
 ```typescript
 const scorer = createContextPrecisionScorer({
-  model: 'openai/gpt-5.4',
+  model: 'openai/gpt-5.5',
   options: {
     contextExtractor: (input, output) => {
       // Extract context dynamically based on the query
@@ -117,7 +117,7 @@ const scorer = createContextPrecisionScorer({
 
 ```typescript
 const scorer = createContextPrecisionScorer({
-  model: 'openai/gpt-5.4',
+  model: 'openai/gpt-5.5',
   options: {
     context: [
       // Simulate retrieved documents from vector database
@@ -142,7 +142,7 @@ import { createContextPrecisionScorer } from '@mastra/evals/scorers/prebuilt'
 import { myAgent } from './agent'
 
 const scorer = createContextPrecisionScorer({
-  model: 'openai/gpt-5.4',
+  model: 'openai/gpt-5.5',
   options: {
     contextExtractor: (input, output) => {
       // Extract context from agent's retrieved documents

package/.docs/reference/evals/context-relevance.md

@@ -119,7 +119,7 @@ import { createContextRelevanceScorerLLM } from '@mastra/evals'
 
 // Stricter penalty configuration
 const strictScorer = createContextRelevanceScorerLLM({
-  model: 'openai/gpt-5.4',
+  model: 'openai/gpt-5.5',
   options: {
     context: [
       'Einstein won the Nobel Prize for photoelectric effect',
@@ -137,7 +137,7 @@ const strictScorer = createContextRelevanceScorerLLM({
 
 // Lenient penalty configuration
 const lenientScorer = createContextRelevanceScorerLLM({
-  model: 'openai/gpt-5.4',
+  model: 'openai/gpt-5.5',
   options: {
     context: [
       'Einstein won the Nobel Prize for photoelectric effect',
@@ -183,7 +183,7 @@ console.log('Lenient penalties:', lenientResult.score) // Higher score, less pen
 
 ```typescript
 const scorer = createContextRelevanceScorerLLM({
-  model: 'openai/gpt-5.4',
+  model: 'openai/gpt-5.5',
   options: {
     contextExtractor: (input, output) => {
       // Extract context based on the query
@@ -207,7 +207,7 @@ const scorer = createContextRelevanceScorerLLM({
 
 ```typescript
 const scorer = createContextRelevanceScorerLLM({
-  model: 'openai/gpt-5.4',
+  model: 'openai/gpt-5.5',
   options: {
     context: ['Relevant information...', 'Supporting details...'],
     scale: 100, // Scale scores from 0-100 instead of 0-1
@@ -221,7 +221,7 @@ const scorer = createContextRelevanceScorerLLM({
 
 ```typescript
 const scorer = createContextRelevanceScorerLLM({
-  model: 'openai/gpt-5.4',
+  model: 'openai/gpt-5.5',
   options: {
     contextExtractor: (input, output) => {
       const query = input?.inputMessages?.[0]?.content || ''
@@ -248,7 +248,7 @@ This example shows excellent context relevance where all context directly suppor
 import { createContextRelevanceScorerLLM } from '@mastra/evals'
 
 const scorer = createContextRelevanceScorerLLM({
-  model: 'openai/gpt-5.4',
+  model: 'openai/gpt-5.5',
   options: {
     context: [
       'Einstein won the Nobel Prize for his discovery of the photoelectric effect in 1921.',
@@ -295,7 +295,7 @@ This example shows moderate relevance with some context being irrelevant or unus
 import { createContextRelevanceScorerLLM } from '@mastra/evals'
 
 const scorer = createContextRelevanceScorerLLM({
-  model: 'openai/gpt-5.4',
+  model: 'openai/gpt-5.5',
   options: {
     context: [
       'Solar eclipses occur when the Moon blocks the Sun.',
@@ -337,7 +337,7 @@ console.log(result)
 
 // With custom penalty configuration
 const customScorer = createContextRelevanceScorerLLM({
-  model: 'openai/gpt-5.4',
+  model: 'openai/gpt-5.5',
   options: {
     context: [
       'Solar eclipses occur when the Moon blocks the Sun.',
@@ -384,7 +384,7 @@ This example shows poor context relevance with mostly irrelevant information:
 import { createContextRelevanceScorerLLM } from '@mastra/evals'
 
 const scorer = createContextRelevanceScorerLLM({
-  model: 'openai/gpt-5.4',
+  model: 'openai/gpt-5.5',
   options: {
     context: [
       'The Great Barrier Reef is located in Australia.',
@@ -432,7 +432,7 @@ Extract context dynamically based on the run input:
 import { createContextRelevanceScorerLLM } from '@mastra/evals'
 
 const scorer = createContextRelevanceScorerLLM({
-  model: 'openai/gpt-5.4',
+  model: 'openai/gpt-5.5',
   options: {
     contextExtractor: (input, output) => {
       // Extract query from input
@@ -475,7 +475,7 @@ Integrate with RAG pipelines to evaluate retrieved context:
 import { createContextRelevanceScorerLLM } from '@mastra/evals'
 
 const scorer = createContextRelevanceScorerLLM({
-  model: 'openai/gpt-5.4',
+  model: 'openai/gpt-5.5',
   options: {
     contextExtractor: (input, output) => {
       // Extract from RAG retrieval results