Skip to content

Vault Tools

All tool paths are vault-relative. Absolute paths and .. escapes are rejected.

Paths matched by the ignore list report as not found, so the agent cannot read, list, search, or edit them.

Read-only tools

ToolWhat it does
readRead a note's contents, optionally bounded with startLine/endLine or byte offset/limit.
vault_inspectRead-only meta-tool for vault context. Use action=list to list a folder, action=search to search file names and contents, action=active_note to read the active note, action=local_graph for a note's link neighborhood, or action=properties to read YAML frontmatter.

Read-only tools run without approval unless working-directory scoping requires an outside-folder confirmation.

Mutating tools

ToolWhat it does
writeCreate or overwrite a note.
editReplace exact strings within a note.
set_propertiesWrite YAML frontmatter through Obsidian APIs.
renameRename or move a note and preserve inbound wikilinks and backlinks.
deleteMove a note or empty folder to trash.

Mutating tools are controlled by the approval policy and can be reverted with /undo when they are the latest agent vault mutation.

Compatibility tools

The following tools remain implemented for backward compatibility but are not sent to the model by default. The preferred surface is vault_inspect.

ToolStatusPreferred replacement
lsCompatibilityvault_inspect with action=list
searchCompatibilityvault_inspect with action=search
findCompatibilityvault_inspect with action=search and kind=files
grepCompatibilityvault_inspect with action=search and kind=content
get_active_noteCompatibilityvault_inspect with action=active_note
get_backlinksCompatibilityvault_inspect with action=local_graph
get_linksCompatibilityvault_inspect with action=local_graph
local_graphCompatibilityvault_inspect with action=local_graph
get_propertiesCompatibilityvault_inspect with action=properties

If a compatibility tool is explicitly enabled in settings, it behaves the same as before. vault_inspect is the default surface for new setups.

Released under the MIT License.