SiYuan Document Tool icon

SiYuan Document Tool

Use this tool to create, read, list, and manage documents in the SiYuan knowledge base. Use "getContent" to read a document, "create" to write a new one, "listInNotebook" to browse, or "exportMd" for full markdown export.

List in Notebook

AI-generated

Summary

Lists document files in the specified SiYuan notebook, returning each document’s ID, filename, title, update time, and file flags. The node reads top-level .sy files from the notebook’s data directory and looks up each title from its block attributes, falling back to the document ID if that lookup fails or has no title.

Inputs

  • Notebook ID (required) — The unique ID of the notebook to list.

Output shape

A list of document records, with one record for each top-level .sy file found in the notebook.

Each record contains id, name, title, updated, isDir, and isSymlink. The operation returns an empty list if the directory response is not an array or contains no .sy files. The node emits this list as the item’s JSON result.

Links

Discussion