Similar Notes
get_similarRead-onlyIdempotent
Find notes semantically similar to a reference document using stored embeddings. Excludes the reference itself and returns an empty list if semantic search is not configured.
Instructions
Find notes most semantically similar to the given document.
Uses stored embedding vectors — no re-embedding needed. The reference document is excluded from results. Requires semantic search to be configured (check 'stats' for semantic_search_available). Returns an empty list if embeddings are not configured (check 'embeddings_status') or the document has no stored vectors (call 'build_embeddings' to embed missing chunks).
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| path | Yes | Relative path of the reference document (e.g. "notes/topic.md"). Case-sensitive. | |
| limit | No | Maximum number of similar notes to return (default 10). | |
| folder | No | Restrict results to this folder (exact match or sub-folder prefix), e.g. "3-Resources". Useful to scope link candidates to one part of the vault. Use folder="" for root-level (top-level) documents only. | |
| filters | No | Frontmatter equality filters, ANDed — e.g. {"type": "resource"}. Matched post-hoc against each candidate's full frontmatter, so any frontmatter key works (unlike keyword 'search' filters, which are limited to indexed_frontmatter_fields). List-valued fields match if the value is among them. On an OKF bundle three keys carry OKF semantics, exactly as in 'search': status ("stable" also matches notes without a status field), stale ("true"/"false"), and trust_tier. | |
| chunks_per_file | No | Maximum sections returned per file (default 2). Set to 1 for one best section per file. Must be >= 1. | |
| wait_for_pending_writes | No | When True, wait until your recent document mutations have been applied to the index before answering, so the results reflect those changes. Use it right after modifying notes when this read must see them (e.g. right after a document mutation whose effect this read should reflect). Default False answers immediately from the current index — almost always already up to date; inspect the response's ``_meta.index_stale`` field to tell whether a write was still in flight. Bounded by a server timeout (default 60s); on timeout it answers from the current index rather than waiting longer. |
Output Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |