Broken Links
get_broken_linksRead-onlyIdempotent
Find all links in your Markdown vault that point to deleted, renamed, or non-existent documents. Use it to audit link health and identify broken references after edits or renames.
Instructions
Find all links that point to non-existent documents (broken links).
Use this to audit link health across the vault. Call this when 'stats' shows broken_link_count > 0, or after a 'rename' that did not use update_links=True, to see what links were left pointing to the old path. A broken link means the target path does not match any indexed document — the referenced note may have been deleted, renamed, or never created.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| folder | No | Optional folder filter. When provided, only checks links from documents in this folder (e.g. "Journal"). Without this, checks all documents. | |
| 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
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |