@mastra/mcp-docs-server 0.13.21 → 0.13.22-alpha.0

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

@@ -1,51 +1,16 @@
-# query
+---
+title: "Reference: Memory.query() | Memory | Mastra Docs"
+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."
+---
 
-Retrieves messages from a specific thread, with support for pagination, filtering options, and semantic search.
+# Memory.query()
 
-## Usage Example
-
-```typescript
-import { Memory } from "@mastra/memory";
-
-const memory = new Memory({
-  /* config */
-});
-
-// Get last 50 messages
-const { messages, uiMessages, messagesV2 } = await memory.query({
-  threadId: "thread-123",
-  selectBy: {
-    last: 50,
-  },
-});
+the `.query()` method retrieves messages from a specific thread, with support for pagination, filtering options, and semantic search.
 
-// Get messages with context around specific messages
-const { messages: contextMessages } = await memory.query({
-  threadId: "thread-123",
-  selectBy: {
-    include: [
-      {
-        id: "msg-123", // Get just this message (no context)
-      },
-      {
-        id: "msg-456", // Get this message with custom context
-        withPreviousMessages: 3, // 3 messages before
-        withNextMessages: 1, // 1 message after
-      },
-    ],
-  },
-});
+## Usage Example
 
-// Semantic search in messages
-const { messages } = await memory.query({
-  threadId: "thread-123",
-  selectBy: {
-    vectorSearchString: "What was discussed about deployment?",
-  },
-  threadConfig: {
-    semanticRecall: true,
-  },
-});
+```typescript copy
+await memory?.query({ threadId: "user-123" });
 ```
 
 ## Parameters
@@ -55,15 +20,13 @@ const { messages } = await memory.query({
     {
       name: "threadId",
       type: "string",
-      description:
-        "The unique identifier of the thread to retrieve messages from",
+      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",
+      description: "Optional ID of the resource that owns the thread. If provided, validates thread ownership",
       isOptional: true,
     },
     {
@@ -78,10 +41,16 @@ const { messages } = await memory.query({
       description: "Configuration options for message retrieval and semantic search",
       isOptional: true,
     },
+    {
+      name: "format",
+      type: "'v1' | 'v2'",
+      description: "Message format to return. Defaults to 'v2' for current format, 'v1' for backwards compatibility",
+      isOptional: true,
+    },
   ]}
 />
 
-### selectBy
+### selectBy parameters
 
 <PropertiesTable
   content={[
@@ -94,49 +63,55 @@ const { messages } = await memory.query({
     {
       name: "last",
       type: "number | false",
-      description:
-        "Number of most recent messages to retrieve. Set to false to disable limit. Note: threadConfig.lastMessages (default: 40) will override this if smaller.",
+      description: "Number of most recent messages to retrieve. Set to false to disable limit. Note: threadConfig.lastMessages (default: 10) will override this if smaller.",
       isOptional: true,
-      defaultValue: "40",
     },
     {
       name: "include",
-      type: "array",
-      description: "Array of specific message IDs to include with optional context messages",
+      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: "pagination",
+      type: "{ dateRange?: { start?: Date; end?: Date }; page?: number; perPage?: number }",
+      description: "Pagination options for retrieving messages in batches. Includes `dateRange` (filter by date range), `page` (0-based page number), and `perPage` (messages per page).",
+      isOptional: true,
+    },
   ]}
 />
 
-### include
+### threadConfig parameters
 
 <PropertiesTable
   content={[
     {
-      name: "id",
-      type: "string",
-      description: "ID of the message to include",
-      isOptional: false,
+      name: "lastMessages",
+      type: "number | false",
+      description: "Number of most recent messages to retrieve. Set to false to disable.",
+      isOptional: true,
+      defaultValue: "10",
     },
     {
-      name: "threadId",
-      type: "string",
-      description: "Optional thread ID (defaults to the main threadId parameter)",
+      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: "withPreviousMessages",
-      type: "number",
-      description:
-        "Number of messages to include before this message. Defaults to 2 when using vector search, 0 otherwise.",
+      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: "withNextMessages",
-      type: "number",
-      description:
-        "Number of messages to include after this message. Defaults to 2 when using vector search, 0 otherwise.",
+      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 }",
     },
   ]}
 />
@@ -148,37 +123,48 @@ const { messages } = await memory.query({
     {
       name: "messages",
       type: "CoreMessage[]",
-      description: "Array of retrieved messages in their core format (v1 format for backwards compatibility)",
+      description: "Array of retrieved messages in their core format",
     },
     {
       name: "uiMessages",
-      type: "UIMessage[]",
+      type: "UIMessageWithMetadata[]",
       description: "Array of messages formatted for UI display, including proper threading of tool calls and results",
     },
-    {
-      name: "messagesV2",
-      type: "MastraMessageV2[]",
-      description: "Array of messages in the v2 format, the current internal message format",
-    },
   ]}
 />
 
-## Additional Notes
-
-The `query` function returns three different message formats:
+## Extended usage example
 
-- `messages`: Core message format (v1) used for backwards compatibility with older APIs
-- `uiMessages`: Formatted messages suitable for UI display, including proper threading of tool calls and results  
-- `messagesV2`: The current internal message format with enhanced structure and metadata
+```typescript filename="src/test-memory.ts" showLineNumbers copy
+import { mastra } from "./mastra";
 
-### Semantic Search
+const agent = mastra.getAgent("agent");
+const memory = await agent.getMemory();
 
-When using `vectorSearchString`, ensure that:
-- Semantic recall is enabled in your `threadConfig` 
-- A vector database is configured in your Memory instance
-- An embedding model is provided
+const { messages, uiMessages } = await memory!.query({
+  threadId: "thread-123",
+  selectBy: {
+    last: 50,
+    vectorSearchString: "What messages are there?",
+    include: [
+      {
+        id: "msg-123"
+      },
+      {
+        id: "msg-456",
+        withPreviousMessages: 3,
+        withNextMessages: 1
+      }
+    ]
+  },
+  threadConfig: {
+    semanticRecall: true
+  }
+});
 
-The function will automatically include context messages around semantically similar results based on the configured `messageRange`.
+console.log(messages);
+console.log(uiMessages);
+```
 
 ### Related
 

package/CHANGELOG.md

@@ -1,5 +1,12 @@
 # @mastra/mcp-docs-server
 
+## 0.13.22-alpha.0
+
+### Patch Changes
+
+- Updated dependencies [[`5802bf5`](https://github.com/mastra-ai/mastra/commit/5802bf57f6182e4b67c28d7d91abed349a8d14f3), [`5bda53a`](https://github.com/mastra-ai/mastra/commit/5bda53a9747bfa7d876d754fc92c83a06e503f62), [`f26a8fd`](https://github.com/mastra-ai/mastra/commit/f26a8fd99fcb0497a5d86c28324430d7f6a5fb83), [`1a1fbe6`](https://github.com/mastra-ai/mastra/commit/1a1fbe66efb7d94abc373ed0dd9676adb8122454), [`36f39c0`](https://github.com/mastra-ai/mastra/commit/36f39c00dc794952dc3c11aab91c2fa8bca74b11)]:
+  - @mastra/core@0.16.4-alpha.0
+
 ## 0.13.21
 
 ### Patch Changes

package/README.md

@@ -71,6 +71,14 @@ This will make all Mastra documentation tools available in your Windsurf workspa
 Note that Windsurf MCP tool calling doesn't work very well. You will need to fully quit and re-open Windsurf after adding this.
 If a tool call fails you will need to go into Windsurf MCP settings and re-start the MCP server.
 
+### In Claude Code
+
+After installing Claude Code run:
+
+```sh
+claude mcp add mastra-docs -- npx -y @mastra/mcp-docs-server
+```
+
 ### In a Mastra Agent
 
 ```typescript

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mastra/mcp-docs-server",
-  "version": "0.13.21",
+  "version": "0.13.22-alpha.0",
   "description": "MCP server for accessing Mastra.ai documentation, changelogs, and news.",
   "type": "module",
   "main": "dist/index.js",
@@ -33,11 +33,11 @@
     "uuid": "^11.1.0",
     "zod": "^3.25.76",
     "zod-to-json-schema": "^3.24.6",
-    "@mastra/core": "0.16.3",
+    "@mastra/core": "0.16.4-alpha.0",
     "@mastra/mcp": "^0.12.0"
   },
   "devDependencies": {
-    "@hono/node-server": "^1.17.1",
+    "@hono/node-server": "^1.19.1",
     "@types/jsdom": "^21.1.7",
     "@types/node": "^20.19.0",
     "@types/turndown": "^5.0.5",
@@ -50,7 +50,7 @@
     "typescript": "^5.8.3",
     "vitest": "^3.2.4",
     "@internal/lint": "0.0.39",
-    "@mastra/core": "0.16.3"
+    "@mastra/core": "0.16.4-alpha.0"
   },
   "homepage": "https://mastra.ai",
   "repository": {