Memory Metadata Search

Find notes by their structured frontmatter fields instead of (or in addition to) free-text content. Any custom YAML key in a note's frontmatter beyond the standard set (title, type, tags, permalink, schema) is automatically indexed as entity_metadata and becomes queryable.

Project scope

If the project is unknown, discover it with bm_project(command="list"). Pass a nonempty project on every note, folder, context and schema call, even with one project or a qualified memory:// URL. Use the chosen project's name, workspace/project, or external ID; <project> below is a placeholder for it. Recent activity also requires project. Search accepts project for one project, projects for selected projects, or all_projects=True explicitly. Discovery and bundled manuals need no project. Keep the same scope when following returned paths, paginating, or recovering from a refusal.

When to Use

• Filtering by status or priority — find all notes with status: draft or priority: high
• Querying custom fields — any frontmatter key you invent is searchable
• Range queries — find notes with confidence > 0.7 or score between 0.3 and 0.8
• Combining text + metadata — narrow a text search with structured constraints
• Tag-based filtering — find notes tagged with specific frontmatter tags
• Schema-aware queries — filter by nested schema fields using dot notation

The Tool

Use bm_search for ranked results or bm_find for file discovery with selected fields. Pass frontmatter conditions via filters, including tags and status. Omit query (or pass None) for filter-only searches.

Filter Syntax

Filters are a JSON dictionary. Each key targets a frontmatter field; the value specifies the match condition. Multiple keys combine with AND logic.

Equality

{"status": "active"}

Array Contains (all listed values must be present)

{"tags": ["security", "oauth"]}

$in (match any value in list)

{"priority": {"$in": ["high", "critical"]}}

Comparisons ($gt, $gte, $lt, $lte)

{"confidence": {"$gt": 0.7}}

Numeric values use numeric comparison; strings use lexicographic comparison.

$between (inclusive range)

{"score": {"$between": [0.3, 0.8]}}

Null (field missing or explicitly null)

{"owner": null}

Matches notes with no owner key and notes whose owner is explicitly null. Null works only as a plain equality value — inside $in, $between, an array-contains list, or a comparison it is rejected, because those compare against the value and a comparison with null is never true.

Nested Access (dot notation)

{"schema.version": "2"}

Quick Reference

Rules:

• Keys must match [A-Za-z0-9_-]+ (dots separate nesting levels)
• Several operators on one field AND together: {"started": {"$gte": "2026-01-01", "$lt": "2026-02-01"}}
• $in and array-contains require non-empty lists
• $between requires exactly [min, max]
• null is an is-null match and only valid as a plain equality value
• Comparison and $between bounds must be finite numbers — a magnitude no float can hold (a 400-digit integer, which JSON keeps as an ordinary int) is refused rather than compared against an infinite bound
• Metadata filters match Markdown notes only — indexed PDFs, images and other regular files carry no frontmatter and are never hits, not even for null

The leading $ is optional (gte works), but write it for clarity.

Frontmatter fields say when a note was filed or reviewed. To ask what a note claims was true on a date, use observation qualifiers (see memory-notes) and bm_search(valid_at="2026-07-01", project="<project>") or bm_search(valid_overlaps="[2026-07-01,2026-08-01)", project="<project>").

Using bm_search with Metadata

Pass filters to bm_search. Omit query for filter-only searches, or combine text and filters together.

# Filter-only — find all notes with a given status
bm_search(filters={"status": "in-progress"}, project="<project>")

# Filter-only — high-priority specs in a specific project
bm_search(
    filters={"type": "spec", "priority": {"$in": ["high", "critical"]}},
    project="research",
    page_size=10,
)

# Filter-only — notes with confidence above a threshold
bm_search(filters={"confidence": {"$gt": 0.7}}, project="<project>")

# Tags and status use the same filter syntax
bm_search(filters={"status": "active"}, project="<project>")
bm_search(filters={"tags": ["security", "oauth"]}, project="<project>")

# Text search narrowed by metadata
bm_search("authentication", filters={"status": "draft"}, project="<project>")

# Mix text, tags, and an advanced filter
bm_search(
    "oauth flow",
    filters={"tags": ["security"], "confidence": {"$gt": 0.7}},
    project="<project>",
)

Use one filters object for all frontmatter conditions; its keys combine with AND.

Tag Search Shorthand

The tag: prefix in a query converts to a tag filter automatically:

# These are equivalent:
bm_search("tag:tier1", project="<project>")
bm_search(filters={"tags": ["tier1"]}, project="<project>")

# Multiple tags (comma or space separated) — all must match:
bm_search("tag:tier1,alpha", project="<project>")

Example: Custom Frontmatter in Practice

A note with custom fields:

---
title: Auth Design
type: spec
tags: [security, oauth]
status: in-progress
priority: high
confidence: 0.85
---

# Auth Design

## Observations
- [decision] Use OAuth 2.1 with PKCE for all client types #security
- [requirement] Token refresh must be transparent to the user

## Relations
- implements [[Security Requirements]]

Queries that find it:

# By status and type
bm_search(filters={"status": "in-progress", "type": "spec"}, project="<project>")

# By numeric threshold
bm_search(filters={"confidence": {"$gt": 0.7}}, project="<project>")

# By priority set
bm_search(filters={"priority": {"$in": ["high", "critical"]}}, project="<project>")

# By tag shorthand
bm_search("tag:security", project="<project>")

# Combined text + metadata
bm_search("OAuth", filters={"status": "in-progress"}, project="<project>")

Guidelines

• Use metadata search for structured queries. If you're looking for notes by a known field value (status, priority, type), metadata filters are more precise than text search.
• Use text search for content queries. If you're looking for notes about something, text search is better. Combine both when you need precision.
• Custom fields are free. Any YAML key you put in frontmatter becomes queryable — no schema or configuration required.
• Multiple filters are AND. {"status": "active", "priority": "high"} requires both conditions.
• Omit query for filter-only searches. bm_search(filters={"status": "active"}, project="<project>") works without a text query.
• Dot notation for nesting. Access nested YAML structures with dots: {"schema.version": "2"} queries the version key inside a schema object.
• Use the same filters for file discovery. bm_find(filters={"status": "active"}, fields=["title", "priority"], project="<project>") returns selected frontmatter values without reading each note.