maestro/docs/tools/readusermemory.md
clade 7049a874f3 feat: initial public release (MAESTRO v0.1.0)
Open-source release of MAESTRO, an agent orchestration platform that runs
LLM-driven tasks through sandboxed tools, with a web UI. Apache-2.0.
See README.md and docs/ (getting-started, configuration, architecture).
2026-06-03 04:01:14 +00:00

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.