Outlinks
get_outlinksRead-onlyIdempotent
Retrieve every outbound link from a document to other notes in a Markdown vault. The exists flag reveals broken links when a target is missing.
Instructions
Find all links FROM the given document to other documents (outlinks).
Use this to see what a document references. For a full picture of a note's place in the vault, use 'get_context' instead of calling this separately. Call 'get_outlinks' directly when you only need the outbound link list. Each result includes an 'exists' flag — False means the link is broken (the target is missing from the vault).
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| path | Yes | Relative path of the source document (e.g. "notes/topic.md"). Case-sensitive. | |
| limit | No | Maximum number of outlinks to return. Omitted (the default) returns all. | |
| 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 |