Skip to main content
Glama

obsidian-mcp

An MCP server that lets Claude Code (or any MCP client) operate Obsidian. It has 220 tools across three backends:

Backend

Needs

What it gives you

Vault files (default, 132 tools)

Only the vault folder; Obsidian doesn't need to be running

Read, write and edit notes. Moves and renames update links like Obsidian does. Also: Obsidian search syntax, relevance search (CJK-aware), Dataview-style queries, properties, tags, backlinks and graph, tasks (Tasks-plugin format, recurring), daily and periodic notes, templates, attachments, canvas, Bases, bookmarks, plugin and theme settings, maintenance (lint, orphans, broken links, duplicates, MOC, export)

Official Obsidian CLI (app_*, 70 tools)

Obsidian 1.12.7+ running on the same machine, with Settings → General → Command line interface turned on

Drive the live app: open notes, the active file, command palette, Sync, Publish, file history and diffs, Bases queries, plugin install/enable, themes, workspaces, tabs, screenshots, the dev console, eval

Local REST API plugin (rest_*, 16 tools)

The community plugin Local REST API and its API key

App access over HTTP, so it also works from another machine (SSH tunnel). Covers the active note, targeted PATCH by heading, block or frontmatter, Dataview DQL, JsonLogic search and commands

The app_* and rest_* groups switch on automatically when the CLI is found or OBSIDIAN_API_KEY is set.

Install

git clone https://github.com/zongwei-tang/obsidian-mcp ~/obsidian-mcp && cd ~/obsidian-mcp && npm install    # builds dist/ (Node ≥ 20)
claude mcp add obsidian --scope user -- node ~/obsidian-mcp/dist/index.js

By default it uses the vault that is open in Obsidian (read from Obsidian's obsidian.json). To pin a vault, or to add the REST API:

claude mcp add obsidian --scope user \
  -e OBSIDIAN_VAULT="$HOME/Documents/My Vault" \
  -e OBSIDIAN_API_KEY=<key from Settings → Local REST API> \
  -- node ~/obsidian-mcp/dist/index.js

To check the setup, run node dist/index.js doctor (it shows the vaults, CLI and REST API it detected and the tool count). node dist/index.js tools lists every tool.

Env var

Meaning

OBSIDIAN_VAULT

Vault folder; several are separated with : (; on Windows). Tools take vault to pick one by name

OBSIDIAN_READ_ONLY=1

Register read-only tools only

OBSIDIAN_TOOLSETS

all, or groups such as notes,search,tasks, or default,-config

OBSIDIAN_CLI

Path to the obsidian CLI binary (auto-detected: /usr/local/bin/obsidian, ~/.local/bin/obsidian, …)

OBSIDIAN_API_KEY / OBSIDIAN_API_URL

Local REST API key / URL (default https://127.0.0.1:27124; its self-signed certificate is accepted unless OBSIDIAN_API_VERIFY_TLS=1)

OBSIDIAN_CONFIG_FOLDER

If you renamed .obsidian

Related MCP server: mcp-obsidian

Remote use: Claude on your phone, claude.ai, or cloud sessions

claude.ai, the Claude mobile apps and cloud Claude Code sessions can only reach MCP servers over HTTPS, so they can't start a local stdio server. For them, run this server in a container next to a synced copy of your vault:

Claude (phone / web / cloud) ──HTTPS──▶ container: obsidian-mcp serve ──▶ /data/vault ◀── ob sync --continuous ◀──▶ Obsidian Sync ◀──▶ your devices
  • Sync: the container uses Obsidian Headless (ob, Obsidian's official command-line Sync client) to keep a copy of the vault in /data/vault. Changes Claude makes reach your other devices through Obsidian Sync, and your computer doesn't need to be on. You need an Obsidian Sync subscription.

  • Access: the server checks a secret token, sent as Authorization: Bearer <token> or in the URL path (/mcp/<token>, for clients that only take a URL). It also checks Host and Origin and slows down repeated failed attempts.

  • Sandbox: remote mode is always on. Tools can't touch files outside the vault, run code, or change Obsidian, plugin or app settings. The app_* and rest_* groups are off.

  • Privacy: the container holds a decrypted copy of the synced vault, so whoever runs the host can read it. Leave private folders out with OBSIDIAN_EXCLUDED_FOLDERS (they are never downloaded) or hide them from Claude with OBSIDIAN_HIDE_FOLDERS.

Deploy

The repo's Dockerfile builds the image. Mount a persistent volume at /data, expose port 8080 (or set PORT) behind HTTPS, and set these variables:

Variable

OBSIDIAN_EMAIL, OBSIDIAN_PASSWORD

Your Obsidian account

OBSIDIAN_MFA

Current 2FA code, only if your account uses 2FA. It is needed only for the first login, so set it last

OBSIDIAN_VAULT_NAME

Name of the remote vault, exactly as listed by ob sync-list-remote (case matters)

OBSIDIAN_VAULT_PASSWORD

Encryption password, for end-to-end encrypted vaults

OBSIDIAN_HTTP_TOKEN

Access token, at least 32 characters (openssl rand -base64 48). If you leave it unset, one is generated and stored in /data/mcp/http-token

PUBLIC_HOST

Your public hostname, so the Host check accepts it (set automatically on Railway)

OBSIDIAN_EXCLUDED_FOLDERS

Optional. Comma-separated folders that are not synced to the container

OBSIDIAN_HIDE_FOLDERS

Optional. Comma-separated folders Claude can't see

OBSIDIAN_READ_ONLY=1

Optional. Read tools only

OBSIDIAN_DEVICE_NAME

Optional. Name shown in Obsidian Sync's device list (default claude-mcp (cloud))

On first start the container logs in, connects the vault, and then syncs continuously. Login and sync state stay on the volume, so the account password is only needed for that first setup.

Railway: create a service from this repo (or run railway up in it), add a volume at /data, generate a domain for port 8080 and set the variables above.

Docker anywhere else:

docker build -t obsidian-mcp .
docker run -d -v obsidian-data:/data -p 127.0.0.1:8080:8080 --env-file obsidian.env -e PUBLIC_HOST=obsidian.example.com obsidian-mcp

Put an HTTPS reverse proxy (Caddy, nginx, Cloudflare Tunnel) in front of port 8080.

Connect Claude

  • claude.ai and the mobile apps: Settings → Connectors → Add custom connector, URL https://<your host>/mcp/<token>.

  • Claude Code: claude mcp add --transport http obsidian https://<your host>/mcp --header "Authorization: Bearer <token>"

Treat the URL with the token like a password. To rotate it, change OBSIDIAN_HTTP_TOKEN and update the connector.

Without a container

obsidian-mcp serve --host 127.0.0.1 --port 8765 serves any local vault over HTTP with the same sandbox, for use behind your own HTTPS tunnel. Run obsidian-mcp help for its options.

How it behaves

  • Note addressing: notes can be addressed as Folder/Note.md, Folder/Note, Note, an alias, or [[Note#Heading|x]]. Resolution follows Obsidian: case-insensitive, notes in the same folder win, then the shortest path. When nothing matches, the error lists close matches.

  • Link updates: move_file and rename_file rewrite every wikilink, markdown link, embed, frontmatter link and canvas card that pointed at the moved file. They keep the #heading / #^block / |alias and follow the vault's New link format. Relative links inside a moved note are fixed too.

  • Code is skipped: text in code blocks, inline code, %% comments %% and math is never treated as a link or tag.

  • Safety: deleting moves files to the vault's .trash unless you pass permanent:true. Bulk tools (batch_replace, batch_update_frontmatter, rename_tag, delete_tag, rename_property, link_unlinked_mentions, fix_broken_link) default to dry_run. Paths can't escape the vault (symlinks included), and raw writes into .obsidian/ are refused; only the config tools write there.

  • Search syntax: search understands words, "phrases", OR, -exclude, ( ), /regex/, file:, path:, content:, tag:, line:( ), block:( ), section:( ), task:, task-todo:, task-done:, match-case:, [prop] and [prop:value].

  • Dates: daily and periodic notes read the Periodic Notes plugin or the core Daily notes settings, and support moment formats such as YYYY/MM/YYYY-MM-DD and gggg-[W]ww. Templates fill {{title}}, {{date}}, {{time}}, {{date:FMT}}, {{date+1d:FMT}} and {{monday:FMT}}.

Tools

Tool

What it does

list_vaults

List Obsidian vaults known on this machine (from OBSIDIAN_VAULT and the Obsidian app's obsidian.json), with which one is the default.

vault_info

Vault overview: path, note/attachment/folder counts, size, key settings (link format, attachment folder, daily notes, templates), enabled plugins and which backends (files, Obsidian CLI, Local REST API) are available.

open_in_obsidian

Show a note in the Obsidian app on this computer (tries the Obsidian CLI, then the Local REST API, then an obsidian:// link).

Tool

What it does

list_files

List files in the vault or a folder.

list_folders

List folders with how many notes/files each holds (direct and total).

folder_tree

Show the vault (or a folder) as an indented tree, like the file explorer.

create_folder

Create a folder (and parents).

move_file

Move or rename a note, attachment or folder.

rename_file

Rename a note/file/folder in place (extension kept if omitted); links across the vault are updated.

copy_file

Duplicate a note or attachment to a new path (links are not changed).

delete_file

Delete a note, attachment or folder.

file_info

Size, created/modified dates, type and (for notes) a metadata summary of a file.

find_files

Fuzzy-find notes/files by name or alias (like the Quick switcher).

recent_files

Most recently modified (or created) notes/files.

random_note

Pick a random note (optionally within a folder) and return its path and content.

get_obsidian_uri

Build an obsidian:// link that opens a note (or a search, or a new note) in the Obsidian app — handy to give the user a clickable link.

Tool

What it does

read_note

Read a note (or any text file).

read_multiple_notes

Read several notes at once — by list, or every note in a folder / matching a glob.

get_note_outline

Headings of a note with level and line number (the Outline pane).

read_section

Read just the content under one heading (until the next heading of the same or higher level).

read_block

Read the paragraph / list item that carries a ^block-id.

get_note_metadata

Everything Obsidian's metadata cache knows about a note: properties, tags, aliases, headings, links (resolved), embeds, block ids, tasks, inline fields, word count, backlink count.

resolve_link

Resolve link text the way Obsidian does (shortest path, same-folder preference, aliases) and check that a #heading or #^block exists.

word_count

Word and character count of a note or section (CJK characters count as words, like Obsidian), plus reading time.

note_exists

Check whether a note/file exists, and where it resolves to.

Tool

What it does

create_note

Create a note.

write_note

Replace the whole content of a note (creates it if missing).

append_to_note

Append text to the end of a note, or to the end of a heading's section (heading is created if missing).

prepend_to_note

Insert text at the top of a note (after the frontmatter) or at the start of a heading's section.

insert_at_line

Insert text before or after a line number (1-based; see read_note line_numbers:true).

replace_lines

Replace (or delete, with empty content) a range of lines (1-based, inclusive).

edit_note

Exact find-and-replace inside one note (like a code editor).

replace_in_note

Search and replace in a note with plain text or a regular expression ($1 groups allowed).

update_section

Replace, append to, prepend to, or delete the content under a heading (replace/delete cover everything down to the next heading of the same or higher level, sub-headings included).

update_block

Replace, append to or prepend to the paragraph/list item with a ^block-id (the id is kept).

add_block_id

Give a paragraph/list item a ^block-id (found by line number or by text) so it can be linked or embedded.

move_section

Move a heading section (with its subsections) to another note, or to another position in the same note (under target_heading).

merge_notes

Merge several notes into one: their content is appended to the target (each under a heading with its title), links to them are redirected to the target, and the sources are moved to .trash.

split_note

Split a note into separate notes, one per heading of the given level.

batch_replace

Find and replace across many notes (filter by folder, glob or tag).

Tool

What it does

get_frontmatter

Get a note's properties (YAML frontmatter) as JSON, plus the raw YAML and any parse error.

update_frontmatter

Merge properties into a note's frontmatter (creates it if absent).

set_property

Set one property, converting the value to an Obsidian property type (text, list, number, checkbox, date, datetime).

remove_property

Remove a property from a note.

list_properties

All property names used in the vault with how many notes use each and their type (from Obsidian's types.json, else inferred).

get_property_values

Distinct values of one property across the vault with counts (lists are expanded), and which notes use each value.

rename_property

Rename a property key in every note that has it (values kept).

batch_update_frontmatter

Set and/or remove properties on many notes at once (filter by folder, glob, tag, files or has_property).

manage_aliases

List, add or remove a note's aliases (alternative names that links and the quick switcher resolve).

Tool

What it does

list_tags

All tags in the vault (frontmatter + inline) with note counts.

find_notes_by_tag

Notes that have the given tag(s).

add_tags

Add tags to a note — into the frontmatter tags property (default) or inline at the end of the note.

remove_tags

Remove tags from a note, both from frontmatter and inline #tags (default) or only one of them.

rename_tag

Rename a tag across the whole vault, in frontmatter and inline, including nested children (#old/x → #new/x).

delete_tag

Remove a tag (and its nested children unless exact:true) from every note in the vault.

Tool

What it does

get_backlinks

Notes that link to (or embed) this note — the "Linked mentions" pane — with the line that contains each link.

get_outgoing_links

Links and embeds going out of a note, each with where it resolves (or unresolved).

get_unlinked_mentions

Places where a note's title (or aliases) appears as plain text without a link — Obsidian's "Unlinked mentions".

link_unlinked_mentions

Turn unlinked mentions of a note into [[links]] (first mention per note by default).

find_orphans

Notes with no incoming links (nothing links to them).

find_dead_ends

Notes with no outgoing links to other notes.

find_broken_links

Unresolved links (to notes/files that don't exist), grouped by missing target, with the notes and lines that contain them.

get_graph_neighbors

Notes connected to a note within N hops (local graph), following outgoing, incoming or both directions.

find_path_between_notes

Shortest chain of links connecting two notes (treating links as undirected unless directed:true).

get_link_graph

Export the link graph (nodes + edges) for the vault, a folder or a tag — as JSON, a Mermaid diagram, or DOT.

get_hub_notes

The most connected notes: most linked-to (authorities), most linking (hubs), or total degree.

fix_broken_link

Repoint every link to a missing target (e.g.

Tool

What it does

search

Search the vault with Obsidian's search syntax: words (AND), "exact phrase", OR, -exclude, (groups), /regex/, file:, path:, content:, tag:#x, line:(a b), block:(…), section:(…), task:, task-todo:, task-done:, match-case:, [property], [property:value].

search_text

Grep the vault: plain text or regex, with N lines of context, optional file glob/folder.

search_ranked

Relevance-ranked full-text search (BM25; titles weigh more; Chinese/Japanese/Korean handled with character bigrams).

query_notes

Dataview-style query over notes: filter by properties and file metadata (AND/OR), sort, pick fields, output JSON, a Markdown table or CSV.

search_by_property

Find notes whose property equals / contains a value (or just has the property).

search_by_date

Notes created or modified in a date range (by file dates, or by a date property such as "date" / "created").

find_similar_notes

Notes most similar to a note by content (TF-IDF cosine), boosted by shared links and tags.

Tool

What it does

list_tasks

List checkbox tasks across the vault with Tasks-plugin metadata (📅 due, ⏳ scheduled, 🛫 start, ✅ done, priority, 🔁 recurrence) and Dataview [due:: …] fields.

add_task

Add a task to a note (optionally under a heading) or to today's daily note.

update_task

Change a task by ref ("path:line" from list_tasks): complete/reopen/toggle/cancel, set any status character, edit text or dates.

delete_task

Delete a task line (by ref "path:line"); expect_text guards against the note having changed.

task_summary

Task dashboard: counts by status, overdue, due today, next 7 days, undated, and the notes with the most open tasks.

Tool

What it does

get_periodic_settings

Daily/weekly/monthly/quarterly/yearly note settings (folder, date format, template), read from the Periodic Notes plugin or core Daily notes.

get_periodic_note

Read today's (or any date's) daily / weekly / monthly / quarterly / yearly note.

append_to_periodic_note

Add text to a daily/weekly/… note (created from its template if missing) — at the end, at the top, or under a heading.

list_periodic_notes

Which daily/weekly/… notes exist over a range (default: last 14 periods), newest first.

read_periodic_range

Concatenate the daily (or weekly…) notes in a date range — e.g.

rollover_tasks

Copy (or move) unfinished tasks from a previous daily note into today's, like the Rollover Daily Todos plugin.

Tool

What it does

list_templates

Templates in the core Templates folder (and Templater's folder if set).

read_template

Show a template, raw or rendered ({{title}}, {{date}}, {{time}}, {{date:FMT}}, {{date+1d}}, custom variables).

create_template

Save a new template into the Templates folder.

insert_template

Render a template and insert it into an existing note (at the end, the top, or under a heading).

create_from_template

Create a new note from a template (title = note name), with optional variables and extra properties.

Tool

What it does

list_attachments

Non-note files (images, PDFs, audio, video, …) with size and type.

read_attachment

Open an attachment: images come back as an image you can see, text files as text, other files as metadata (or base64 with as_base64).

add_attachment

Save a file into the vault — from a local path, base64 data, or a URL — into the vault's attachment folder (per its settings, relative to for_note), and optionally embed it in that note.

find_unused_attachments

Attachments that no note or canvas links to or embeds — candidates for cleanup (delete with delete_file).

get_attachment_folder

Where Obsidian will put new attachments (globally, or for a given note).

embed_in_note

Embed a note, heading, block, image or other file into a note (![[...]]), at the end or under a heading.

Tool

What it does

list_canvases

All .canvas files with node/edge counts.

read_canvas

Read a canvas: cards (text, notes, links, groups) with positions, and connections between them in readable form.

create_canvas

Create a canvas from cards and connections.

add_canvas_nodes

Add cards to an existing canvas (placed below existing content when x/y are omitted), optionally with edges.

add_canvas_edges

Connect canvas cards with arrows (by node id; see read_canvas).

update_canvas_node

Change a canvas card's text, file, url, label, position, size or color.

remove_canvas_elements

Delete cards and/or edges from a canvas by id (edges attached to removed cards go too).

canvas_from_notes

Build a canvas that maps notes as cards with arrows for the links between them — from a list of notes, or a note plus its linked neighbours.

Tool

What it does

list_bases

All .base files (Obsidian Bases database views) with their view names.

read_base

Read a .base file: filters, formulas, properties and views (parsed from YAML).

create_base

Create an Obsidian Bases file (.base).

update_base

Edit a .base file: add/replace a view (by name), set filters, add formulas or property display names.

Tool

What it does

list_bookmarks

Bookmarked notes, headings, folders, searches and URLs (Bookmarks core plugin), with their groups.

add_bookmark

Bookmark a note (or heading/block), folder, search or URL, optionally inside a bookmark group.

remove_bookmark

Remove bookmarks matching a path, search query, URL or title.

Tool

What it does

list_plugins

Installed community plugins (name, version, enabled) and core plugins with their on/off state.

get_plugin_settings

Read a plugin's saved settings (data.json for community plugins, .json for core plugins like daily-notes, templates, zk-prefixer).

update_plugin_settings

Merge keys into a plugin's settings file.

set_plugin_enabled

Enable or disable a community or core plugin in the vault config (takes effect when Obsidian reloads; use app_plugin_enable/disable for live changes).

get_vault_settings

Read an Obsidian settings file: app (Editor/Files & links), appearance, hotkeys, core-plugins, graph, types (property types), workspace, or any other .obsidian/*.json.

update_vault_settings

Merge keys into an Obsidian settings file (default app.json) — e.g.

list_css_snippets

CSS snippets in .obsidian/snippets and whether each is enabled; also installed themes and the active theme.

write_css_snippet

Create or overwrite a CSS snippet (and enable it) to restyle Obsidian.

set_css_snippet_enabled

Turn a CSS snippet on or off.

set_theme

Set the community theme (installed in .obsidian/themes; "" for default) and/or light/dark mode.

list_hotkeys

Custom hotkeys from hotkeys.json (command id → keys).

list_workspaces

Saved workspace layouts (Workspaces core plugin) and the files open in the current layout.

Tool

What it does

vault_stats

Vault statistics: notes, words, links, tags, tasks, attachments, biggest notes and folders, notes created/modified per month, orphans and broken links.

find_stale_notes

Notes not modified in N days (default 180), oldest first.

find_empty_notes

Notes with no body text (optionally treating notes under N words as empty).

find_duplicate_notes

Notes with identical content, and notes sharing the same file name in different folders (which makes [[links]] ambiguous).

lint_note

Check a note (or every note in a folder) for problems: invalid frontmatter, broken links/embeds, missing #heading/#^block targets, duplicate headings, skipped heading levels, empty links, unclosed code fences.

generate_moc

Create (or preview) a Map of Content note linking every note in a folder, with a tag, or matching a glob — grouped by subfolder or by first letter.

export_note

Export a note as self-contained Markdown (embeds inlined, wikilinks turned into plain text or Markdown links) or HTML.

vault_activity

What changed recently: notes created and modified per day over the last N days, with the files.

note_to_html

Render a note's Markdown to HTML (wikilinks become plain text links) — quick preview or for pasting elsewhere.

Tool

What it does

app_version

Obsidian app version (checks the CLI connection).

app_vault_info

Info on the vault open in the app (name, path, file/folder counts, size).

app_list_vaults

Vaults the running app knows about, with paths.

app_reload

Reload the Obsidian window (applies config changes made on disk).

app_restart

Restart the Obsidian app.

app_open_note

Open a note in the Obsidian app.

app_open_daily_note

Open today's daily note in the app (creating it from the template if needed).

app_daily_append

Append to today's daily note via the app (uses the app's exact daily-note settings).

app_active_file

Which file is open/focused in Obsidian right now (path, size, dates).

app_read_active

Read the content of the note currently open in Obsidian (or a given note through the app).

app_search

Search with Obsidian's own search engine; returns path:line: text matches.

app_open_search

Open the search pane in the app with a query.

app_list_commands

Command palette command ids (core + all plugins).

app_execute_command

Run any command-palette command by id (see app_list_commands) — e.g.

app_list_hotkeys

All hotkeys (default + custom) for commands.

app_file_history

List versions of a note from File recovery and Sync, or diff two versions (from/to are version numbers, newest = 1).

app_history_read

Read an older local (File recovery) version of a note.

app_history_restore

Restore an older local version of a note.

app_sync_status

Obsidian Sync status and usage.

app_sync_pause

Pause or resume Obsidian Sync.

app_sync_history

Sync version history of a note.

app_sync_read

Read a Sync version of a note.

app_sync_restore

Restore a Sync version of a note.

app_sync_deleted

Files deleted in Sync (recoverable).

app_publish_site

Obsidian Publish site info (slug, URL).

app_publish_list

Files published to Obsidian Publish.

app_publish_status

Pending Publish changes (new / changed / deleted).

app_publish

Publish a note (or all changed files with changed:true) to Obsidian Publish.

app_unpublish

Unpublish a note from Obsidian Publish.

app_base_query

Run an Obsidian Bases view and get its rows (exact Bases engine: formulas, filters, sorting).

app_base_views

Views defined in a base (default: the active one).

app_base_create_item

Create a new note as an item of a base view (gets the view's properties).

app_list_plugins

Installed plugins as the app sees them (with versions).

app_list_enabled_plugins

Enabled plugins only.

app_plugin_info

Details about a plugin.

app_plugin_enable

Enable a core or community plugin live.

app_plugin_disable

Disable a core or community plugin live.

app_plugin_install

Install a community plugin from the official directory by id (e.g.

app_plugin_uninstall

Uninstall a community plugin.

app_plugin_reload

Reload a plugin (after editing its settings or code).

app_restricted_mode

Check or toggle Restricted mode (community plugins off).

app_list_themes

Installed themes.

app_set_theme

Switch theme ("" for default).

app_install_theme

Install a community theme by name.

app_list_snippets

CSS snippets and which are enabled.

app_workspace

Current layout tree: splits, tabs and the files in them.

app_list_tabs

Open tabs.

app_open_tab

Open a new tab (optionally with a file or a view type like "graph").

app_recent_files

Recently opened files (app history).

app_list_workspaces

Saved workspace layouts.

app_save_workspace

Save the current layout as a named workspace.

app_load_workspace

Switch to a saved workspace layout.

app_open_url

Open a URL in Obsidian's Web viewer.

app_insert_template

Insert a template into the active note at the cursor (core Templates).

app_create_unique_note

Create a note with the Unique note creator (Zettelkasten timestamp name).

app_create_note

Create a note through the app (template applied by Obsidian/Templater, opened if asked).

app_move_note

Move/rename a note through the app (Obsidian updates links per your settings).

app_delete_note

Delete a note through the app (to trash unless permanent).

app_set_property

Set a property through the app (respects property types).

app_tasks

Tasks as the app indexes them (todo/done, a file, or today's daily note), with file and line.

app_toggle_task

Toggle / complete / reopen a task through the app (ref "path:line").

app_bookmark

Add a bookmark live (file, heading/block subpath, folder, search or URL).

app_word_count

Word/character count of the active (or given) note, computed by the app.

app_outline

Headings of the active (or given) note as the app sees them.

app_backlinks

Backlinks of the active (or given) note from the app's metadata cache.

app_dev_console

Recent console messages from the app (debugging plugins).

app_dev_errors

JavaScript errors captured in the app.

app_dev_dom

Query the app's DOM by CSS selector (text, attribute, CSS value, counts).

app_eval

Run JavaScript inside Obsidian (full app API) and return the result, e.g.

app_snippet_enabled

Enable or disable a CSS snippet live.

app_screenshot

Screenshot of the Obsidian window, returned as an image — see what the user sees.

app_cli

Run any Obsidian CLI command not covered by another tool (see "obsidian help").

Tool

What it does

rest_status

Check the connection: plugin version, Obsidian version, whether the API key is accepted.

rest_get_active_note

The note currently open in Obsidian: path, content, frontmatter, tags and file stats.

rest_update_active_note

Replace or append to the note currently open in Obsidian.

rest_open_note

Open a note in the Obsidian UI.

rest_list_files

List files in the vault root or a folder (folders end with /).

rest_read_note

Read a note through the app.

rest_write_note

Create or overwrite a note through the app.

rest_append_note

Append to a note through the app (creates it if missing).

rest_patch_note

Surgically edit a note relative to a heading (path like ["Parent","Child"]), a ^block id, or a frontmatter key: append, prepend, replace (or delete).

rest_delete_note

Delete a note through the app.

rest_search

Obsidian's built-in fuzzy search through the app, with context around each match.

rest_search_dataview

Run a Dataview DQL TABLE query (needs the Dataview plugin), e.g.

rest_search_jsonlogic

Query notes with a JsonLogic expression over note JSON (path, content, frontmatter, tags, stat), e.g.

rest_list_commands

Command palette commands available in the app.

rest_execute_command

Run a command-palette command by id.

rest_list_tags

Tags with usage counts from the app's metadata cache.

Development

npm test   # compiles, then runs the end-to-end suite: a real MCP client against a fixture vault, a fake Obsidian CLI and a fake REST API

Tool coverage was designed after surveying existing servers (cyanheads/obsidian-mcp-server, MarkusPfundstein/mcp-obsidian, StevenStavrakis/obsidian-mcp, bitbonsai/mcpvault, rps321321/obsidian-mcp-pro, jacksteamdev/obsidian-mcp-tools), the Local REST API plugin and the official Obsidian CLI docs. No code was copied.

MIT licensed.

Tool Schema Changelog

Recent tool additions, removals, and schema changes observed during successful MCP inspections.

Loading tool schema changelog…

    Related MCP Connectors

    Related MCP Servers

    • A
      license
      Not graded
      quality
      C
      maintenance
      Remote MCP server for Obsidian vaults, enabling secure access to markdown notes from Claude clients without the Obsidian desktop app. Provides tools for searching, reading, listing recent notes, resolving daily notes, and creating/appending notes via HTTPS.
      MIT
    • A
      license
      A
      quality
      D
      maintenance
      MCP server that connects Claude Desktop to Obsidian vault via the Local REST API plugin, enabling search, read, write, and management of notes plus executing Obsidian commands.
      11
      MIT
    • A
      license
      Not graded
      quality
      D
      maintenance
      Gives Claude and other MCP clients full control of a running Obsidian vault through the official Obsidian CLI, with fast filesystem reads for bulk operations and link-safe writes via the app.
      MIT
    • A
      license
      Not graded
      quality
      B
      maintenance
      Enables hybrid search, reading, writing, and managing a local Obsidian vault through MCP tools and a REST API, including section patching, appending, moving notes with link rewriting, and frontmatter updates.
      AGPL 3.0