Search Documentation
Search across all documentation pages
read_document
Read a vault document on demand. Documents contain operational guidance that supplements the server instructions. Types:
- soul -- Agent identity (read-only). Included in session_start by default.
- instructions -- Operational guide: memory protocols, search triggers, task lifecycle, entity conventions.
- skills -- Learned procedures that agents have discovered.
- checks -- Quality gates and validation rules.
The soul document is included in session_start by default. Use this tool to fetch the other documents when needed.
Parameters#
| Parameter | Type | Required | Description |
|---|---|---|---|
| documentType | string | required | Document to read: soul, instructions, skills, checks |
| vaultId | string (UUID) | optional | Vault ID. Defaults to defaultVaultId. |
Returns#
The full document content as markdown text, along with metadata about the document type and vault.
Example#
json
{
"tool": "read_document",
"arguments": {
"documentType": "instructions"
}
}