-
Notifications
You must be signed in to change notification settings - Fork 0
Tool Reference
Suavecito edited this page Jul 3, 2026
·
3 revisions
105 tools across 28 domains. Canonical spec with full ACL / HITL / idempotency / rate-limit annotations and I/O schemas: docs/G2.1-tools.md. This page is the at-a-glance index.
Every tool carries four annotations enforced by the dispatch pipeline: acl (read / write / delete / execute / admin), hitl (never / required / conditional), idem (pure / natural / keyed / non-idem), and ratelimit (read / write / bulk). See Security and ACL.
| Tool | Description |
|---|---|
list_vaults |
List configured vaults and their states |
get_vault |
Inspect a single vault's config and state |
reload_vault |
Re-read vault config from disk (does NOT touch cache) |
reset_vault_cache |
Drop the SQLite cache for a vault (HITL-required) |
| Tool | Description |
|---|---|
read_note |
Read a note's full content + frontmatter |
read_notes |
Batch-read up to 50 notes |
list_notes |
List notes under a directory with filters |
note_exists |
Check existence without reading |
write_note |
Write full content (create / overwrite / upsert modes) |
append_note |
Append or prepend content to a note |
patch_note |
Replace a unique string within a note |
delete_note |
Soft-delete to .trash/ by default; hard-delete with explicit flag |
move_note |
Move/rename + update incoming wikilinks |
copy_note |
Copy with optional wikilink path-rewriting |
| Tool | Description |
|---|---|
read_frontmatter |
Get frontmatter without reading body |
read_property |
Get a single property value |
update_frontmatter |
Update frontmatter (set / remove / merge / replace modes) |
list_properties |
Aggregate property usage across the vault |
find_notes_by_property |
Filter notes by frontmatter values (typed comparators) |
| Tool | Description |
|---|---|
list_tags |
Aggregate all tags (frontmatter + inline) with counts |
get_note_tags |
Read all tags on a single note (inline + frontmatter) |
add_tag |
Add a tag to a note |
remove_tag |
Remove a tag from any/all locations |
find_notes_by_tag |
Find notes carrying a tag (hierarchical match) |
| Tool | Description |
|---|---|
get_outgoing_links |
Wikilinks + markdown links from a note (with resolution status) |
get_backlinks |
Notes linking to this note |
find_orphans |
Notes with zero incoming links |
find_unresolved_links |
Wikilinks pointing at nothing |
rewrite_link |
Rename a wikilink target across the vault |
prune_hub_links |
Reduce a hub note's outgoing links via a caller-supplied policy |
| Tool | Description |
|---|---|
search_vault |
Unified search dispatch (mode router) |
search_text |
Literal text search (FTS5 / filesystem fallback) |
search_regex |
Regex pattern across vault files |
search_semantic |
Dense-vector retrieval over the chunk store |
search_jsonlogic |
Structured frontmatter + content filter via JSONLogic |
search_dql |
Dataview DQL query (proxied to companion plugin) |
index_vault |
Chunk + embed the vault (or a folder) into the search index |
| Tool | Description |
|---|---|
read_base |
Read a .base file's structure |
create_base |
Create a new .base file |
update_base |
Patch a base's source/views/filters |
query_base |
Execute a base view and return resolved rows |
| Tool | Description |
|---|---|
read_canvas |
Parse a .canvas into nodes + edges |
create_canvas |
Create a new canvas with initial nodes/edges |
update_canvas |
Patch nodes/edges (add / remove / update by id) |
query_canvas |
Find nodes matching criteria across canvases |
| Tool | Description |
|---|---|
read_excalidraw |
Read a drawing's raw elements + extracted text |
create_excalidraw |
Create a new Excalidraw note |
update_excalidraw |
Add/remove elements in an existing drawing |
| Tool | Description |
|---|---|
validate_dql |
Parse a DQL query without executing it |
eval_dataview_field |
Evaluate a Dataview field expression against a note |
| Tool | Description |
|---|---|
list_tasks |
List tasks across the vault with typed filters |
update_task |
Modify a task in place (status, due date, priority) |
tasks_filter |
Run a Tasks plugin filter expression |
| Tool | Description |
|---|---|
get_periodic_note |
Get the periodic note for a period+date (no creation) |
create_periodic_note |
Create the periodic note for a period+date |
find_or_create_periodic_note |
One-shot get-or-create |
append_to_periodic_note |
Append to today's (or a date's) periodic note, creating if needed |
list_periodic_notes |
Enumerate periodic notes in a date range |
| Tool | Description |
|---|---|
list_templates |
List Templater templates with parsed metadata |
execute_template |
Run a template and write output to a target path |
| Tool | Description |
|---|---|
list_quickadd_actions |
Enumerate configured QuickAdd actions |
trigger_quickadd |
Fire a QuickAdd action by name |
| Tool | Description |
|---|---|
ocr_attachment |
Run OCR on a single image or PDF attachment |
ocr_bulk |
OCR a batch of attachments with throttling |
| Tool | Description |
|---|---|
bundle_folder |
Aggregate all notes under a folder into one markdown bundle |
bundle_files |
Aggregate an explicit list of paths into a bundle |
| Tool | Description |
|---|---|
makemd_list_spaces |
Enumerate make.md spaces |
makemd_query |
Run a make.md query against a space |
| Tool | Description |
|---|---|
list_workspaces |
List saved Obsidian workspaces |
open_workspace |
Switch to a saved workspace layout |
save_workspace |
Save the current layout under a name |
| Tool | Description |
|---|---|
list_bookmarks |
Read all bookmarks |
add_bookmark |
Create a bookmark |
remove_bookmark |
Delete a bookmark by id |
| Tool | Description |
|---|---|
list_attachments |
Enumerate attachment files under a path |
get_attachment |
Read attachment metadata + optional inline base64 |
move_attachment |
Move an attachment and rewrite all references |
delete_attachment |
Delete an attachment, optionally checking reference count |
| Tool | Description |
|---|---|
enqueue_capture |
Stage content for later commit (SQLite capture_queue, no vault write) |
list_capture_queue |
List pending captures |
commit_capture |
Move a queued capture to a vault path |
| Tool | Description |
|---|---|
create_entity |
Create a new memory entity |
get_entity |
Read an entity by id or by (type, name) |
add_observation |
Append a fact to an entity |
link_entities |
Create a typed relation between two entities |
query_entity_graph |
Traverse the graph from a seed entity (BFS, depth-limited) |
| Tool | Description |
|---|---|
start_session |
Begin a workspace-memory session (per vault) |
end_session |
Finalize a session, flush in-flight JSONL records |
get_session_traces |
Replay JSONL trace events from a session or date window |
| Tool | Description |
|---|---|
plur_recall |
BM25 keyword recall over engrams |
plur_recall_hybrid |
BM25 + embeddings via RRF |
plur_similarity_search |
Cosine similarity over engram embeddings |
plur_get |
Fetch a specific engram by id |
| Tool | Description |
|---|---|
bulk_create_notes |
Batch note creation with per-item results |
bulk_set_property |
Set a frontmatter property across many notes |
bulk_move_notes |
Batch move with transactional link rewriting |
| Tool | Description |
|---|---|
list_commands |
Enumerate available Obsidian commands |
execute_command |
Fire an Obsidian command by id |
| Tool | Description |
|---|---|
generate_uri |
Build an obsidian:// URI (pure string-builder, touches no vault state) |
| Tool | Description |
|---|---|
get_server_config |
Read non-secret server config |
inspect_acl |
Test whether a (vault, path, op, scopes) tuple is permitted |
get_metrics |
Snapshot Prometheus-style metrics as JSON |
server_health |
Liveness + build info; round-trips the full dispatch path |