Skip to main content
Glama

Engram Obsidian Memory Sync

List Folder Contents

list_folder
Read-onlyIdempotent

List the notes, attachments, and subfolders directly inside one folder. Pass an empty string for the vault root. Set recursive: true to list every descendant folder (with note counts) instead of just the direct ones. To see every folder in the vault with counts call list_folder with recursive: true on the root. Notes come in pages: when next_cursor is not null, call again with that cursor for more. To find notes by content use search_notes.

Input Schema

NameRequiredDescriptionDefault
limitNoNotes per page. Defaults to 200, at most 1000.
cursorNonext_cursor from the previous call, to get the next page of notes. Omit for the first page. Keep following until next_cursor is null.
folderNoFolder path (e.g. "Health") or "" for root. Defaults to root.
vault_idNoTarget vault: its name (e.g. "Engram") or its UUID. REQUIRED when you own more than one vault; the server keeps no active-vault state between calls, so it must be passed on every vault-scoped call. Omit only if you have a single vault. Call list_vaults if a name does not resolve.
recursiveNoList every descendant folder, not just direct subfolders. Defaults to false.

Output Schema

NameRequiredDescriptionDefault
notesYes
folderYesFolder listed; "" is the root
foldersYesDirect subfolders, or every descendant when recursive was true.
truncatedYesTrue while more notes remain (next_cursor is not null): this page is not the whole folder.
attachmentsYes
next_cursorYesPass as cursor to list the next page of notes; null on the last page. Attachments and subfolders are returned on the first page only.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed5 schema fields changed
    • addedInput schema / properties / cursor
      Added value: +{
      +  "description": "next_cursor from the previous call, to get the next page of notes. Omit for the first page. Keep following until next_cursor is null.",
      +  "type": "string"
      +}
    • addedInput schema / properties / limit
      Added value: +{
      +  "description": "Notes per page. Defaults to 200, at most 1000.",
      +  "type": "integer"
      +}
    • addedOutput schema / properties / next_cursor
      Added value: +{
      +  "description": "Pass as cursor to list the next page of notes; null on the last page. Attachments and subfolders are returned on the first page only.",
      +  "type": [
      +    "string",
      +    "null"
      +  ]
      +}
    • addedOutput schema / properties / truncated
      Added value: +{
      +  "description": "True while more notes remain (next_cursor is not null): this page is not the whole folder.",
      +  "type": "boolean"
      +}
    • changedOutput schema / required
      Previous value: -[
      -  "folder",
      -  "notes",
      -  "attachments",
      -  "folders"
      -]New value: +[
      +  "folder",
      +  "notes",
      +  "attachments",
      +  "folders",
      +  "next_cursor",
      +  "truncated"
      +]
  2. Changed6 schema fields changed
    • addedInput schema / additionalProperties
      Added value: +false
    • changedInput schema / properties / folder / description
      Previous value: -"Folder path (e.g. \"Health\") or \"\" for root"New value: +"Folder path (e.g. \"Health\") or \"\" for root. Defaults to root."
    • addedInput schema / properties / recursive
      Added value: +{
      +  "description": "List every descendant folder, not just direct subfolders. Defaults to false.",
      +  "type": "boolean"
      +}
    • removedInput schema / required
      Removed value: -[
      -  "folder"
      -]
    • addedOutput schema / properties / folders
      Added value: +{
      +  "description": "Direct subfolders, or every descendant when recursive was true.",
      +  "items": {
      +    "properties": {
      +      "count": {
      +        "description": "Notes directly inside",
      +        "type": "integer"
      +      },
      +      "folder": {
      +        "type": "string"
      +      }
      +    },
      +    "required": [
      +      "folder",
      +      "count"
      +    ],
      +    "type": "object"
      +  },
      +  "type": "array"
      +}
    • changedOutput schema / required
      Previous value: -[
      -  "folder",
      -  "notes",
      -  "attachments"
      -]New value: +[
      +  "folder",
      +  "notes",
      +  "attachments",
      +  "folders"
      +]
  3. Changed1 schema field changed
    • changedInput schema / properties / vault_id / description
      Previous value: -"Target vault — its name (e.g. \"Engram\") or its UUID. REQUIRED when you own more than one vault — the server keeps no active-vault state between calls, so it must be passed on every vault-scoped call. Omit only if you have a single vault. Call list_vaults if a name does not resolve."New value: +"Target vault: its name (e.g. \"Engram\") or its UUID. REQUIRED when you own more than one vault; the server keeps no active-vault state between calls, so it must be passed on every vault-scoped call. Omit only if you have a single vault. Call list_vaults if a name does not resolve."
  4. First observed

TDQS

A4.7/5.0
Behavior4/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Annotations already cover safety (readOnlyHint, idempotentHint, destructiveHint=false), so the bar is lower, and the description still adds real operational behavior: notes are paged and must be re-called with next_cursor until it is null, and recursive mode returns note counts. It stops short of saying whether attachments or folders are also paginated or what the non-recursive response looks like, which keeps this below a 5.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Front-loaded with the core action, then each subsequent sentence handles one concern: root convention, recursive mode, whole-vault pattern, pagination loop, and the search alternative. No sentence is redundant and none re-states the annotation boilerplate.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a 5-parameter read tool with an output schema, the description covers the remaining risk areas: pagination termination, root addressing, recursive semantics, and cross-tool routing. Return-value detail is properly delegated to the output schema, so nothing an agent needs to call this correctly is missing.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 100%, so the schema already documents every parameter and a 3 is the floor. The description adds meaning beyond it by giving the folder root convention and, notably, the composed behavior of combining recursive:true with the root to enumerate all folders with counts — a usage pattern no single parameter description conveys.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

Specific verb ("List") plus clearly scoped resource: notes, attachments, and subfolders directly inside one folder. It distinguishes itself from siblings by naming search_notes for content lookup and by defining what recursive mode returns, so an agent can place it against list_tags, get_notes, and search_notes without opening schemas.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines5/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Explicit when-to-use rules: empty string for root, recursive:true for descendants or a whole-vault folder tree, follow next_cursor until null, and use search_notes for content-based lookup. It names the alternative tool and the condition that selects it rather than leaving the choice implicit.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.