Skip to main content
Glama
Sign In
obsidian-mcp-pro

obsidian-mcp-pro

by rps321321
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript
Local

List Notes

list_notes
Read-onlyIdempotent

Enumerate markdown notes in a vault or folder as sorted relative paths with total counts, enabling vault browsing, file pickers, and batch-processing target selection.

Instructions

Enumerate every markdown note in the vault (or a single folder), returning a sorted list of relative paths along with the total count. Truncates output to limit entries but still reports the total. Use to browse vault structure, build a file picker, or enumerate targets for batch processing.

Tool call template

This tool declares no required parameters. Add optional parameters from the input schema as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {},
    "name": "list_notes"
  }
}

Input Schema

NameRequiredDescriptionDefault
limitNoMaximum number of note paths to return (1-10000, default: 50). The full total count is still reported separately.
folderNoFolder relative to vault root to restrict the listing (omit to list the entire vault)

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv4.1.1
    • removedInput schema / additionalProperties
      Removed value: -false
  2. Addedv2.0.0
  3. Removedv1.9.0
  4. Addedv0.1.6
  5. Removedv0.1.4
  6. Changed5 schema fields changedv0.1.2
    • changedInput schema / properties / folder / description
      Previous value: -"Folder to list notes from (omit for entire vault)"New value: +"Folder relative to vault root to restrict the listing (omit to list the entire vault)"
    • changedInput schema / properties / limit / description
      Previous value: -"Maximum number of notes to return"New value: +"Maximum number of note paths to return (1-10000, default: 50). The full total count is still reported separately."
    • addedInput schema / properties / limit / maximum
      Added value: +10000
    • addedInput schema / properties / limit / minimum
      Added value: +1
    • changedInput schema / properties / limit / type
      Previous value: -"number"New value: +"integer"
  7. First observedv0.1.0

TDQS

A4.3/5.0
Behavior4/5

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

Annotations already cover read-only, idempotent, closed-world behavior, so the bar is lower; the description still adds real value by disclosing sort order and, importantly, that output is truncated at `limit` while the total count is still reported. The one gap is that no offset/pagination cursor exists, so truncated results cannot be resumed — that limitation is implied but not spelled out.

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?

Two tight sentences: the first covers scope and return shape, the second covers truncation semantics and intended uses. The most decision-relevant fact (what it enumerates) is front-loaded, and nothing is padding.

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?

With no output schema, the description carries the burden of describing return values and does so (sorted relative paths, total count). For a two-parameter, zero-required listing tool with full annotation coverage, nothing an agent needs to call it correctly is missing.

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 both parameters are fully documented in the schema, including the 1-10000 range, default of 50, and the note that the total is still reported. The description's mentions of `limit` and folder scoping essentially restate the schema, so baseline 3 applies.

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?

States a specific verb (enumerate), resource (markdown notes), scope (whole vault or one folder), and even the return shape (sorted relative paths plus total count). This is clearly distinguishable from siblings like search_notes or get_note, which retrieve by query or by identity rather than enumerating the vault.

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?

Gives three concrete use cases: browsing vault structure, building a file picker, and enumerating targets for batch processing. It stops short of naming an alternative and the condition that selects it (e.g., 'for query-based retrieval use search_notes instead'), so it is clear context without explicit exclusions.

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

Deploy Server

Other Tools