enquire-mcp API reference - v4.0.0-rc.7
    Preparing search index...

    Function vaultShape

    • Report which frontmatter keys exist in the vault, how often, and what they hold.

      Every other frontmatter tool requires the key as an argument, which is only answerable by someone who already knows the vault. This answers the question that comes first — what is there to ask about — by enumeration rather than ranking, so the result is exhaustive within its bounds rather than a best guess.

      The walk is bounded like every other whole-vault scan and refuses rather than silently reporting a prefix: an inventory that quietly omits keys is worse than no inventory, because a caller cannot tell the difference between "this key does not exist" and "the scan stopped early".

      Honors --exclude-glob / --read-paths: a key that occurs only in filtered notes is not reported, exactly as its notes are not searchable.

      Parameters

      • vault: Vault

        Vault to inventory.

      • args: { folder?: string; limit?: number; min_count?: number }

        Optional folder scope, minimum occurrence count, and result cap.

      • OptionallimitOverrides: Partial<VaultShapeLimits>

        Test-only narrowing of the production scan envelope.

      Returns Promise<FrontmatterKeySummary[]>

      Keys sorted by frequency, then name.

      If the bounded walk cannot complete, or the key inventory exceeds its distinct-key or aggregate-byte envelope.

      await vaultShape(vault, { min_count: 2 });
      // [{ key: "status", count: 41, types: ["string"], examples: ["open", "done"] }]