Backlinks
get_backlinksRetrieve all documents that link to a specified document, uncovering implicit cross-references and relationships.
Instructions
Find all documents that link TO the given document (backlinks).
Use this to discover which notes reference a particular document. For a full picture of a note's place in the vault (backlinks, outlinks, similar notes, folder peers), use 'get_context' instead of calling this separately. Call 'get_backlinks' directly when you only need the inbound link list. Backlinks reveal implicit relationships that search alone cannot surface — they show what other authors considered relevant to this document.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| path | Yes | Relative path of the target document (e.g. "notes/topic.md"). Case-sensitive. | |
| limit | No | Maximum number of backlinks to return. Omitted (the default) returns all. | |
| wait_for_pending_writes | No | When True, wait until your recent write/edit/delete/rename operations 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 write/edit/delete/rename 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
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |