@mastra/mcp-docs-server 1.0.0-beta.9 → 1.0.1

package/.docs/raw/memory/threads-and-resources.mdx

@@ -1,95 +0,0 @@
----
-title: "Memory threads and resources | Memory"
-description: "Learn how Mastra's memory system works with working memory, conversation history, and semantic recall."
----
-
-# Memory threads and resources
-
-Mastra organizes memory into threads, which are records that group related interactions, using two identifiers:
-
-1. **`thread`**: A globally unique ID representing the conversation (e.g., `support_123`). Must be unique across all resources.
-2. **`resource`**: The user or entity that owns the thread (e.g., `user_123`, `org_456`).
-
-The `resource` is especially important for [resource-scoped memory](./working-memory#resource-scoped-memory-default), which allows memory to persist across all threads associated with the same user or entity.
-
-```typescript {4} showLineNumbers
-const stream = await agent.stream("message for agent", {
-  memory: {
-    thread: "conversation-123",
-    resource: "user-123",
-  },
-});
-```
-
-:::warning
-
-Even with memory configured, agents won’t store or recall information unless both `thread` and `resource` are provided.
-
-:::
-
-> Studio sets `thread` and `resource` IDs automatically. In your own application, you must provide them manually as part of each `.generate()` or `.stream()` call.
-
-### Thread title generation
-
-Mastra can automatically generate descriptive thread titles based on the user's first message. This feature is disabled by default. Enable it by setting `generateTitle` to `true`. This improves organization and makes it easier to display conversations in your UI.
-
-```typescript {3-7} showLineNumbers
-export const testAgent = new Agent({
-  memory: new Memory({
-    options: {
-      generateTitle: true, // Explicitly enable automatic title generation
-    },
-  }),
-});
-```
-
-> Title generation runs asynchronously after the agent responds and does not affect response time. See the [full configuration reference](/reference/v1/memory/memory-class) for details and examples.
-
-#### Optimizing title generation
-
-Titles are generated using your agent's model by default. To optimize cost or behavior, provide a smaller `model` and custom `instructions`. This keeps title generation separate from main conversation logic.
-
-```typescript {5-9} showLineNumbers
-export const testAgent = new Agent({
-  // ...
-  memory: new Memory({
-    options: {
-      threads: {
-        generateTitle: {
-          model: "openai/gpt-4.1-nano",
-          instructions:
-            "Generate a concise title based on the user's first message",
-        },
-      },
-    },
-  }),
-});
-```
-
-#### Dynamic model selection and instructions
-
-You can configure thread title generation dynamically by passing functions to `model` and `instructions`. These functions receive the `requestContext` object, allowing you to adapt title generation based on user-specific values.
-
-```typescript {7-16} showLineNumbers
-export const testAgent = new Agent({
-  // ...
-  memory: new Memory({
-    options: {
-      threads: {
-        generateTitle: {
-          model: ({ requestContext }) => {
-            const userTier = requestContext.get("userTier");
-            return userTier === "premium"
-              ? "openai/gpt-5.1"
-              : "openai/gpt-4.1-nano";
-          },
-          instructions: ({ requestContext }) => {
-            const language = requestContext.get("userLanguage") || "English";
-            return `Generate a concise, engaging title in ${language} based on the user's first message.`;
-          },
-        },
-      },
-    },
-  }),
-});
-```

package/.docs/raw/reference/core/setTelemetry.mdx

@@ -1,36 +0,0 @@
----
-title: "Reference: Mastra.setTelemetry() | Core"
-description: "Documentation for the `Mastra.setTelemetry()` method in Mastra, which sets the telemetry configuration for all components."
----
-
-# Mastra.setTelemetry()
-
-The `.setTelemetry()` method is used to set the telemetry configuration for all components in the Mastra instance. This method accepts a single telemetry configuration object.
-
-## Usage example
-
-```typescript copy
-mastra.setTelemetry({ export: { type: "console" } });
-```
-
-## Parameters
-
-<PropertiesTable
-  content={[
-    {
-      name: "telemetry",
-      type: "OtelConfig",
-      description:
-        "The telemetry configuration object to set for all components.",
-    },
-  ]}
-/>
-
-## Returns
-
-This method does not return a value.
-
-## Related
-
-- [Logging](/docs/v1/observability/logging)
-- [PinoLogger](/reference/v1/logging/pino-logger)

package/.docs/raw/reference/memory/listThreadsByResourceId.mdx

@@ -1,110 +0,0 @@
----
-title: "Reference: Memory.listThreadsByResourceId() | Memory"
-description: "Documentation for the `Memory.listThreadsByResourceId()` method in Mastra, which retrieves threads associated with a specific resource ID with pagination support."
----
-
-# Memory.listThreadsByResourceId()
-
-The `.listThreadsByResourceId()` method retrieves threads associated with a specific resource ID with pagination support.
-
-## Usage Example
-
-```typescript copy
-await memory.listThreadsByResourceId({
-  resourceId: "user-123",
-  page: 0,
-  perPage: 10,
-});
-```
-
-## Parameters
-
-<PropertiesTable
-  content={[
-    {
-      name: "resourceId",
-      type: "string",
-      description: "The ID of the resource whose threads are to be retrieved",
-      isOptional: false,
-    },
-    {
-      name: "page",
-      type: "number",
-      description: "Page number (0-indexed) to retrieve",
-      isOptional: false,
-    },
-    {
-      name: "perPage",
-      type: "number",
-      description: "Maximum number of threads to return per page",
-      isOptional: false,
-    },
-    {
-      name: "orderBy",
-      type: "{ field: 'createdAt' | 'updatedAt', direction: 'ASC' | 'DESC' }",
-      description: "Sort configuration with field and direction (defaults to { field: 'createdAt', direction: 'DESC' })",
-      isOptional: true,
-    },
-  ]}
-/>
-
-## Returns
-
-<PropertiesTable
-  content={[
-    {
-      name: "result",
-      type: "Promise<StorageListThreadsByResourceIdOutput>",
-      description:
-        "A promise that resolves to paginated thread results with metadata",
-    },
-  ]}
-/>
-
-The return object contains:
-- `threads`: Array of thread objects
-- `total`: Total number of threads for this resource
-- `page`: Current page number (same as the input `page` parameter)
-- `perPage`: Items per page (same as the input `perPage` parameter)
-- `hasMore`: Boolean indicating if more results are available
-
-## Extended usage example
-
-```typescript title="src/test-memory.ts" showLineNumbers copy
-import { mastra } from "./mastra";
-
-const agent = mastra.getAgent("agent");
-const memory = await agent.getMemory();
-
-let currentPage = 0;
-const perPage = 25;
-let hasMorePages = true;
-
-while (hasMorePages) {
-  const result = await memory?.listThreadsByResourceId({
-    resourceId: "user-123",
-    page: currentPage,
-    perPage: perPage,
-    orderBy: { field: "createdAt", direction: "ASC" },
-  });
-
-  if (!result) {
-    console.log("No threads");
-    break;
-  }
-
-  result.threads.forEach((thread) => {
-    console.log(`Thread: ${thread.id}, Created: ${thread.createdAt}`);
-  });
-
-  hasMorePages = result.hasMore;
-  currentPage++; // Move to next page
-}
-```
-
-## Related
-
-- [Memory Class Reference](/reference/v1/memory/memory-class)
-- [Getting Started with Memory](/docs/v1/memory/overview) (Covers threads/resources concept)
-- [createThread](/reference/v1/memory/createThread)
-- [getThreadById](/reference/v1/memory/getThreadById)

package/.docs/raw/reference/memory/query.mdx

@@ -1,189 +0,0 @@
----
-title: "Reference: Memory.query() | Memory"
-description: "Documentation for the `Memory.query()` method in Mastra, which retrieves messages from a specific thread with support for pagination, filtering options, and semantic search."
----
-
-# Memory.query()
-
-:::warning[Deprecated]
-The `Memory.query()` method has been renamed to [`Memory.recall()`](/reference/v1/memory/recall). This page is kept for reference, but please use `recall()` in new code.
-:::
-
-the `.query()` method retrieves messages from a specific thread, with support for pagination, filtering options, and semantic search.
-
-## Usage Example
-
-```typescript copy
-await memory?.query({ threadId: "user-123" });
-```
-
-## Parameters
-
-<PropertiesTable
-  content={[
-    {
-      name: "threadId",
-      type: "string",
-      description:
-        "The unique identifier of the thread to retrieve messages from",
-      isOptional: false,
-    },
-    {
-      name: "resourceId",
-      type: "string",
-      description:
-        "Optional ID of the resource that owns the thread. If provided, validates thread ownership",
-      isOptional: true,
-    },
-    {
-      name: "vectorSearchString",
-      type: "string",
-      description:
-        "Search string for finding semantically similar messages. Requires semantic recall to be enabled in threadConfig.",
-      isOptional: true,
-    },
-    {
-      name: "perPage",
-      type: "number | false",
-      description:
-        "Number of messages to retrieve per page. Set to false to fetch all messages without pagination.",
-      isOptional: true,
-    },
-    {
-      name: "page",
-      type: "number",
-      description:
-        "Zero-based page number for pagination. Used with perPage to retrieve messages in batches.",
-      isOptional: true,
-    },
-    {
-      name: "include",
-      type: "{ id: string; threadId?: string; withPreviousMessages?: number; withNextMessages?: number }[]",
-      description:
-        "Array of specific message IDs to include with optional context messages. Each item has an `id` (required), optional `threadId` (defaults to main threadId), `withPreviousMessages` (number of messages before, defaults to 2 for vector search, 0 otherwise), and `withNextMessages` (number of messages after, defaults to 2 for vector search, 0 otherwise).",
-      isOptional: true,
-    },
-    {
-      name: "filter",
-      type: "{ dateRange?: { start?: Date; end?: Date } }",
-      description:
-        "Filter options for message retrieval. Currently supports `dateRange` to filter messages by creation date.",
-      isOptional: true,
-    },
-    {
-      name: "orderBy",
-      type: "{ field: 'createdAt'; direction: 'ASC' | 'DESC' }",
-      description:
-        "Sort order for retrieved messages. Defaults to descending by creation date.",
-      isOptional: true,
-    },
-    {
-      name: "threadConfig",
-      type: "MemoryConfig",
-      description:
-        "Configuration options for message retrieval and semantic search",
-      isOptional: true,
-    },
-
-  ]}
-/>
-
-### threadConfig parameters
-
-<PropertiesTable
-  content={[
-    {
-      name: "lastMessages",
-      type: "number | false",
-      description:
-        "Number of most recent messages to retrieve. Set to false to disable.",
-      isOptional: true,
-      defaultValue: "10",
-    },
-    {
-      name: "semanticRecall",
-      type: "boolean | { topK: number; messageRange: number | { before: number; after: number }; scope?: 'thread' | 'resource' }",
-      description:
-        "Enable semantic search in message history. Can be a boolean or an object with configuration options. When enabled, requires both vector store and embedder to be configured.",
-      isOptional: true,
-      defaultValue: "false",
-    },
-    {
-      name: "workingMemory",
-      type: "WorkingMemory",
-      description:
-        "Configuration for working memory feature. Can be `{ enabled: boolean; template?: string; schema?: ZodObject<any> | JSONSchema7; scope?: 'thread' | 'resource' }` or `{ enabled: boolean }` to disable.",
-      isOptional: true,
-      defaultValue:
-        "{ enabled: false, template: '# User Information\\n- **First Name**:\\n- **Last Name**:\\n...' }",
-    },
-    {
-      name: "threads",
-      type: "{ generateTitle?: boolean | { model: DynamicArgument<MastraLanguageModel>; instructions?: DynamicArgument<string> } }",
-      description:
-        "Settings related to memory thread creation. `generateTitle` controls automatic thread title generation from the user's first message. Can be a boolean or an object with custom model and instructions.",
-      isOptional: true,
-      defaultValue: "{ generateTitle: false }",
-    },
-  ]}
-/>
-
-## Returns
-
-<PropertiesTable
-  content={[
-    {
-      name: "messages",
-      type: "MastraDBMessage[]",
-      description: "Array of retrieved messages in the database format",
-    },
-  ]}
-/>
-
-## Extended usage example
-
-```typescript title="src/test-memory.ts" showLineNumbers copy
-import { mastra } from "./mastra";
-
-const agent = mastra.getAgent("agent");
-const memory = await agent.getMemory();
-
-// Retrieve messages with pagination
-const { messages } = await memory!.query({
-  threadId: "thread-123",
-  perPage: 50,
-  vectorSearchString: "What messages are there?",
-  include: [
-    {
-      id: "msg-123",
-    },
-    {
-      id: "msg-456",
-      withPreviousMessages: 3,
-      withNextMessages: 1,
-    },
-  ],
-  threadConfig: {
-    semanticRecall: true,
-  },
-});
-
-console.log(messages); // MastraDBMessage[]
-
-// Fetch all messages without pagination
-const allMessages = await memory!.query({
-  threadId: "thread-123",
-  perPage: false, // Fetch all
-});
-
-// Convert to AI SDK format if needed
-import { toAISdkV5Messages } from '@mastra/ai-sdk/ui';
-const uiMessages = toAISdkV5Messages(messages);
-```
-
-### Related
-
-- [Memory Class Reference](/reference/v1/memory/memory-class)
-- [Getting Started with Memory](/docs/v1/memory/overview)
-- [Semantic Recall](/docs/v1/memory/semantic-recall)
-- [createThread](/reference/v1/memory/createThread)

package/.docs/raw/reference/workflows/workflow-methods/sendEvent.mdx

@@ -1,70 +0,0 @@
----
-title: "Reference: Workflow.sendEvent() | Workflows"
-description: Documentation for the `Workflow.sendEvent()` method in workflows, which resumes execution when an event is sent.
----
-
-# Workflow.sendEvent()
-
-The `.sendEvent()` resumes execution when an event is sent.
-
-## Usage example
-
-```typescript copy
-run.sendEvent("event-name", { value: "data" });
-```
-
-## Parameters
-
-<PropertiesTable
-  content={[
-    {
-      name: "eventName",
-      type: "string",
-      description: "The name of the event to send",
-      isOptional: false,
-    },
-    {
-      name: "step",
-      type: "Step",
-      description: "The step to resume after the event is sent",
-      isOptional: false,
-    },
-  ]}
-/>
-
-## Returns
-
-<PropertiesTable
-  content={[
-    {
-      name: "workflow",
-      type: "Workflow",
-      description: "The workflow instance for method chaining",
-    },
-  ]}
-/>
-
-## Extended usage example
-
-```typescript showLineNumbers copy
-import { mastra } from "./mastra";
-
-const run = await mastra.getWorkflow("testWorkflow").createRun();
-
-const result = run.start({
-  inputData: {
-    value: "hello",
-  },
-});
-
-setTimeout(() => {
-  run.sendEvent("event-name", { value: "from event" });
-}, 3000);
-```
-
-> In this example, avoid using `await run.start()` directly, as it would block sending the event before the workflow reaches its waiting state.
-
-## Related
-
-- [.waitForEvent()](./waitForEvent)
-- [Suspend & Resume](/docs/v1/workflows/suspend-and-resume#sleep--events)

package/.docs/raw/reference/workflows/workflow-methods/waitForEvent.mdx

@@ -1,66 +0,0 @@
----
-title: "Reference: Workflow.waitForEvent() | Workflows"
-description: Documentation for the `Workflow.waitForEvent()` method in workflows, which pauses execution until an event is received.
----
-
-# Workflow.waitForEvent()
-
-The `.waitForEvent()` method pauses execution until an event is received.
-
-## Usage example
-
-```typescript copy
-workflow.waitForEvent("event-name", step1);
-```
-
-## Parameters
-
-<PropertiesTable
-  content={[
-    {
-      name: "eventName",
-      type: "string",
-      description: "The name of the event to wait for",
-      isOptional: false,
-    },
-    {
-      name: "step",
-      type: "Step",
-      description: "The step to resume after the event is received",
-      isOptional: false,
-    },
-  ]}
-/>
-
-## Returns
-
-<PropertiesTable
-  content={[
-    {
-      name: "workflow",
-      type: "Workflow",
-      description: "The workflow instance for method chaining",
-    },
-  ]}
-/>
-
-## Extended usage example
-
-```typescript showLineNumbers copy
-import { createWorkflow, createStep } from "@mastra/core/workflows";
-
-const step1 = createStep({...});
-const step2 = createStep({...});
-const step3 = createStep({...});
-
-export const testWorkflow = createWorkflow({...})
-  .then(step1)
-  .waitForEvent("event-name", step2)
-  .then(step3)
-  .commit();
-```
-
-## Related
-
-- [.sendEvent()](./sendEvent)
-- [Suspend & Resume](/docs/v1/workflows/suspend-and-resume#sleep--events)

package/.docs/raw/server-db/mastra-server.mdx

@@ -1,97 +0,0 @@
----
-title: "Server Configuration | Server & DB"
-description: "Configure the Mastra server with custom settings for port, timeout, CORS, and more."
----
-
-# Server Configuration
-
-When deploying your Mastra application to production, it runs as an HTTP server that exposes your agents, workflows, and other functionality as API endpoints. This page covers how to configure and customize the server for a production environment.
-
-:::info
-
-This page covers the `server` configuration options passed to the `Mastra` constructor. For running Mastra with your own HTTP server (Hono, Express, etc.), see [Server Adapters](/docs/v1/server-db/server-adapters).
-
-:::
-
-## Server architecture
-
-Mastra uses [Hono](https://hono.dev) as its underlying HTTP server framework. When you build a Mastra application using `mastra build`, it generates a Hono-based HTTP server in the `.mastra` directory.
-
-The server provides:
-
-- API endpoints for all registered agents
-- API endpoints for all registered workflows
-- Custom API route support
-- Custom middleware support
-- Configuration of timeout
-- Configuration of port
-- Configuration of body limit
-
-See the [Middleware](/docs/v1/server-db/middleware) and
-[Custom API Routes](/docs/v1/server-db/custom-api-routes) pages for details on
-adding additional server behaviour.
-
-## Server configuration
-
-You can configure server `port` and `timeout` in the Mastra instance.
-
-```typescript title="src/mastra/index.ts" copy showLineNumbers
-import { Mastra } from "@mastra/core";
-
-export const mastra = new Mastra({
-  // ...
-  server: {
-    port: 3000, // Defaults to 4111
-    timeout: 10000, // Defaults to 3 * 60 * 1000 (3 minutes)
-  },
-});
-```
-
-## TypeScript configuration
-
-Mastra requires `module` and `moduleResolution` values that support modern Node.js versions. Older settings like `CommonJS` or `node` are incompatible with Mastra’s packages and will cause resolution errors.
-
-```json {4-5} title="tsconfig.json" copy
-{
-  "compilerOptions": {
-    "target": "ES2022",
-    "module": "ES2022",
-    "moduleResolution": "bundler",
-    "esModuleInterop": true,
-    "forceConsistentCasingInFileNames": true,
-    "strict": true,
-    "skipLibCheck": true,
-    "noEmit": true,
-    "outDir": "dist"
-  },
-  "include": ["src/**/*"]
-}
-```
-
-> This TypeScript configuration is optimized for Mastra projects, using modern module resolution and strict type checking.
-
-## CORS configuration
-
-Mastra allows you to configure CORS (Cross-Origin Resource Sharing) settings for your server.
-
-```typescript title="src/mastra/index.ts" copy showLineNumbers
-import { Mastra } from "@mastra/core";
-
-export const mastra = new Mastra({
-  // ...
-  server: {
-    cors: {
-      origin: ["https://example.com"], // Allow specific origins or '*' for all
-      allowMethods: ["GET", "POST", "PUT", "DELETE", "OPTIONS"],
-      allowHeaders: ["Content-Type", "Authorization"],
-      credentials: false,
-    },
-  },
-});
-```
-
-## Stream data redaction
-
-When streaming agent responses, the HTTP streaming layer redacts system prompts, tool definitions, API keys, and similar data from each chunk before sending it to clients. This is enabled by default.
-
-If you're using server adapters directly, you can configure redaction behavior. See [Stream data redaction](/docs/v1/server-db/server-adapters#stream-data-redaction) in the Server Adapters docs.