Skip to main content
Glama
ferronicardoso

mcp-obsidian

list_notes

Lists markdown notes in an Obsidian vault, optionally within a specified subfolder, excluding hidden directories like .obsidian, .git, and .trash.

Instructions

Lists the vault's notes (.md), optionally restricted to a subfolder. Ignores hidden folders (.obsidian, .git, .trash).

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
folderNoSubfolder relative to the vault to restrict the listing to (default: vault root)

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.0.0

TDQS

A4.2/5.0
Behavior4/5

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

Since no annotations are provided, the description carries full burden. It discloses that hidden folders are ignored, which is a behavioral trait an agent must know. It also indicates it only lists .md files. This is beyond the basic operation, though it doesn't mention sorting, depth, or recursion, which are minor.

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 two sentences long, with no fluff. The primary action and restriction are front-loaded, and the hidden-folder note is appended as a caveat. Every word earns its place.

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

Completeness4/5

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

For a simple listing tool with one optional parameter and no output schema, the description is complete. It covers the core behavior, file type, and hidden-folder exclusion. It doesn't specify return format or pagination, but these are likely inferable for a list operation, and no annotations are needed.

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 coverage is 100%, so the single parameter 'folder' is fully documented in the schema. The description adds the meaning of 'subfolder relative to the vault' and default root behavior, which is helpful but not extensive. Baseline 3 is appropriate.

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 verb 'Lists', the resource 'vault's notes (.md)', and the optional restriction to a subfolder. It also explicitly notes the file extension and hidden folder exclusions, which distinguishes it from siblings like read_note and search_notes.

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 implies usage: it lists notes, optionally in a subfolder. It does not explicitly state when to choose this over search_notes or read_note, but the mention of 'listing' and 'subfolder' gives clear context. No alternatives are named, but the purpose is distinct enough.

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