Skip to main content
Glama

list_notes

Retrieve notes from your Obsidian vault or specific folders to organize and access your knowledge base efficiently.

Instructions

List all notes in the vault or a specific folder

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
folderNoFolder to list notes from (omit for entire vault)
limitNoMaximum number of notes to return

Implementation Reference

  • The `listNotes` function scans the vault directory recursively for files ending in `.md` and returns a sorted list of their relative paths, excluding specified directories.
    export async function listNotes(
      vaultPath: string,
      folder?: string,
    ): Promise<string[]> {
      const baseDir = folder
        ? resolveVaultPath(vaultPath, folder)
        : path.resolve(vaultPath);
    
      let entries: string[];
      try {
        entries = await fs.readdir(baseDir, { recursive: true }) as unknown as string[];
      } catch (err) {
        if ((err as NodeJS.ErrnoException).code === "ENOENT") {
          return [];
        }
        throw err;
      }
    
      const notes: string[] = [];
      for (const entry of entries) {
        const normalized = entry.replace(/\\/g, "/");
        if (!normalized.endsWith(".md")) continue;
    
        const relativeFromVault = folder
          ? `${folder}/${normalized}`.replace(/\\/g, "/")
          : normalized;
    
        if (isExcluded(relativeFromVault)) continue;
        notes.push(relativeFromVault);
      }
    
      return notes.sort();
    }
Behavior2/5

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

No annotations are provided, so the description carries full burden. It states the action but doesn't disclose behavioral traits such as whether it's read-only, pagination details beyond the limit parameter, rate limits, or authentication needs. This is inadequate for a tool with no annotation coverage.

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 a single, efficient sentence with zero waste. It's front-loaded with the core purpose and includes essential scope details, making it highly concise and well-structured.

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

Completeness3/5

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

Given no annotations and no output schema, the description is minimal. It covers the basic purpose and parameter hints, but lacks details on behavior, return values, or error handling. This is adequate for a simple list tool but leaves gaps in completeness.

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

Parameters3/5

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

Schema description coverage is 100%, so the schema already documents both parameters fully. The description adds minimal value by hinting at the folder parameter's usage ('omit for entire vault'), but doesn't provide additional semantics beyond what the schema specifies. Baseline 3 is appropriate.

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

Purpose4/5

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

The description clearly states the verb ('List') and resource ('notes'), specifying scope ('all notes in the vault or a specific folder'). It distinguishes from siblings like 'search_notes' by implying a comprehensive listing rather than filtered search, though not explicitly contrasting them.

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

Usage Guidelines3/5

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

Usage is implied by the description's scope ('entire vault' vs. 'specific folder'), but there's no explicit guidance on when to use this tool versus alternatives like 'search_notes' or 'get_note'. It mentions the folder parameter's purpose but lacks context on prerequisites or exclusions.

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

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/rps321321/obsidian-mcp-pro'

If you have feedback or need assistance with the MCP directory API, please join our Discord server