Skip to main content
Glama
shaynemeyer

obsidian-mcp

by shaynemeyer

obsidian_list_notes

Read-onlyIdempotent

List notes and folders in an Obsidian vault, optionally scoped to one folder, to discover its structure before reading or writing.

Instructions

List notes and folders in the vault, optionally scoped to one folder.

Use this to discover the vault's structure before reading or writing. For finding a note by its contents, obsidian_search_notes is faster.

Args: params (ListNotesInput): - folder (str): Vault-relative folder, empty for the root - recursive (bool): Walk nested folders too - response_format (str): 'markdown' or 'json'

Returns: str: Markdown list, or JSON of the shape {"folder": str, "count": int, "backend": "rest"|"filesystem", "entries": [{"path": str, "is_folder": bool, "size_bytes": int, "modified_at": str}]} On failure: "Error: "

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
paramsYes

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A4.4/5.0
Behavior4/5

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

Annotations already declare readOnlyHint, idempotentHint, and destructiveHint, so safety is known. The description adds value by detailing the output format (markdown or JSON), including the JSON structure and error format, which are not in annotations. It does not contradict annotations and offers meaningful behavioral context.

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 concise, front-loaded with the main purpose and usage guidance, then structured args and returns. Every sentence carries meaningful information, with no fluff or repetition. The layout is clear and aids quick scanning.

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?

The description covers the tool's purpose, usage context, parameters (mostly), return format, and error handling. The missing vault parameter is present in the schema with a clear description, so an agent can still find it. Given the many siblings, it explicitly mentions one relevant alternative, which is sufficient. Slight gap in not listing all params in prose, but overall adequate.

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 0% (the top-level 'params' property lacks description), so the tool description must compensate. It covers folder, recursive, and response_format but omits the 'vault' parameter. It adds brief explanations but not as detailed as the schema's own properties (e.g., folder examples). This is partially compensating but not fully covering all parameters, so a score of 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 action ('List notes and folders in the vault') with the resource (vault) and optional scoping. It differentiates from sibling obsidian_search_notes by noting that content search is better served there, making its purpose distinct and unambiguous.

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?

The description explicitly advises using this tool to 'discover the vault's structure before reading or writing' and explicitly redirects content lookups to 'obsidian_search_notes is faster.' This provides clear when-to-use and when-not-to-use guidance, exceeding a generic statement.

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