52 lines
1.2 KiB
Markdown
52 lines
1.2 KiB
Markdown
# ReadUserMemory
|
|
|
|
Loads a specific memory entry from the caller's personal user folder.
|
|
|
|
## Overview
|
|
|
|
Memory entries are stored in `data/users/{userId}/memory/{name}.md`. Each file has YAML frontmatter (`name`, `description`, `type`) and a plain Markdown body.
|
|
|
|
The MEMORY.md index (injected into system prompt automatically) gives a one-line summary per entry. Use `ReadUserMemory` when you need the full body of a specific fact.
|
|
|
|
---
|
|
|
|
## Usage
|
|
|
|
```json
|
|
{
|
|
"name": "preferred-language"
|
|
}
|
|
```
|
|
|
|
**Response example:**
|
|
|
|
```
|
|
# Memory: preferred-language
|
|
**Type**: user
|
|
**Description**: User prefers Japanese output
|
|
|
|
Always respond in Japanese unless the user explicitly asks for another language.
|
|
```
|
|
|
|
---
|
|
|
|
## Parameters
|
|
|
|
| Parameter | Type | Required | Description |
|
|
|-----------|------|----------|-------------|
|
|
| `name` | string | Yes | Entry identifier to load (no `.md` extension) |
|
|
|
|
---
|
|
|
|
## Error cases
|
|
|
|
- Returns an error if `name` does not exist in the memory folder.
|
|
- Returns an error if no user is authenticated.
|
|
|
|
---
|
|
|
|
## Related tools
|
|
|
|
- `UpdateUserMemory` — create, update, or delete memory entries.
|
|
- `ReadToolDoc({ name: "UpdateUserMemory" })` — full authoring guide.
|