Tools¶
Three things hold across these pages:
- A
folderargument selects that folder and its sub-folders;""is the top level, andJournal,Journal/and/Journal/name the same folder. - Read tools that query the index report freshness in the response's
_meta.index_stale. Passwait_for_pending_writes=trueto wait for recent writes first. - Some tools appear only under a setting: the write tools are hidden when
MARKDOWN_VAULT_MCP_READ_ONLY=true,git_syncneeds a git remote, theokf_*tools need Open Knowledge Format support on,summarizeneeds a language model, and the transfer-link tools need HTTP with a base URL. The configuration reference has each setting.
Every tool runs with the server's own privileges; the security model says what that reaches.
| Group | Tool | Title | Does |
|---|---|---|---|
| Reader | search |
Search Vault | Search notes by keyword and meaning; returns notes ranked by score, each with its best-matching sections as snippets. |
| Reader | read |
Read Note | Return a note's text, frontmatter and etag, or an attachment's bytes as base64. |
| Reader | list_documents |
List Documents | List notes, and optionally attachments, with path, title and frontmatter but no body text. |
| Reader | list_folders |
List Folders | List every folder that holds notes; "" stands for the top level. |
| Reader | list_tags |
List Tags | List the distinct values one indexed frontmatter field takes across the vault. |
| Reader | stats |
Vault Stats | Report the vault's size, link health and capabilities: the search modes it serves and the frontmatter fields search can filter on. |
| Reader | get_similar |
Similar Notes | Find the notes closest in meaning to a given note; returns them ranked by similarity with their closest sections, the note itself excluded. |
| Reader | get_toc |
Table of Contents | Return the heading outline of a note, or of every note under a folder. |
| Reader | get_recent |
Recent Notes | List the most recently modified notes, newest first. |
| Reader | get_context |
Note Context | Return a note's metadata, backlinks, outlinks, similar notes, folder neighbours, indexed tags and applicable conventions in one call. |
| Reader | get_conventions |
Folder Conventions | Return the vault owner's authoring conventions for a note or folder, vault root first and the most specific last. |
| Reader | okf_validate |
Validate OKF Bundle | Audit how far the vault conforms to the Open Knowledge Format, with example paths per rule; works on a vault not yet declared as a bundle. |
| Graph | get_backlinks |
Backlinks | List the notes that link to a note. |
| Graph | get_outlinks |
Outlinks | List the links in a note, each with an exists flag that is false when the target is missing. |
| Graph | get_broken_links |
Broken Links | List the links whose target is missing from the vault, each with the note that holds it. |
| Graph | get_orphan_notes |
Orphan Notes | List every note with no links in or out, with no limit on the count. |
| Graph | get_most_linked |
Most-Linked Notes | List the notes with the most backlinks, most first. |
| Graph | get_connection_path |
Connection Path | Find the shortest chain of links between two notes, following links in either direction. |
| Indexing | embeddings_status |
Embeddings Status | Check embedding provider and vector-index status. |
| Indexing | get_index_status |
Index Status | Report FTS index readiness, progress, and last build error. |
| Indexing | reindex |
Reindex Vault | Bring the search index up to date with files changed outside this server, such as by an editor or a sync tool; returns counts of added, modified, deleted and unchanged notes. |
| Indexing | build_embeddings |
Build Embeddings | Bring the vector index behind semantic and hybrid search up to date with the notes; returns the number of chunks embedded. |
| Writer | write |
Write Note | Create a note or attachment, or replace one whole; returns its path and whether it was created. |
| Writer | edit |
Edit Note | Replace text in an existing note, chosen by an exact old_text, by a range of lines, or by an old_text within a range of lines. |
| Writer | append |
Append to Note | Add text to the end of an existing note without reading it first. |
| Writer | delete |
Delete Note | Permanently delete a note or attachment; only git history can bring it back. |
| Writer | rename |
Rename Note | Rename or move a note or attachment; with update_links, links to it in other notes follow it. |
| Writer | move_folder |
Move Folder | Move a folder and everything under it to a new location, rewriting every link into it across the vault: rename for a whole folder. |
| Writer | fetch |
Fetch to Vault | Download a URL on the server and save it in the vault as a note or attachment; returns its path, size and final_url. |
| Writer | okf_convert_links |
OKF: Convert Wikilinks | Rewrite wikilinks as bundle-root-absolute Markdown links, the Open Knowledge Format's recommended style; returns counts of links converted and skipped. |
| Writer | okf_generate_index |
OKF: Generate index.md | Write a folder's Open Knowledge Format index.md: a link to each note directly in it with its description, and one to each subfolder's index.md, replacing the old listing and keeping its frontmatter. |
| Writer | okf_seed_log |
OKF: Seed log.md | Create a folder's Open Knowledge Format log.md from the git history of the notes under it, one dated section per day, newest first. |
| Writer | okf_verify |
OKF: Verify Note | Record that a person reviewed a note, raising its Open Knowledge Format trust tier to human-reviewed; returns the verifier recorded. |
| Git | get_history |
Note History | List the commits that touched a note, an attachment, a folder or the whole vault, newest first. |
| Git | get_diff |
Note Diff | Return how a note or attachment changed from an earlier commit to now, as one unified diff or one per commit. |
| Git | git_sync |
Sync with Git | Pull from and push to the vault's git remote now; returns what each leg did. |
| Vault app tools | browse_vault |
Browse Vault | Open an interactive vault explorer for the user to look through: the file tree, the link graph or one note's relationships. |
| Vault app tools | vault_context |
Vault Context | Return the full NoteContext for a note (app-only). |
| Vault app tools | show_context |
Context Card | Open an interactive card for the user showing a note's backlinks, outlinks, similar notes, tags and frontmatter. |
| Vault app tools | vault_graph_neighborhood |
Graph Neighborhood | Return the link neighborhood of a note as a node/edge graph (app-only). |
| Vault app tools | vault_graph_hubs |
Graph Hubs | Return the most-linked notes and their connections as a graph (app-only). |
| Vault app tools | vault_list |
Vault List | List folders and notes in a vault directory (app-only). |
| Vault app tools | vault_read |
Vault Read | Read a note's full content for preview rendering (app-only). |
| Vault app tools | vault_search |
Vault Search | Search the vault (app-only). |
| Server info | get_server_info |
Server Info | Report the version information of markdown-vault-mcp; returns server_name, server_version, core_version, the MCP protocol revisions supported and the revision and client of this connection, and, when configured, the upstream service's version. |
| Transfer | create_download_link |
Create Download Link | Create a download URL for a file; returns url and expires_in_s. |
| Transfer | create_upload_link |
Create Upload Link | Create an upload URL for a file; returns url and expires_in_s. |
| Summarize | summarize |
Summarize Notes | Summarize notes or folders with a language model; returns one summary that cites its source notes by path, or one summary per note. |
| Jobs | get_job_result |
Get Job Result | Get the status of a background job started by a long-running tool on this server; returns status (working, completed or failed) with the result or error once it finishes. |