Skip to main content
Glama

list_notes

Retrieve all markdown notes in your vault, specifying an optional folder to narrow the list. Get relative paths for each note to easily locate and manage your documentation.

Instructions

List all markdown notes in the vault, optionally scoped to a folder.

Args: folder: Subfolder to list notes from (relative to vault root). If empty, lists all notes in the vault.

Returns: Newline-separated list of note paths relative to vault root.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
folderNo

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.3.1

TDQS

A4.6/5.0
Behavior4/5

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

No annotations are provided, so the description carries the full burden. It discloses that the tool only returns markdown note paths, scopes to a folder if supplied, omits the folder scope when empty, and returns newline-separated paths relative to vault root. This is reasonably transparent for a read-only listing operation, though it does not mention edge cases like invalid folders or recursive traversal.

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?

The description is compact and well-structured, with a one-sentence summary followed by clear Args and Returns sections. Every sentence adds necessary information, and the main purpose is front-loaded.

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 simple list tool with one optional parameter and no annotations, the description covers purpose, parameter semantics, scoping behavior, and return format. Nothing critical is missing for an agent to select and invoke this tool correctly.

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

Parameters5/5

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

The schema provides no description for the 'folder' parameter, but the description fully compensates: it defines the parameter as a subfolder relative to vault root, explains the empty case, and clarifies the output semantics. This gives the agent everything needed to understand and supply the parameter correctly.

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?

The description clearly states the specific action ('List all markdown notes in the vault') and the optional scope ('scoped to a folder'). This distinguishes it from sibling tools like list_folders (folders, not notes) and search_notes (content search, not listing).

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

Usage Guidelines4/5

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

The description gives clear context for when the tool is useful: listing all notes or notes within a specific subfolder. It does not explicitly name alternatives or exclusions, but the behavior is straightforward enough that an agent can infer appropriate usage.

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