Get Project Structure
get_structureRetrieve the binder hierarchy of the open Scrivener project to see folders, documents, and their word counts. Obtain document IDs needed for reading, writing, and analysis tools.
Instructions
Return the binder hierarchy of the open project: its folders and documents in tree order, each with id, title, type, depth, and word count. Use this to understand the manuscript layout and to obtain the document ids that read_document, write_document, and the analysis tools require. By default returns a compact flat array of [id, title, type, depth, wordCount, hasChildren] tuples to save tokens; set summaryOnly for just project-level counts. Requires an open project (call open_project first).
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| flat | No | When true (default), return a compact flat array of [id, title, type, depth, wordCount, hasChildren] tuples. When false, return the nested tree object. | |
| folderId | No | ||
| maxDepth | No | Maximum depth to descend into the binder tree, starting at 0 for top-level items. Omit to return the full hierarchy. | |
| summaryOnly | No | When true, skip the tree and return only project-level counts (documents, words) plus title and author. Default false. | |
| includeTrash | No |