List Documents
list_documentsRead-onlyIdempotent
Enumerate documents in the vault by folder or filename pattern. Optionally include non-Markdown attachments. Returns a complete list without body content.
Instructions
List documents (and optionally attachments) in the vault.
Use this to enumerate documents when you need a complete listing, not ranked search results. For finding documents by content, use 'search'. Does NOT include body content — call 'read' for full text.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| folder | No | Return only documents in this folder (e.g. "Journal"). Use folder="" for root-level (top-level) documents only. | |
| pattern | No | Unix glob matched against relative paths (e.g. "Journal/*.md", "**/*meeting*.md"). | |
| include_attachments | No | When True, also returns non-.md files (PDFs, images, etc.) that match the configured allowlist. Each attachment entry includes kind="attachment" and mime_type. Default False (notes only). | |
| wait_for_pending_writes | No | When True, wait until your recent write/edit/delete/rename operations have been applied to the index before answering, so the results reflect those changes. Use it right after modifying notes when this read must see them (e.g. right after a write/edit/delete/rename whose effect this read should reflect). Default False answers immediately from the current index — almost always already up to date; inspect the response's ``_meta.index_stale`` field to tell whether a write was still in flight. Bounded by a server timeout (default 60s); on timeout it answers from the current index rather than waiting longer. |
Output Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |