Skip to main content
Glama

Get Outgoing Links

vault_get_outgoing_links
Read-onlyIdempotent

Retrieve all outgoing wiki and markdown links from a note, including asset links and broken link detection, to audit dependencies or navigate the vault graph forward.

Instructions

Find all notes and assets a given note links to via outgoing [[wikilinks]] or markdown. Links inside code blocks are ignored; self-links are included.

Example: vault_get_outgoing_links({ path: "Projects/vault-cortex.md" })

When to use: Navigating the graph forward, auditing broken links in one note, or checking dependencies before editing. For incoming links (what links TO a note), use vault_get_backlinks.

Parameters:

  • path is matched against the search index, so the note must be indexed (file watcher processes new/moved files within seconds). A path not in the index returns an empty result (count 0), not an error — indistinguishable from a note with no outbound links.

Returns: JSON with path, outgoing_links (array of { path, title, exists, kind, bytes } sorted by target path), and count. Each link carries exists (boolean) and kind ("note"|"asset"): exists+note = readable via vault_read_note; exists+asset = non-markdown file (.canvas, image, PDF); !exists+note = broken link. bytes is null for broken links and assets.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
pathYesExact vault-relative path including .md extension (e.g. "Projects/vault-cortex.md"). Case-sensitive.
Behavior5/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Annotations already provide readOnlyHint, idempotentHint, and destructiveHint. The description adds critical behavioral details beyond these: ignoring code blocks, including self-links, path matching against search index, empty result vs error distinction, and the full return structure with exists, kind, bytes fields. No contradiction with annotations.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is well-structured with a clear opening, example, usage guidelines, parameter details, and return explanation. Every sentence adds value without redundancy. It is appropriately sized for the tool's complexity.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given the tool has one parameter, the description covers all necessary aspects: behavior (links included/excluded), edge cases (self-links, unreachable notes, broken links), return JSON structure, and differentiation from sibling tools. No gaps remain for an agent to successfully invoke the tool.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters5/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 100% with one parameter described. The description adds meaning beyond schema: exact vault-relative path with .md extension, case-sensitive, note must be indexed, and path not in index returns empty result not error. This provides essential context for correct usage.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description states the tool finds all notes and assets a given note links to via outgoing [[wikilinks]] or [markdown](links). It distinguishes from the sibling vault_get_backlinks by explicitly naming it. This is specific verb+resource with clear differentiation.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines5/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description explicitly states when to use this tool: 'Navigating the graph forward, auditing broken links in one note, or checking dependencies before editing.' It also provides an alternative: 'For incoming links (what links TO a note), use vault_get_backlinks.' This is explicit when-to-use and alternative guidance.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/aliasunder/vault-cortex'

If you have feedback or need assistance with the MCP directory API, please join our Discord server