@mastra/mcp-docs-server 1.2.7-alpha.12 → 1.2.7-alpha.3

package/.docs/reference/file-based-agents/workspace.md

@@ -1,74 +0,0 @@
-> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
-
-# Workspace
-
-A [workspace](https://mastra.ai/docs/workspace/overview) gives an agent filesystem access and command execution. File-based agents get a default workspace automatically when discovered through `mastra dev` or `mastra build`, so they can read and write files and run shell commands without extra configuration.
-
-Use this page for the file-based convention. For workspace providers, tools, search, lifecycle, and sandbox details, see [Workspaces](https://mastra.ai/docs/workspace/overview).
-
-## Default workspace
-
-Without `workspace.ts`, a file-based agent gets a default [`Workspace`](https://mastra.ai/reference/workspace/workspace-class) when the build provides a per-agent workspace path. The default workspace uses:
-
-- [`LocalFilesystem`](https://mastra.ai/reference/workspace/local-filesystem) rooted at the agent's bundled workspace directory.
-- [`LocalSandbox`](https://mastra.ai/reference/workspace/local-sandbox) with the same working directory.
-
-This gives the agent file tools and shell tools automatically. The default workspace is per agent; subagents get nested workspace directories under their parent agent's workspace path.
-
-## Quickstart
-
-For the default workspace, don't add a file. Start with an agent directory like this:
-
-```text
-src/mastra/agents/weather/
-├── config.ts
-└── instructions.md
-```
-
-Add `workspace.ts` only when you need to customize the workspace:
-
-```typescript
-import { Workspace, LocalFilesystem, LocalSandbox } from '@mastra/core/workspace'
-
-export default new Workspace({
-  name: 'weather-workspace',
-  filesystem: new LocalFilesystem({ basePath: './data/weather' }),
-  sandbox: new LocalSandbox({ workingDirectory: './data/weather' }),
-})
-```
-
-Visit the [`Workspace` reference](https://mastra.ai/reference/workspace/workspace-class) for the full config.
-
-## When to customize the workspace
-
-Customize the workspace when the default local directory isn't enough. Common reasons include:
-
-- Point file tools at a different filesystem root.
-- Run shell commands in a different sandbox provider.
-- Add workspace search with BM25 or vector search.
-- Share one workspace across multiple agents.
-
-For provider patterns and runtime behavior, see the [workspace overview](https://mastra.ai/docs/workspace/overview), [sandbox guide](https://mastra.ai/docs/workspace/sandbox), and [workspace search](https://mastra.ai/docs/workspace/search).
-
-## Runtime boundary
-
-The workspace filesystem controls what file tools can read and write. The sandbox controls where shell commands run. Application runtime code, including code in [`tools/`](https://mastra.ai/reference/file-based-agents/tools), still runs in your app/server process unless it explicitly calls workspace or sandbox APIs.
-
-## Seed files
-
-Add a `workspace/` directory to ship starting files with the agent. Mastra mirrors files under `workspace/` into the agent's default runtime workspace at build time, so the agent starts with those files on disk.
-
-```text
-src/mastra/agents/weather/
-├── config.ts
-└── workspace/
-    ├── README.md
-    └── data/
-        └── cities.json
-```
-
-The files are copied into the bundled workspace path, where workspace file tools and sandbox commands can read them. Symlinked seed files are skipped during mirroring.
-
-## Precedence with config
-
-`config.workspace` wins over `workspace.ts`; otherwise the default file-based workspace is used. See [`config.ts` precedence](https://mastra.ai/reference/file-based-agents/config) for the full merge table.

package/.docs/reference/memory/summarizeConversation.md

@@ -1,99 +0,0 @@
-> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
-
-# summarizeConversation()
-
-The standalone `summarizeConversation()` function summarizes a conversation in one shot. It distills the messages you pass in with the same Observer plumbing that powers [Observational Memory](https://mastra.ai/reference/memory/observational-memory) — without Observational Memory attached to an agent, and without reading from or writing to storage.
-
-Nothing is written back to memory. The summary and extracted values are returned to you (and to each extractor's `onExtracted` hook), so you decide where they go — for example your own database.
-
-Use this when you already have the messages in hand and want explicit control over what gets summarized. To summarize a stored thread by ID instead, use [`Memory.summarizeThread()`](https://mastra.ai/reference/memory/summarizeThread), which loads the messages for you.
-
-## Usage example
-
-```typescript
-import { summarizeConversation } from '@mastra/memory'
-
-const result = await summarizeConversation({
-  model: 'openai/gpt-5-mini',
-  messages,
-  instructions: 'Summarize this voicemail call for the business owner.',
-})
-```
-
-## Parameters
-
-**model** (`string | LanguageModel | DynamicModel`): Model that runs the summarization, such as a router string like '\_\_GATEWAY\_OPENAI\_MODEL\_MINI\_\_'.
-
-**messages** (`MastraDBMessage[]`): The conversation to summarize. When empty, the function returns an empty result without calling the model.
-
-**instructions** (`string`): Extra guidance appended to the summarizer's system prompt, such as what to focus on or who the summary is for.
-
-**extract** (`Extractor[]`): Extractors to run over the conversation. Extractors with a Zod schema run as a follow-up structured output call; schema-less extractors are extracted inline. Each extractor's onExtracted hook fires with the extracted value.
-
-**threadId** (`string`): Thread the conversation belongs to. Defaults to the first threadId found on messages. Passed to extractor contexts.
-
-**resourceId** (`string`): Resource (user) the conversation belongs to. Defaults to the first resourceId found on messages. Passed to extractor contexts.
-
-**memory** (`Memory`): Memory instance forwarded to extractor contexts. Set automatically when called through Memory.summarizeThread().
-
-**mastra** (`Mastra`): Mastra instance used to resolve custom gateway models. Set automatically when called through Memory.summarizeThread().
-
-**requestContext** (`RequestContext`): Request context forwarded to the summarizer model and extractor hooks.
-
-**abortSignal** (`AbortSignal`): Signal to cancel the summarization call.
-
-## Returns
-
-**summary** (`string`): The distilled observations produced from the conversation, in dense bullet form.
-
-**extracted** (`Record<string, unknown>`): Values produced by extract extractors, keyed by extractor slug.
-
-**extractionFailures** (`{ slug: string; error: string }[]`): Extractors that failed to produce a valid value, with the reason. Only present when at least one extractor failed.
-
-**usage** (`{ inputTokens?: number; outputTokens?: number; totalTokens?: number }`): Token usage of the summarization call.
-
-## Extended usage example
-
-The following example summarizes an in-flight voice session from messages the application already holds, and extracts a structured record:
-
-```typescript
-import { summarizeConversation, Extractor } from '@mastra/memory'
-import type { MastraDBMessage } from '@mastra/core/agent'
-import { z } from 'zod'
-import { sessionRecords } from './db'
-
-const sessionSummary = new Extractor({
-  name: 'session-summary',
-  instructions: 'Return a concise summary of the session.',
-  schema: z.object({
-    summary: z.string(),
-    sentiment: z.enum(['positive', 'neutral', 'negative']),
-    followUps: z.array(z.string()),
-  }),
-  metadataKeyPath: false, // don't persist into memory metadata — the hook owns storage
-  onExtracted: async ({ current, threadId }) => {
-    await sessionRecords.upsert({ sessionId: threadId, record: current })
-  },
-})
-
-export async function onSessionEnd(messages: MastraDBMessage[]) {
-  const { summary, extracted, extractionFailures } = await summarizeConversation({
-    model: 'openai/gpt-5-mini',
-    messages,
-    instructions: 'Summarize this support session for the account manager.',
-    extract: [sessionSummary],
-  })
-
-  if (extractionFailures?.length) {
-    console.warn('Some extractors failed', extractionFailures)
-  }
-
-  return { summary, extracted }
-}
-```
-
-### Related
-
-- [.summarizeThread()](https://mastra.ai/reference/memory/summarizeThread)
-- [Memory Class Reference](https://mastra.ai/reference/memory/memory-class)
-- [Observational Memory](https://mastra.ai/reference/memory/observational-memory)

package/.docs/reference/memory/summarizeThread.md

@@ -1,93 +0,0 @@
-> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
-
-# Memory.summarizeThread()
-
-The `.summarizeThread()` method summarizes a thread's conversation in one shot. It loads the thread's messages from storage and distills them with the same Observer plumbing that powers [Observational Memory](https://mastra.ai/reference/memory/observational-memory) — as a standalone call, without Observational Memory attached to an agent.
-
-Messages load page-by-page starting from the newest, bounded by `lastMessages` and `maxInputTokens`, so summarizing a long thread doesn't read its entire history from storage.
-
-Nothing is written back to memory. The summary and extracted values are returned to you (and to each extractor's `onExtracted` hook), so you decide where they go — for example your own database.
-
-Use this when a session ends and you want a summary or structured extraction of the whole conversation, such as a voice call at hang-up. To summarize messages you already have in hand (without loading them from a thread), use the standalone [`summarizeConversation()`](https://mastra.ai/reference/memory/summarizeConversation) function instead — it takes the same options with `messages` in place of `threadId`.
-
-## Usage example
-
-```typescript
-const result = await memory.summarizeThread({
-  model: 'openai/gpt-5-mini',
-  threadId: 'thread-123',
-  instructions: 'Summarize this voicemail call for the business owner.',
-})
-```
-
-## Parameters
-
-**threadId** (`string`): The unique identifier of the thread to summarize.
-
-**model** (`string | LanguageModel | DynamicModel`): Model that runs the summarization, such as a router string like '\_\_GATEWAY\_OPENAI\_MODEL\_MINI\_\_'.
-
-**resourceId** (`string`): ID of the resource that owns the thread. If provided, validates thread ownership. Also passed to extractor contexts.
-
-**lastMessages** (`number`): Only summarize the last N messages of the thread. By default the whole thread is loaded, bounded by maxInputTokens.
-
-**maxInputTokens** (`number`): Stop loading older messages once the collected messages exceed this estimated token count. The newest message is always included. (Default: `1000000`)
-
-**instructions** (`string`): Extra guidance appended to the summarizer's system prompt, such as what to focus on or who the summary is for.
-
-**extract** (`Extractor[]`): Extractors to run over the conversation. Extractors with a Zod schema run as a follow-up structured output call; schema-less extractors are extracted inline. Each extractor's onExtracted hook fires with the extracted value.
-
-**requestContext** (`RequestContext`): Request context forwarded to the summarizer model and extractor hooks.
-
-**abortSignal** (`AbortSignal`): Signal to cancel the summarization call.
-
-## Returns
-
-**summary** (`string`): The distilled observations produced from the conversation, in dense bullet form.
-
-**extracted** (`Record<string, unknown>`): Values produced by extract extractors, keyed by extractor slug.
-
-**extractionFailures** (`{ slug: string; error: string }[]`): Extractors that failed to produce a valid value, with the reason. Only present when at least one extractor failed.
-
-**usage** (`{ inputTokens?: number; outputTokens?: number; totalTokens?: number }`): Token usage of the summarization call.
-
-## Extended usage example
-
-The following example summarizes a finished voice call and stores a structured record in the application's own database:
-
-```typescript
-import { Extractor } from '@mastra/memory'
-import { z } from 'zod'
-import { memory } from './mastra/memory'
-import { callRecords } from './db'
-
-const callSummary = new Extractor({
-  name: 'call-summary',
-  instructions: 'Return a concise summary of the call.',
-  schema: z.object({
-    summary: z.string(),
-    sentiment: z.enum(['positive', 'neutral', 'negative']),
-    requestedServices: z.array(z.string()),
-  }),
-  metadataKeyPath: false, // don't persist into memory metadata — the hook owns storage
-  onExtracted: async ({ current, threadId, resourceId }) => {
-    await callRecords.upsert({ callId: threadId, callerId: resourceId, record: current })
-  },
-})
-
-export async function onCallEnd(threadId: string, resourceId: string) {
-  await memory.summarizeThread({
-    model: 'openai/gpt-5-mini',
-    threadId,
-    resourceId,
-    instructions: 'Summarize this voicemail call for the business owner.',
-    extract: [callSummary],
-  })
-}
-```
-
-### Related
-
-- [summarizeConversation()](https://mastra.ai/reference/memory/summarizeConversation)
-- [Memory Class Reference](https://mastra.ai/reference/memory/memory-class)
-- [Observational Memory](https://mastra.ai/reference/memory/observational-memory)
-- [.recall()](https://mastra.ai/reference/memory/recall)