Skip to main content
Glama
aliasunder

Vault Cortex Obsidian MCP Server

by aliasunder
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript
Hybrid

List Property Keys

vault_list_property_keys
Read-onlyIdempotent

List all frontmatter property keys in an Obsidian vault with note counts and sample values to reveal the metadata schema before searching by property.

Instructions

Discover all property keys in the vault with note counts and sample values. Lets you understand the vault's metadata schema without reading individual notes.

Example: vault_list_property_keys() returns [{ key: "tags", count: 342, sample_values: ["session-log", "project"] }, ...]

When to use: Discovering what properties exist before searching by property. Good first step for vault orientation alongside vault_list_tags. Prefer vault_list_property_values when you need the full list of values for a specific key. Prefer vault_search_by_property to find notes matching a specific key-value pair.

Parameters:

  • folder names a whole folder and includes its subfolders: "Projects" covers "Projects/Archive" but not "ProjectsOld/". Matching ignores ASCII letter case; omit folder to scan the entire vault.

Behavior:

  • Only frontmatter properties count; inline Dataview fields (key:: value) are not listed.

  • count is the number of notes that have the key, including notes where its value is empty (null).

  • sample_values are the key's 3 most frequent displayed strings. Values with the same string are grouped before choosing samples, counting each array element separately; ties use binary text order.

  • Checkbox values appear as "1" and "0"; null values are skipped.

Errors:

  • An empty vault or folder returns an empty array, not an error.

Returns: JSON array of { key, count, sample_values } sorted by count descending, then by key.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
folderNoRestrict to a folder (e.g. "Projects")

Schema Changelog

Changes observed during successful MCP inspections.

  1. Addedv0.32.1
  2. Removedv0.32.0
  3. Changed1 schema field changedv0.22.1
    • addedInput schema / properties / folder / minLength
      Added value: +1
  4. Added

TDQS

A4.9/5.0
Behavior5/5

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

Annotations already cover the safety profile (readOnly, idempotent, non-destructive), and the description adds substantial context beyond that: only frontmatter counts (inline Dataview ignored), count includes null-valued notes, sample_values selection rules and tie-breaking, checkbox rendering as '1'/'0', and the empty-vault behavior. This genuinely enriches understanding rather than repeating annotations.

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?

Front-loaded with purpose and example, then organized under When to use / Parameters / Behavior / Errors / Returns. Long but every section carries needed information, and the header structure makes it skimmable.

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?

No output schema exists, but the description fully specifies the return shape (JSON array of {key, count, sample_values}, sorted by count desc then key) and error behavior. For a single-param read tool, nothing an agent needs is missing.

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

Parameters4/5

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

Schema coverage is 100% and the single param has a terse schema description, but the description adds real meaning: folder includes subfolders ('Projects' covers 'Projects/Archive' but not 'ProjectsOld/'), matching is ASCII-case-insensitive, and omitting folder scans the whole vault. This goes beyond the schema text, though it is a single parameter.

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+resource ('Discover all property keys in the vault with note counts and sample values') and scopes it as metadata-schema inspection without reading notes. The example concretely anchors the shape. Clearly distinguishable from siblings like vault_list_tags and vault_list_property_values.

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?

Explicit 'When to use' plus two named alternatives with the conditions that select them: vault_list_property_values for values of a specific key, vault_search_by_property for key-value matching. Nothing is left to inference.

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