Vault app tools

browse_vault

Browse Vault. Read-only. Idempotent. Tags: apps-ui.

Open an interactive vault explorer for the user to look through: the file tree, the link graph or one note's relationships.

It shows the vault to the user and returns nothing to read; use search, read, list_documents or get_context for content.

Parameters

Name	Type	Default	Description
path	string \| null	null	Note to open on, such as "Journal/2024-01-15.md"; omit to start from the whole vault.
view	context \| graph \| browse \| note \| null	null	"context" for a note's relationships, "graph" for the link graph, "browse" for the file tree, or "note" for the note itself; omit for "context" with a path and "browse" without.

Returns

• path (str | None): The requested note path, or null if none given.
• view (str): The active view ("context", "graph", "browse", or "note").
• summary (str): Text summary of vault or note state for non-Apps clients.

{"path": "Journal/2024-01-15.md", "view": "graph"}

opens the explorer showing the link graph around that note. Vault explorer walks through the views.

vault_context

Vault Context. Read-only. Idempotent. Visible to: app.

Return the full NoteContext for a note (app-only).

Called by the SPA context card view via app.callServerTool(). Not visible to the LLM.

Parameters

Name	Type	Default	Description
path	string	required	Relative note path (such as "Journal/2024-01-15.md").

Returns

Dict with path, title, folder, frontmatter, modified_at, backlinks, outlinks, similar, folder_notes, and tags; see 'get_context' for field details. Returns {"error": "..."} if the note is not found.

show_context

Context Card. Read-only. Idempotent. Tags: apps-ui.

Open an interactive card for the user showing a note's backlinks, outlinks, similar notes, tags and frontmatter.

It shows the note to the user and returns only counts; use get_context for the data.

Parameters

Name	Type	Default	Description
path	string	required	Path of the note, such as "Journal/2024-01-15.md".

Returns

• path (str): The note path.
• view (str): Always "context".
• summary (str): Text summary with backlink, outlink, and similarity counts.

vault_graph_neighborhood

Graph Neighborhood. Read-only. Idempotent. Visible to: app.

Return the link neighborhood of a note as a node/edge graph (app-only).

Called by the SPA graph view via app.callServerTool(). Not visible to the LLM.

Parameters

Name	Type	Default	Description
path	string	required	Center note path.
depth	integer	1	How many hops to traverse (default 1).
include_semantic	boolean	false	When True, add dashed semantic-similarity edges for each interior node (requires embeddings to be configured; silently omitted when unavailable).
max_nodes	integer	200	Soft cap on returned node count (default 200). BFS and any semantic expansion both stop once the cap is hit; the response sets truncated=True. Bounds dense-vault depth=2 traversals that would otherwise bog down vis-network.

Returns

Dict with:

• nodes (list): List of dicts, each with:

• id (str): Unique identifier for the node.

• label (str): Display name for the node.
• group (str): "note" or "orphan".
• folder (str): Parent folder path.
• backlink_count (int): Number of inbound links.

• note_type (str, optional): The note's OKF type frontmatter value; present only on an active OKF bundle for notes that declare one.

• edges (list): List of dicts, each with:

• from (str): Source node ID.

• to (str): Target node ID.

• type (str): "markdown", "wikilink", "reference", or "semantic".

• truncated (bool): True when BFS hit the max_nodes cap.

vault_graph_hubs

Graph Hubs. Read-only. Idempotent. Visible to: app.

Return the most-linked notes and their connections as a graph (app-only).

Called by the SPA graph view for the hub overview. Not visible to the LLM.

Parameters

Name	Type	Default	Description
limit	integer	20	Max number of hub notes to include.

Returns

Dict with:

• nodes (list): List of dicts, each with:

• id (str): Unique identifier for the node.

• label (str): Display name for the node.
• group (str): "hub" or "note".
• folder (str): Parent folder path.
• backlink_count (int): Number of inbound links.

• note_type (str, optional): The note's OKF type frontmatter value; present only on an active OKF bundle for notes that declare one.

• edges (list): List of dicts, each with:

• from (str): Source node ID.

• to (str): Target node ID.
• type (str): "markdown", "wikilink", or "reference".

vault_list

Vault List. Read-only. Idempotent. Visible to: app.

List folders and notes in a vault directory (app-only).

Called by the SPA browser view via app.callServerTool(). Not visible to the LLM.

Parameters

Name	Type	Default	Description
folder	string \| null	null	Folder to list (root if omitted).

Returns

Dict with:

• folders (list[str]): Direct child folder paths.

• notes (list): Notes directly inside this folder. List of dicts, each with:

• path (str): Relative path of the note.

• title (str): Document title.
• kind (str): "note" or "attachment".

vault_read

Vault Read. Read-only. Idempotent. Visible to: app.

Read a note's full content for preview rendering (app-only).

Called by the SPA browser view via app.callServerTool(). Not visible to the LLM.

Parameters

Name	Type	Default	Description
path	string	required	Relative note path.

Returns

Dict with path, title, frontmatter, content (the full raw file, including the frontmatter block), and modified_at (Unix timestamp), or null if the note is not found.

vault_search

Vault Search. Read-only. Idempotent. Visible to: app.

Search the vault (app-only).

Called by the SPA browser search bar via app.callServerTool(). Not visible to the LLM.

Parameters

Name	Type	Default	Description
query	string	required	Search query string.
mode	keyword \| semantic \| hybrid	"hybrid"	Search mode (keyword, semantic, or hybrid).
limit	integer	20	Max results.

Returns

List of result dicts, each with path (str), title (str), snippet (str, first 200 chars of matched chunk), and score (float). Returns [{"error": "..."}] on search failure.