Skip to main content
Glama
junnnnnw00

Obsidian Everywhere

by junnnnnw00

English | 한국어

🧠 Obsidian Everywhere

Turn linked notes into AI context, use that context from agents anywhere, and checkpoint approved changes with Git.

CI License: MIT Node.js TypeScript MCP npm npm downloads PRs Welcome

Graph context · local semantic search · remote agents · guarded edits · opt-in Git checkpoints

obsidian-everywhere MCP server

Watch the Remote Vault Bridge in 44 seconds

Remote Vault Bridge demo — a remote agent searches graph and semantic context, makes a guarded edit, and recovers from a disconnected local vault

Remote setup guide

Remote request → semantic search → graph context → guarded edit → mount-loss recovery.


Obsidian Everywhere is built around three ideas:

  1. Notes are a graph and a semantic knowledge base, not a folder of text files. Backlinks, n-hop neighborhoods, shortest paths, PageRank, full-text search, and local multilingual embeddings turn a topic into focused, token-budgeted context.

  2. Your vault should be usable where your agents run. The Remote Vault Bridge exposes that same graph and its guarded write tools over authenticated Streamable HTTP. A Claude Code or Codex process on another server can search, reason over, append to, and reorganize a vault that remains on your own machine.

  3. Version-control actions deserve a narrower boundary than file writes. If the vault or one configured folder inside it is already a Git repository, the opt-in Git tools can inspect status, bounded diffs, and local history. Commit and push each require a preview, explicit confirmation, and a short-lived one-use approval ID.

The local path stays the source of truth. Obsidian Everywhere does not create a hosted copy, telemetry service, or mandatory cloud account; optional Git push publishes only to a repository the operator already configured. Remote access is a transport you operate, not a vault-sync product.

Related MCP server: ObsidianMCP

Contents

Features

vault (.md files)
  │  parse · watch
  ▼
SQLite index (FTS5)  ⇄  in-memory graph (graphology)
  │                       n-hop · shortest path · PageRank
  ▼
41 core MCP tools + 0–5 opt-in Git tools
  │
  ▼
local stdio  ·  authenticated remote HTTP  ·  OAuth HTTP
  • 🧩 Graph + semantic context engine — a markdown parser (wikilinks, embeds, frontmatter, nested tags, headings, block references), a SQLite index with full-text search, and an in-memory graphology layer for n-hop traversal, shortest paths, and PageRank. get_context_bundle packs a topic and its most useful neighbors into a requested token budget.

  • 🌍 Remote Vault Bridge — agents on an external server get the same search, graph, context, and guarded editing tools over authenticated Streamable HTTP. Use a private network or an HTTPS tunnel such as ngrok; the vault itself stays on the machine you control.

  • 📎 Vault-wide file reading — Markdown plus text/code/data files, PDF, DOCX, PPTX, XLSX, OpenDocument, EPUB, RTF, and common images are indexed and exposed without uploading them to a conversion service. Extraction is lazy, cached, size-limited, and searchable with search_files.

  • 🧠 Optional local semantic searchsemantic_search and get_related with method: "semantic" run a multilingual embedding model (multilingual-e5-small) entirely on your machine — no API key, cloud account, or Ollama process to run. Install the optional runtime with npm install @huggingface/transformers@^4.2.0; its model downloads once (~120MB, cached under ~/.obsidian-everywhere/), then works fully offline. It is disabled by default to keep the server below the 200 MiB memory target; opt in with OBSIDIAN_EVERYWHERE_ENABLE_SEMANTIC=true when extra memory is available.

  • 🛡️ Safe writes and resilient mounts — partial edits, dry-run-first bulk operations, rollback snapshots, recoverable deletion, and an opt-in Beta mount guard. If a removable drive, NAS share, or container mount disappears, the index is preserved, writes are blocked, and a full reconciliation runs after it returns.

  • 🌱 Reviewable Git checkpoints (off by default) — inspect status, bounded diffs, and local history for the vault or one configured repository folder. Higher modes add selected-file commits and operator-pinned HTTPS pushes, both behind preview and a five-minute one-use approval.

  • 🛠️ 41 core MCP tools, up to 46 when Git is explicitly enabled — structured reads, attachment extraction, graph navigation, semantic retrieval, safe lifecycle operations, persisted Obsidian settings, and explicit health reporting.

Three core workflows

1. Turn a linked vault into focused AI context

Exact search finds the words you wrote. Semantic search finds the idea even when the wording or language differs. Graph traversal then explains how the matching notes relate. get_context_bundle combines those signals into a bounded context package instead of dumping an entire vault into the model.

2. Use and edit that context from an external server

Run Obsidian Everywhere beside the local vault, expose its HTTP endpoint through your private network or an HTTPS tunnel, and register the URL in the remote MCP client. The remote agent can read and search the local vault, then use the same guarded tools to create, append, move, tag, or clean up notes. The server reindexes each successful write before returning, so the next remote tool call sees the change.

For the complete ngrok path, see the Remote Vault Bridge with ngrok tutorial.

3. Review and checkpoint vault changes with Git

When the vault or one real folder inside it contains its own .git directory, an agent can inspect the same repository state you would inspect locally, then create a commit from an explicit file list. Set OBSIDIAN_EVERYWHERE_GIT_REPO_PATH to that vault-relative folder, or leave its default . to use the vault root. Push is a separate, stricter capability: it can only publish the current HEAD to its existing upstream branch through an operator-pinned HTTPS destination. It never pulls, fetches, changes branches, constructs a free-form refspec, or accepts arbitrary Git arguments.

Start with OBSIDIAN_EVERYWHERE_GIT_MODE=read; move to commit or push only after reviewing the safety model in the Vault Git guide.

Read

Tool

What it does

vault_overview

Note counts, top tags, PageRank hub notes, recently modified — a starting orientation

vault_status

Mount availability, index freshness, write availability, and last full reconciliation

search_notes

Full-text search with tag/folder filters (with a trigram fallback for CJK substring matches unicode61 alone would miss — see DECISIONS.md D9), each result annotated with link counts and tags

search_files

Search filenames, vault-relative paths, and locally extracted text across PDF, Office/OpenDocument, EPUB, RTF, text/code/data, and other attachments

semantic_search

Optional meaning-based search via local embeddings (multilingual-e5-small, no external service); disabled in the default low-memory mode

read_note

Structured content/frontmatter/links/tags plus line pagination; optional heading-scoped read

read_file

Read any vault file: extracted document text with page/slide/sheet selection, or native image content for capable MCP clients; an exact on-disk path self-heals short watcher lag

list_notes

Explicit folder-aware note listing with pagination; optionally projects named frontmatter fields (e.g. status, project) per note

list_folder

Immediate child folders, notes, and attachments

regex_search

JavaScript-regex search with file, line, and excerpt

get_backlinks

Every note linking to a given note, with the linking sentence

get_neighborhood

Explicit n-hop node/edge list around a note (links treated as undirected)

get_context_bundle

The killer feature. Center note + prioritized 1-hop neighbors packed into a token budget

list_tags

Full nested tag hierarchy with counts

get_notes_by_tag

Notes carrying a given tag (nested-aware)

find_orphans

Notes with no incoming or outgoing links

find_unresolved

Links that don't resolve to any note, grouped by target

find_path

Shortest connection path between two notes, with a one-line summary per hop

get_related

Similar notes that aren't directly linked yet — Jaccard over shared tags/neighbors by default, or method: "semantic" for embedding similarity

get_hotkeys / get_obsidian_settings

Persisted hotkey command IDs, Templates folder, and core-plugin settings

validate_base

Static YAML/shape validation for .base files or fenced Base blocks

Write

Tool

What it does

create_note

Create a new note (with frontmatter); reindexed immediately — the next tool call already sees it

apply_template

Create a note from a template, substituting {{date}}/{{time}}/{{title}} (Obsidian's core Templates variables)

append_to_note

Append to a note, optionally under a specific heading; fails closed if the heading isn't found

move_note / rename_note / delete_note

Lifecycle operations with inbound-link rewriting, backlink guardrails, and recoverable trash

replace_text / patch_section

Guarded exact-text and heading-scoped edits

update_frontmatter / remove_frontmatter_field

Change properties without replacing the note body

bulk_update_frontmatter / bulk_remove_frontmatter_field

Same, across every note in a folder (or the whole vault); dry-run first with rollback

add_tags / remove_tags

Add or remove frontmatter tags on one note

rename_tag

Rename a tag vault-wide across frontmatter and inline #tag text, dry-run first with rollback

bulk_replace / rollback_bulk_edit

Dry-run-first folder/regex replacement with snapshots and rollback

set_hotkey / set_templates_folder

Update persisted Obsidian settings (vault reload may be required)

Vault Git — registered only when explicitly enabled

Tool

Minimum Git mode

What it does

git_status

read

Safe, selected-repository-relative working-tree status and local ahead/behind information; no fetch

git_diff

read

Bounded patch for safe tracked paths, plus explicitly named untracked paths in head mode; external diff drivers, textconv, and submodules stay disabled

git_log

read

Recent local commit history, optionally for one safe file

git_commit

commit + normal write gate

Preview, then commit only explicitly selected safe files using a five-minute one-use approval ID

git_push

push + normal write gate

Preview, then push the approved current HEAD to its existing upstream through an operator-pinned HTTPS destination

Effective setup

Registered tools

Git off, ordinary writes disabled

22

Git off, ordinary writes enabled

41

Git read, ordinary writes disabled

25

Git read, ordinary writes enabled

44

Git commit, ordinary writes disabled

25

Git commit, ordinary writes enabled

45

Git push, ordinary writes disabled

25

Git push, ordinary writes enabled

46

If the ordinary write gate is disabled, git_commit and git_push stay absent even when the configured Git mode is higher; the three Git read tools remain available. OAuth therefore requires both a sufficient Git mode and OAUTH_ENABLE_WRITE_TOOLS=true for commit or push.

Ordinary write tools are on by default for stdio and the bearer-token HTTP transport, and off by default for the public OAuth connector transport (opt in with OAUTH_ENABLE_WRITE_TOOLS=true) — see Configuration and DECISIONS.md D15. Git is independently off by default on every transport.

Vault Git

Vault Git is an optional checkpoint-and-publish layer for repositories already inside a vault. It is not a sync engine and it never initializes a repository. Git must be installed on the vault machine. The operator selects exactly one repository with OBSIDIAN_EVERYWHERE_GIT_REPO_PATH, a safe vault-relative real directory that defaults to .. That selected directory must be the exact root of a normal repository with a real, local .git directory. The rest of the vault remains indexed and available to ordinary graph, search, and note tools.

For example, a vault at /Volumes/SanDisk/jwhong can keep full-vault context while Git tools operate only on /Volumes/SanDisk/jwhong/DSLab:

export OBSIDIAN_VAULT_PATH=/Volumes/SanDisk/jwhong
export OBSIDIAN_EVERYWHERE_GIT_REPO_PATH=DSLab
export OBSIDIAN_EVERYWHERE_GIT_MODE=read

Git tool path inputs and outputs are relative to DSLab in that setup; ordinary note and file tool paths remain relative to the vault root. Parent repository discovery, linked worktrees, submodule roots, symlinked repository paths, and unsafe external or symlinked object/ref/log/core metadata layouts—including alternate object stores—are refused by every Git tool. The canonical vault, selected repository, and .git directory identities are captured at startup and rechecked before every Git subprocess; replacing a directory or introducing a symlink fails closed until the operator verifies the mount and restarts the service. Commit and push additionally refuse detached branches, shallow history, sparse checkouts, per-worktree Git configuration, grafts/replacement refs, and in-progress history operations.

With the supplied Compose file, set OBSIDIAN_VAULT_HOST_PATH=/Volumes/SanDisk/jwhong and OBSIDIAN_EVERYWHERE_HTTP_GIT_REPO_PATH=DSLab for the bearer service. The OAuth service has its own independent OBSIDIAN_EVERYWHERE_OAUTH_GIT_REPO_PATH input; both service-specific repository paths default to ..

Choose the narrowest capability that covers your workflow:

OBSIDIAN_EVERYWHERE_GIT_MODE

Tools added

Network access

off (default)

none

none

read

git_status, git_diff, git_log

none; history and ahead/behind are local only

commit

read tools + git_commit when ordinary writes are enabled

none

push

read/commit tools + git_push when ordinary writes are enabled

approved push to an existing upstream only

Push mode also requires a comma-separated operator mapping from each allowed upstream remote name to one exact credential-free HTTPS destination. Continuing the DSLab example above:

export OBSIDIAN_EVERYWHERE_GIT_MODE=push
export OBSIDIAN_EVERYWHERE_GIT_REPO_PATH=DSLab
export OBSIDIAN_EVERYWHERE_GIT_ALLOWED_PUSH_REMOTES=origin=https://github.com/owner/repo.git

Use OBSIDIAN_EVERYWHERE_GIT_REPO_PATH=. instead only when the whole vault is the repository.

The selected branch must already track a normal branch on the mapped remote, and that remote's sole resolved push URL must exactly match the pinned mapping. The URL is operator configuration, never MCP tool input; credentials, queries, fragments, caller-selected branches, and caller-selected refspecs are refused. Git must authenticate to that exact URL non-interactively using credentials already configured on the vault machine.

The destination ref comes from the branch's existing upstream mapping, not from the local branch name. For example, local main tracking origin/release can push only to release; the caller cannot substitute another branch.

Commit and push are deliberately two-step operations:

git_status
git_diff
git_commit { action: "preview", message: "docs: update project notes", paths: ["Projects/Atlas.md"] }
  → inspect the plan and explicitly approve it
git_commit { action: "execute", approvalId: "<UUID from preview>" }

git_push { action: "preview" }
  → inspect the exact HEAD, upstream, and outgoing count; explicitly approve it
git_push { action: "execute", approvalId: "<UUID from preview>" }

An approval ID expires after five minutes, works once, and is invalidated when the reviewed repository state changes. A preview never creates a commit or contacts the network. Hidden, excluded, and sensitive paths are omitted or blocked; commits select exact changed paths whose resulting entries are regular files, plus deletions; hooks, signing, clean filters (including Git LFS), submodules, and suspected secrets are refused. Push review is capped at 100 outgoing commits and 200 changed blobs, with an 8 MiB per-file/blob and 32 MiB aggregate content limit; commit messages and merge results are scanned too. Commit messages are single-line and secret-scanned, and commit approval binds the exact proposed tree.

Push execution uses the displayed literal HTTPS destination and an exact OID lease for the reviewed upstream ref. That lease is a compare-and-swap guard—not permission for an arbitrary force-push—so a deleted, advanced, or reset remote ref fails instead of being overwritten. Repository-local credential helpers, URL rewrites, http.* transport settings, and selected-remote proxy overrides are also refused for push. Trusted HTTPS credentials and any required network policy belong in the vault machine's user or system Git configuration, outside the repository.

There is intentionally no git_exec or free-form command tool. Passing raw Git arguments to a remote agent is effectively a remote-code-execution primitive: Git aliases can expand to shell commands, hooks execute programs, diff/textconv drivers run helpers, SSH transports launch commands, and credential helpers may invoke executables. A small set of fixed commands with fixed arguments is the safety boundary, not a cosmetic API choice.

Read the complete setup, operational limits, and troubleshooting guide before enabling commit or push: Using a Git-backed vault.

Try it without your vault

Run the built-in demo first. It creates a temporary sample vault, shows graph orientation and unresolved-link discovery, previews a safe bulk edit, and then removes the sample. It never reads or changes your own notes.

npx -y obsidian-everywhere demo

Obsidian Everywhere demo: context bundles, related-note discovery, graph paths, unresolved links, link-safe moves, and rollback-ready bulk edits

When you are ready to connect a real vault, generate copyable configuration for Codex, ChatGPT Desktop, Claude Code, and Claude Desktop:

npx -y obsidian-everywhere init /absolute/path/to/your/vault
npx -y obsidian-everywhere doctor /absolute/path/to/your/vault

init only prints configuration—it never edits global client settings. doctor checks Node.js, permissions, Obsidian metadata, SQLite, parsing, and the graph engine without printing note content. Add --share to redact the vault path before pasting diagnostics into an issue.

Why Obsidian Everywhere?

There are several good Obsidian MCPs. Pick the architecture that matches how you work rather than assuming one server wins every category.

Obsidian Everywhere

obsidian-mcp-server

Local REST API

TurboVault

Install

npx

npx

Obsidian community plugin

cargo install / binary

Published tools

41 core; up to 46 with opt-in Git

14

16

74

Obsidian must be open

No

Yes

Yes

No

Best graph capability

PageRank, shortest path, n-hop, unresolved links

Outgoing links in structured reads

Live Obsidian metadata/search

Multi-hop, centrality, clusters, suggestions

Safe editing

Partial edits; bulk dry-run, snapshot, rollback

Surgical edits and frontmatter/tag management

Live heading/block/frontmatter patching

Conflict hashes, audit rollback, Git-backed batch

Live app commands/current file

Persisted settings only

Yes

Yes

No

Remote transport

stdio, bearer HTTP over private network or HTTPS tunnel, OAuth 2.1

stdio, HTTP with JWT/OAuth

HTTP with API key

stdio, HTTP, WebSocket, TCP

Best fit

Graph + semantic context from a headless vault, including guarded remote access and edits

Rich app-driven CRUD and Omnisearch

Direct control of a running Obsidian app

Maximum breadth, multi-vault and advanced analysis

Comparison checked against each project's published documentation on 2026-07-20. A blank or narrower cell means “not documented there,” not that a project can never support it. If you need active-file state or command-palette execution, choose a plugin-backed server. If you want a headless, one-command graph server with token-budgeted context, guarded cleanup, and narrowly scoped Git checkpoints, that is the niche Obsidian Everywhere is designed for.

Everything runs locally by default. There is no account, API key, hosted vault, or telemetry requirement.

See docs/architecture.md for how it's built, docs/deploy.md for the deployment topology, and docs/ngrok-remote.md for an end-to-end external server tutorial. Git-backed vault operators should also read docs/git-vault.md.

Where does this actually run?

The obsidian-everywhere process needs direct filesystem access to your vault's .md files (to parse them, watch for changes, etc.) — so it must always run on the machine where your vault physically lives ("the vault machine": your laptop, most likely). It does not matter which client machine you're working from — the server always runs on the vault machine; only the client connection method changes.

Where you use the MCP client

What you need

The same machine as the vault

stdio. Nothing else — Codex, ChatGPT Desktop, Claude Code/Desktop, or another local client spawns the server directly.

A different machine you control (a lab/work server, another laptop, an SSH box)

Bearer-token HTTP over a private network such as Tailscale, or an HTTPS tunnel such as ngrok.

claude.ai (web app or mobile app)

OAuth HTTP + a public HTTPS URL (via Cloudflare Tunnel). claude.ai runs in Anthropic's cloud, not your network, so it can't reach Tailscale or localhost — it needs a real public address.

You can run more than one of these at once (e.g. stdio on your laptop and bearer-token HTTP for your work server) — they're independent processes that all index the same vault.

Quickstart

The fastest install needs no clone or build step. Run this on the vault machine (wherever your .md files live):

npx -y obsidian-everywhere /absolute/path/to/your/vault

MCP clients normally launch this command for you using one of the configurations below.

Not sure whether the path and runtime are ready? Run the privacy-safe diagnostic:

npx -y obsidian-everywhere doctor /absolute/path/to/your/vault

Option A — Codex CLI and ChatGPT Desktop, same machine as the vault (stdio)

Codex CLI, the Codex IDE extension, and ChatGPT Desktop's Codex experience share the same MCP configuration (official MCP documentation). Add the server once:

codex mcp add obsidian-everywhere -- npx -y obsidian-everywhere /absolute/path/to/your/vault
codex mcp list

Then restart ChatGPT Desktop (or the IDE extension). In ChatGPT Desktop you can also add it through Settings → MCP servers → Add server, choose STDIO, and enter the same command and arguments. Type /mcp in Codex to confirm that the expected tools are connected: 41 with ordinary writes enabled and Git off, or the conditional counts documented in Vault Git.

For a project-scoped configuration instead, add this to a trusted project's .codex/config.toml; use ~/.codex/config.toml to make it available globally:

[mcp_servers.obsidian-everywhere]
command = "npx"
args = ["-y", "obsidian-everywhere", "/absolute/path/to/your/vault"]
startup_timeout_sec = 30

Use an absolute vault path. GUI apps may not inherit the same PATH as your terminal; if npx is not found, replace command with the absolute result of command -v npx.

Option A′ — Claude Code, same machine as the vault (stdio)

Still on the vault machine:

claude mcp add obsidian-everywhere -- npx -y obsidian-everywhere /path/to/your/vault

Or with environment variables instead of a positional arg:

OBSIDIAN_VAULT_PATH=/path/to/your/vault claude mcp add obsidian-everywhere -- npx -y obsidian-everywhere

Option A″ — Claude Desktop, same machine as the vault

Add to claude_desktop_config.json on the vault machine:

{
  "mcpServers": {
    "obsidian-everywhere": {
      "command": "npx",
      "args": ["-y", "obsidian-everywhere", "/absolute/path/to/your/vault"]
    }
  }
}

Option A‴ — Google Antigravity CLI (agy)

Add to your global Antigravity MCP configuration file (~/.gemini/config/mcp_config.json):

{
  "mcpServers": {
    "obsidian-everywhere": {
      "command": "npx",
      "args": ["-y", "obsidian-everywhere", "/absolute/path/to/your/vault"]
    }
  }
}

Option B — Codex, ChatGPT Desktop, or Claude on a different machine

Choose one secure route to the vault machine:

  • Private network: use Tailscale and follow the steps below.

  • Public HTTPS tunnel: use the read-only-first ngrok Remote Vault Bridge tutorial. Never expose the local plaintext HTTP port directly.

Step 1 — set up a private network between the two machines, if you chose Tailscale:

# on BOTH the vault machine and the MCP client machine
curl -fsSL https://tailscale.com/install.sh | sh   # or: brew install tailscale (macOS)
tailscale up                                        # opens a browser to log in / join your "tailnet"
tailscale status                                    # confirm both machines can see each other

Note the vault machine's Tailscale hostname/IP from tailscale status (something like my-macbook.tailnet-name.ts.net or 100.x.y.z).

Step 2 — start the server, on the vault machine:

openssl rand -hex 32
# Save that output in a password manager, then use the same value on both machines.
export OBSIDIAN_EVERYWHERE_TOKEN="<saved token>"
OBSIDIAN_VAULT_PATH=/path/to/vault \
  npx -y --package obsidian-everywhere obsidian-everywhere-http

Keep the saved token — you'll need it in step 3. (To keep this running persistently instead of in a foreground terminal, see the LaunchAgent setup in docs/deploy.md, or run it in Docker via docker-compose.yml if the vault machine is a server.)

Step 3 — connect from the other machine (the lab server, etc.), using the vault machine's Tailscale address from step 1. For Codex (and the shared ChatGPT Desktop configuration), keep the token in an environment variable:

export OBSIDIAN_EVERYWHERE_CLIENT_TOKEN="<the token from step 2>"
codex mcp add obsidian-everywhere \
  --url http://<vault-machine-tailscale-name>:3737/mcp \
  --bearer-token-env-var OBSIDIAN_EVERYWHERE_CLIENT_TOKEN

Ensure ChatGPT Desktop is launched with that environment variable available, then restart it. Alternatively, use Settings → MCP servers to add the Streamable HTTP URL and bearer credential if your app version exposes those fields.

For Claude Code:

claude mcp add --transport http obsidian-everywhere \
  http://<vault-machine-tailscale-name>:3737/mcp \
  --header "Authorization: Bearer <the token from step 2>"

The second machine now has access to the vault indexed on the first. Full walkthrough (Docker, LaunchAgent): docs/deploy.md.

Option C — claude.ai web/mobile app (custom connector, OAuth)

This needs a public HTTPS endpoint — claude.ai's servers can't reach your Tailscale network or localhost. See docs/deploy.md for the full Cloudflare Tunnel walkthrough. Once your server is reachable at https://your-domain:

  1. claude.ai → Settings → Connectors → Add custom connector

  2. Server URL: https://your-domain/mcp

  3. claude.ai auto-discovers the OAuth flow and shows this server's sign-in page — enter the OAUTH_LOGIN_SECRET you configured.

You only need this if you actually want claude.ai's web/mobile apps to read your vault. If you only ever use Claude Code (locally or from another machine), skip this entirely — Option A/B already fully covers that with no Cloudflare/OAuth involved.

Configuration

Env var

Used by

Meaning

OBSIDIAN_VAULT_PATH

all

Vault path (or pass as a positional CLI arg)

OBSIDIAN_EVERYWHERE_DB

all

SQLite index path override. Filenames are transport-specific: index-stdio.db, index-http.db, or index-oauth.db. The normal default is <vault>/.obsidian-everywhere/<filename>; a directly launched macOS process whose vault is under /Volumes/ instead uses a vault-specific file under ~/.obsidian-everywhere/ to avoid unsafe SQLite WAL behavior on external filesystems. Compose sets its own explicit /vault/.obsidian-everywhere/ paths.

OBSIDIAN_EVERYWHERE_TOKEN

http-cli.js

Static bearer token

PORT

http-cli.js, oauth-http-cli.js

HTTP port (defaults 3737 / 3738)

OAUTH_ISSUER_URL

oauth-http-cli.js

Public HTTPS origin (e.g. your Cloudflare Tunnel hostname)

OAUTH_LOGIN_SECRET

oauth-http-cli.js

Single-user login secret

OBSIDIAN_EVERYWHERE_READONLY

cli.js, http-cli.js

Set to true to disable all write tools (default: write tools on)

OBSIDIAN_EVERYWHERE_ENABLE_SEMANTIC

all

Opt in after installing the optional @huggingface/transformers peer. Disabled by default because the model can exceed 500 MiB RSS; graph, FTS, and attachment search remain available.

OBSIDIAN_EVERYWHERE_MAX_ATTACHMENT_MIB

all

Maximum source attachment size for local extraction (default 64, range 1–1024). Raising it can exceed the 200 MiB memory target.

OBSIDIAN_EVERYWHERE_MAX_PDF_MIB

all

PDF-specific extraction limit (default 48, also capped by the attachment limit).

OBSIDIAN_EVERYWHERE_MAX_ARCHIVE_ENTRY_MIB

all

Maximum uncompressed XML/HTML entry read from Office/OpenDocument/EPUB archives (default 32).

OBSIDIAN_EVERYWHERE_MOUNT_GUARD

all entrypoints

Opt-in Beta mount-loss protection and automatic reconciliation

OBSIDIAN_EVERYWHERE_MOUNT_SENTINEL

all entrypoints

Optional vault-relative identity path, e.g. .obsidian/app.json

OBSIDIAN_EVERYWHERE_MOUNT_RECHECK_MS

all entrypoints

Runtime mount probe interval (default 5000)

OAUTH_ENABLE_WRITE_TOOLS

oauth-http-cli.js

Set to true to enable all write tools on the public connector (default: off)

OBSIDIAN_EVERYWHERE_GIT_MODE

direct processes and container environment

Git capability: off (default), read, commit, or push. commit/push still require the transport's ordinary write gate.

OBSIDIAN_EVERYWHERE_GIT_REPO_PATH

direct processes and container environment

One safe vault-relative real directory containing the repository; defaults to .. Git tool paths are relative to this directory, while ordinary tool paths remain vault-relative.

OBSIDIAN_EVERYWHERE_GIT_ALLOWED_PUSH_REMOTES

direct processes and container environment

Comma-separated exact name=https://host/path.git mappings, e.g. origin=https://github.com/owner/repo.git; required in push mode. URLs must contain no credentials, query, or fragment.

OBSIDIAN_EVERYWHERE_HTTP_GIT_MODE / OBSIDIAN_EVERYWHERE_HTTP_GIT_REPO_PATH / OBSIDIAN_EVERYWHERE_HTTP_GIT_ALLOWED_PUSH_REMOTES

supplied Docker Compose .env

Bearer-service inputs mapped to the three generic Git variables inside its container; mode defaults to off and repository path to ..

OBSIDIAN_EVERYWHERE_OAUTH_GIT_MODE / OBSIDIAN_EVERYWHERE_OAUTH_GIT_REPO_PATH / OBSIDIAN_EVERYWHERE_OAUTH_GIT_ALLOWED_PUSH_REMOTES

supplied Docker Compose .env

Independent OAuth-service inputs mapped inside its container; mode defaults to off and repository path to .. OAuth commit/push still requires OAUTH_ENABLE_WRITE_TOOLS=true.

Obsidian Everywhere does not modify a user's vault .gitignore. Built-in Vault Git rejects hidden .obsidian-everywhere paths, but if an index directory falls inside a repository you also manage with ordinary Git, add .obsidian-everywhere/ to that repository's own .gitignore.

Git configuration is independent of semantic search and ordinary note tools. For stdio and bearer HTTP, OBSIDIAN_EVERYWHERE_READONLY=true removes both ordinary write tools and Git commit/push. For OAuth, commit/push require both OBSIDIAN_EVERYWHERE_GIT_MODE=commit|push and OAUTH_ENABLE_WRITE_TOOLS=true. git_status, git_diff, and git_log remain read-only tools at every mode above off.

Direct CLI, HTTP, OAuth, and LaunchAgent processes read the generic Git names. The supplied docker-compose.yml deliberately uses the service-specific HTTP/OAuth .env inputs above so enabling Git for one exposed service cannot silently enable it for the other.

Development

npm run dev:stdio          # tsx, no build step
npm run dev:http
npm run dev:oauth-http
npm test                   # vitest, runs against fixtures/test-vault
npm run typecheck
npm run lint
npm run format:check
npm run memory:smoke      # asserts the default attachment workload stays below 200 MiB RSS

fixtures/test-vault/ is a 30+ note fixture vault exercising every link and parsing edge case the parser needs to handle (piped aliases, heading and block links, embeds, frontmatter-embedded wikilinks, nested tags, duplicate filenames across folders, unresolved links, code-block exclusion, and Korean filenames/tags/wikilinks). It's what every test in src/**/*.test.ts runs against.

Project status

The current release line includes the graph and optional local semantic context engine, all three transports (stdio, bearer HTTP, OAuth HTTP), 41 core MCP tools, guarded partial and bulk writes, and client setup for Codex, ChatGPT Desktop, and Claude. Remote Vault Bridge is a first-class deployment path. Its opt-in mount guard remains Beta while it receives cross-platform feedback for removable drives, NAS shares, and container mounts. The separately opt-in Vault Git tools expose read, commit, and push as progressively wider, review-gated capabilities instead of a general-purpose Git shell.

Help test a real remote-vault setup in Beta Issue #18, or ask questions in Discussion #19. A disposable vault is welcome; never share note contents, tokens, or private hostnames.

Contributing

Bug reports, feature requests, and PRs are welcome — see CONTRIBUTING.md for dev setup, testing conventions, and how the fixture vault relates to the test suite. Security issues: please see SECURITY.md rather than opening a public issue.

License

MIT — see LICENSE.

Available Tools

41 tools
add_tagsAdd TagsA

Add one or more tags to a note's frontmatter tags array, deduplicated against existing tags.

ParametersJSON Schema
NameRequiredDescriptionDefault
pathYesExisting note path, title, or alias.
tagsYesTags to add, with or without a leading #.

TDQS

A4.1/5.0
Behavior3/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

The description adds the deduplication behavior beyond the annotations (which only indicate mutation and non-destructiveness), but does not disclose what happens if the note doesn't exist or whether the file is immediately modified.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is a single, concise sentence that front-loads the action and resource, with no extraneous information.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a simple tool with two well-described parameters and no output schema, the description covers the essential behavior (adding tags, deduplication) and integrates with the schema's parameter descriptions. It is complete enough for an AI agent to use correctly.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

While the description mentions deduplication, it does not add significant meaning to the parameters beyond what the input schema already provides (e.g., path can be path/title/alias, tags can have or lack leading #). Schema coverage is 100%.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states the action ('Add one or more tags') and the target resource ('a note's frontmatter tags array'), explicitly distinguishing it from sibling tools like 'remove_tags' and 'rename_tag'.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description provides clear context for using the tool (adding tags to frontmatter), but does not explicitly exclude cases where 'update_frontmatter' might be more appropriate for arbitrary frontmatter changes.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

append_to_noteAppend To NoteA

Append content to an existing note — either at the end of the file, or at the end of a specific heading's section. Fails without writing anything if the heading isn't found. Reindexed immediately.

ParametersJSON Schema
NameRequiredDescriptionDefault
pathYesNote path, title, or alias — must already exist.
contentYesMarkdown content to append.
headingNoAppend at the end of this heading's section instead of the end of the file.

TDQS

A4.2/5.0
Behavior4/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Beyond annotations (readOnlyHint=false, destructiveHint=false), the description reveals key behaviors: the operation fails without writing if the heading is not found, and reindexing occurs immediately. This adds valuable context for an agent.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Three sentences, front-loaded with the main purpose, no unnecessary words. Every sentence adds value.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given no output schema, the description covers the core behavior, two modes, failure condition, and reindexing. It could briefly mention the return value, but overall it's sufficient for agent decision-making.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 100% with parameter descriptions. The description adds that path must already exist and clarifies the heading parameter's role and failure behavior, providing modest additional value.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states the verb 'append' and the resource 'existing note', and specifies two modes (end of file or end of a heading's section). This distinguishes it from sibling tools like patch_section and replace_text.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines3/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description implies usage for appending content but does not explicitly state when not to use it or mention alternative tools. It only provides a failure condition, which is helpful but incomplete for guiding selection among siblings.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

apply_templateApply TemplateA
Destructive

Create a new note from an existing template note (path, title, or alias), substituting Obsidian's core Templates plugin variables: {{date}}, {{date:FORMAT}}, {{time}}, {{time:FORMAT}}, {{title}}. FORMAT supports YYYY/YY/MM/DD/HH/mm/ss tokens. Templater-only syntax (<% %>) is not evaluated and is left as literal text. Fails if the target note already exists unless overwrite is set.

ParametersJSON Schema
NameRequiredDescriptionDefault
pathYesVault-relative path for the new note, e.g. 'Daily/2026-01-01' (`.md` is added automatically).
templateYesTemplate note's path, title, or alias.
overwriteNoReplace the note if it already exists (default false).
frontmatterNoExtra frontmatter fields to merge in on top of the rendered template's own frontmatter.

TDQS

A4.5/5.0
Behavior5/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

The description details the variable substitution behavior, FORMAT tokens, and that Templater syntax is left literal. This goes beyond the annotations (destructiveHint=true) to clarify the tool's exact behavior, including edge cases.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is two sentences, front-loaded with the primary action, followed by necessary details. Every sentence adds value with no redundancy or verbosity.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given no output schema, the description explains the creation and substitution behavior well, but could optionally mention the return value or error handling beyond the 'fails' condition. However, it is sufficiently complete for the tool's complexity.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters5/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 100% and the description adds significant meaning by explaining the variable substitution details, FORMAT token syntax, and the overwrite behavior. This helps the agent understand parameter usage beyond the schema.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states it creates a new note from a template note, with specific variable substitution. This distinguishes it from 'create_note', which creates a blank note, making the purpose unambiguous and differentiated.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines3/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description explains the failure condition when the target exists and the need for overwrite, but does not explicitly state when to use this tool over alternatives like 'create_note' or other sibling tools. Usage context is implied but not fully articulated.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

bulk_remove_frontmatter_fieldBulk Remove Frontmatter FieldA
Destructive

Remove exactly one frontmatter field from every note under a folder (or the whole vault) that carries it. Defaults to dry-run, enforces maxFiles, and creates a rollback snapshot (restorable via rollback_bulk_edit) when applied.

ParametersJSON Schema
NameRequiredDescriptionDefault
fieldYesTop-level frontmatter field name to remove.
dryRunNoPreview only (default true). Set false to apply.
folderNoOptional vault-relative folder scope. Omit for the whole vault.
maxFilesNoAbort above this changed-file count (default 100).

TDQS

A4.6/5.0
Behavior5/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Description adds critical behavioral context beyond annotations: defaults to dry-run, enforces maxFiles, creates rollback snapshot. This is essential for a destructive tool (annotations: destructiveHint=true). No contradiction with annotations.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Two sentences, front-loaded with the core action, then safety features. No unnecessary words. Every sentence adds value.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

No output schema, but description covers scope, field restriction, dry-run, maxFiles, and rollback. It lacks details on return value or error handling, but for a bulk tool this is sufficient. Could mention what the output looks like.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 100% (all parameters documented), so baseline is 3. The description adds value by stating the single-field limitation explicit in the operation, and reinforces defaults (dryRun true) and constraints (maxFiles cap). While schema covers individual param details, the description provides holistic context.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states the tool removes exactly one frontmatter field from every note under a folder or whole vault. It distinguishes from sibling tools like remove_frontmatter_field (single note) and bulk_update_frontmatter (different operation) by specifying the scope and single-field constraint.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description implies when to use: for bulk removal of a frontmatter field with safety features (dry-run, maxFiles, rollback). It mentions rollback_bulk_edit for restoration, providing context for safe usage. However, it could be more explicit about when not to use or compare to other bulk tools.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

bulk_replaceBulk ReplaceA
Destructive

Replace text across notes selected by folder, optionally using regex. Defaults to dry-run, reports every changed file, enforces maxFiles, and creates a rollback snapshot before applying.

ParametersJSON Schema
NameRequiredDescriptionDefault
findYesLiteral text or JavaScript regex pattern.
regexNoTreat find as a regular expression (default false).
dryRunNoPreview only (default true). Set false to apply.
folderNoOptional vault-relative folder scope.
replaceYesReplacement text; regex capture references such as $1 are supported.
maxFilesNoAbort above this changed-file count (default 100).
caseSensitiveNoRegex case sensitivity (default true).

TDQS

A4.4/5.0
Behavior5/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

The description goes beyond the annotations (destructiveHint=true) by detailing that it defaults to dry-run, reports changed files, enforces maxFiles, and creates a rollback snapshot. No contradictions with annotations.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Two sentences, front-loaded with the core action, and no wasted words. Every sentence provides valuable behavior details.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

The description covers the key behavioral aspects of the tool (dry-run, rollback, maxFiles) and output reporting. Without an output schema, it could mention the return format, but the description is sufficient for understanding the tool's purpose and side effects.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 100%, so each parameter is documented. The description does not add additional meaning beyond the schema, but it sets the overall context for parameter usage. Baseline of 3 is appropriate.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states the tool replaces text across notes selected by folder, with optional regex, and lists key default behaviors. This distinguishes it from sibling tools like replace_text, which likely operates on a single note.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description explains the default dry-run behavior and safeguards (maxFiles, rollback), which helps the agent decide when to use it. However, it does not explicitly compare to alternatives like replace_text.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

bulk_update_frontmatterBulk Update FrontmatterA
Destructive

Merge the same frontmatter fields into every note under a folder (or the whole vault). Only notes where a value actually changes are touched. Defaults to dry-run, enforces maxFiles, and creates a rollback snapshot (restorable via rollback_bulk_edit) when applied.

ParametersJSON Schema
NameRequiredDescriptionDefault
dryRunNoPreview only (default true). Set false to apply.
fieldsYesFields to add or replace on every matching note.
folderNoOptional vault-relative folder scope. Omit for the whole vault.
maxFilesNoAbort above this changed-file count (default 100).

TDQS

A4.1/5.0
Behavior4/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Annotations already mark it as destructive (destructiveHint=true), but the description adds valuable behavioral details: only notes with actual value changes are touched, it defaults to dry-run, enforces maxFiles, and creates a rollback snapshot. This goes beyond annotations by explaining safety mechanisms.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is extremely concise with two sentences. The first sentence clearly states the primary purpose, and the second sentence covers behavioral traits and safety features. Every word adds value with no redundancy.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness3/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

The tool has 4 parameters and no output schema. While the description adequately covers the input side and safety behaviors, it does not mention what the tool returns (e.g., success status, changed files count) or how errors are communicated. For a mutation tool, this information is important for the agent to handle responses correctly.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 100%, so the schema already describes each parameter. However, the description adds higher-level context: 'merge' implies addition/replacement behavior, 'defaults to dry-run' clarifies dryRun's default, and 'enforces maxFiles' gives purpose to the maxFiles parameter. This adds meaning beyond the schema's literal descriptions.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states the tool merges frontmatter fields into notes under a folder or the whole vault, using the specific verb 'merge' and specifying the resource ('frontmatter fields'). This distinguishes it from siblings like update_frontmatter (single note) and bulk_remove_frontmatter_field (removal).

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines3/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description mentions defaults like dry-run and maxFiles enforcement, giving some context on how to use it safely, but it does not explicitly state when to use this tool versus alternatives (e.g., update_frontmatter for individual notes) or when not to use it. Usage is implied rather than explicit.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

create_noteCreate NoteA
Destructive

Create a new note in the vault. Fails if the note already exists unless overwrite is set. The note is indexed immediately — outlinks/tags in its content become real graph edges right away, visible to the very next tool call.

ParametersJSON Schema
NameRequiredDescriptionDefault
pathYesVault-relative path for the new note, e.g. 'Projects/New Idea' (`.md` is added automatically).
contentNoNote body (markdown, without frontmatter).
overwriteNoReplace the note if it already exists (default false).
frontmatterNoFrontmatter fields (tags, aliases, or any custom field).

TDQS

A4.2/5.0
Behavior4/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Description adds that the note is 'indexed immediately' and outlinks/tags become graph edges, which goes beyond the annotations (destructiveHint: true). No contradiction with annotations.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Two sentences, no redundancy. First sentence states core action, second adds critical behavioral detail. Efficient and well-structured.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Covers creation behavior, overwrite, and indexing side effects. Missing description of return value or success response, but for a create tool with no output schema, the gap is small. Overall complete for the task.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 100% with detailed descriptions for each parameter. Description adds value by explaining the overwrite behavior and path automation (.md appended), but does not significantly enhance understanding beyond the schema.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

Clear verb 'Create' and resource 'note in the vault'. Differentiates from sibling tools like append_to_note and move_note by specifying creation of a new note with overwrite condition.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Mentions failure condition when note exists unless overwrite is set, giving context for when to use overwrite. Lacks explicit alternatives or when to use sibling tools, but provides solid situational guidance.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

delete_noteDelete NoteA
Destructive

Delete a note. By default it is moved to the vault's .trash folder and deletion is refused when backlinks exist. Permanent deletion and backlink override must be explicit.

ParametersJSON Schema
NameRequiredDescriptionDefault
pathYesExisting note path, title, or alias.
forceNoAllow deletion when backlinks exist (default false).
permanentNoUnlink permanently instead of moving to .trash (default false).

TDQS

A4.6/5.0
Behavior5/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Annotations already indicate destructiveHint: true and readOnlyHint: false. Description adds valuable behavioral context: default trash behavior, backlink protection, permanent deletion option, far exceeding what annotations provide.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Two sentences, front-loaded with purpose, followed by key behavioral details. No wasted words, efficient and clear.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a 3-parameter tool with no output schema, description covers behavioral aspects and parameter implications adequately. Could potentially mention return values but not required.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Input schema has 100% coverage for parameters (path, force, permanent). Description adds meaning by explaining the effect of force (override backlink refusal) and permanent (bypass trash), enhancing semantic understanding.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

Description clearly states 'Delete a note' and elaborates on default behavior (trash, backlink refusal) and explicit options (permanent, force). Distinguishes from sibling tools like move_note or create_note by specifying deletion semantics.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Explicitly describes when to use (deletion) and when deletion is refused (backlinks exist, unless force). Does not directly compare to alternative tools but provides clear context for proper invocation.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

find_orphansFind OrphansA
Read-onlyIdempotent

List notes with no outgoing or incoming links — useful for vault maintenance.

ParametersJSON Schema
NameRequiredDescriptionDefault

No parameters

TDQS

A4.3/5.0
Behavior3/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Annotations already indicate it is read-only and idempotent. The description adds the specific behavior of listing orphans, which is consistent and adds no contradictions.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is a single sentence that is entirely front-loaded and contains no fluff or unnecessary information.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a tool with no parameters and a simple output, the description fully explains its purpose and result, which is complete given the context.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

There are zero parameters, so the description does not need to explain any. Baseline of 4 is appropriate as the schema coverage is 100% and no params exist.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states it lists notes with no outgoing or incoming links, and it distinguishes itself from sibling tools like search_notes or get_backlinks which have different purposes.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description mentions it is useful for vault maintenance, which implies its usage context, but does not explicitly state when not to use or provide alternatives.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

find_pathFind PathA
Read-onlyIdempotent

Find the shortest connection path between two notes (links treated as undirected), with a one-line summary of each note along the way. Shows how two concepts are actually connected in the vault.

ParametersJSON Schema
NameRequiredDescriptionDefault
toYesDestination note path, title, or alias.
fromYesStarting note path, title, or alias.

TDQS

A4/5.0
Behavior4/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Annotations already indicate read-only, idempotent, non-destructive behavior. The description adds that links are treated as undirected and returns a path with summaries, which are useful behavioral details beyond annotations.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Two sentences, no redundancy. The primary action and result are front-loaded in the first sentence.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given two parameters and no output schema, the description covers the algorithm, link treatment, and output format. Minor omission: behavior when no path exists is not mentioned, but overall sufficient.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 100%, so the schema already documents both parameters. The description does not add additional meaning to the parameters beyond the operation context.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states it finds the shortest connection path between two notes, treating links as undirected, and provides one-line summaries. This distinguishes it from siblings like get_backlinks or search_notes.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines3/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description implies usage for exploring conceptual connections but does not explicitly state when to use versus alternatives or when not to use. No exclusions or alternatives are mentioned.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

find_unresolvedFind Unresolved LinksA
Read-onlyIdempotent

List links that don't resolve to any note in the vault, grouped by target — useful for vault maintenance.

ParametersJSON Schema
NameRequiredDescriptionDefault

No parameters

TDQS

A3.9/5.0
Behavior3/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Annotations already declare readOnlyHint=true, idempotentHint=true, and destructiveHint=false, so the description adds the grouping behavior. However, it does not disclose scope (e.g., all link types) or performance implications.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is a single, front-loaded sentence with no unnecessary words. It clearly states the action and purpose.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness3/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

The tool has no output schema and a simple purpose, but the description does not fully convey the return format (e.g., how targets are grouped, or what information accompanies each link). It is adequate for a straightforward list but lacks completeness.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

The input schema has 0 parameters with 100% coverage, so the baseline is 4. The description does not need to add parameter details, and it correctly implies no inputs are required.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description uses a specific verb 'List' and resource 'links that don't resolve to any note', clearly distinguishing it from sibling tools like find_orphans (which finds notes not linked) and get_backlinks (which shows incoming links).

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines3/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description states it's 'useful for vault maintenance' but does not explicitly advise when to use this tool versus alternatives like find_orphans or search_notes, nor does it mention when not to use it.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

get_context_bundleGet Context BundleA
Read-onlyIdempotent

The killer feature: given a topic (note path/title/alias, or a search phrase), pack the center note plus its most relevant 1-hop neighbors (prioritized by backlink count, then recency) into a token budget. Prefer this over read_note when you want broad context on a topic rather than just one note.

ParametersJSON Schema
NameRequiredDescriptionDefault
topicYesNote path/title/alias, or a search phrase if no exact note matches.
tokenBudgetNoApproximate token budget (default 4000).

TDQS

A4.7/5.0
Behavior5/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Description adds behavioral details beyond annotations: prioritization by backlink count and recency, token budget constraint. Annotations already mark it read-only and idempotent; no contradictions.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Two sentences, both dense with information. No redundant or filler content. Every word earns its place.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Despite no output schema, the description fully explains what the tool returns (center note plus neighbors) and how it selects them. All aspects of behavior, parameters, and usage are covered adequately for a complex tool.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 100%, but description adds context: tokenBudget default (4000) and that topic can be a search phrase if no exact note match. This adds meaningful interpretation beyond schema.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

Description uses specific verb 'pack' and resource 'context bundle', clearly stating it gathers center note with prioritized neighbors into a token budget. It explicitly distinguishes from sibling read_note.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Directly instructs to 'Prefer this over read_note when you want broad context on a topic'. While it doesn't list when not to use, the guidance is clear and actionable.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

get_hotkeysGet Obsidian HotkeysA
Read-onlyIdempotent

Read persisted Obsidian hotkey bindings and their actual command IDs from .obsidian/hotkeys.json. This includes configured commands, not the app's full runtime command registry.

ParametersJSON Schema
NameRequiredDescriptionDefault

No parameters

TDQS

A4.5/5.0
Behavior4/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Annotations already indicate read-only, non-destructive, idempotent behavior. Description adds specific file source and clarifies inclusion of only configured commands, providing useful context beyond annotations.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Two concise sentences with no wasted words. Front-loaded with the main action, then clarifies scope.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given no parameters, no output schema, and comprehensive annotations, the description provides all necessary information: purpose, source, and scope.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

No parameters exist; schema coverage is 100%. Baseline of 4 applies. Description does not need to elaborate on parameters.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

Description clearly states it reads persisted hotkey bindings and their command IDs from a specific file. It distinguishes from siblings like set_hotkey by focusing on read-only retrieval of configured commands.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Implied usage: to view user's custom hotkeys, not full registry. No explicit when-not or alternatives mentioned, but the file path and scope provide clear context.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

get_neighborhoodGet NeighborhoodA
Read-onlyIdempotent

Get the n-hop subgraph around a note: an explicit node list and edge list, treating links as undirected for hop counting.

ParametersJSON Schema
NameRequiredDescriptionDefault
hopsNoHop radius (default 2).
pathYesNote path, title, or alias.

TDQS

A3.8/5.0
Behavior4/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Annotations already declare readOnlyHint=true, idempotentHint=true, and destructiveHint=false. The description adds value by explaining that links are treated as undirected for hop counting, and that the output is a node list and edge list. This provides context beyond the annotations.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Single sentence, no wasted words, front-loaded with key purpose and output format. Every word earns its place.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given no output schema, the description adequately explains the return structure (node list and edge list). It misses format details (e.g., what fields each node/edge has) but overall is sufficient for an agent to understand the tool's basic behavior.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 100% with both parameters (hops, path) described. The description adds minimal extra meaning beyond the schema (e.g., 'n-hop' implies hops). Baseline 3 is appropriate since the schema already clarifies the parameters.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

Description clearly states verb ('Get'), resource ('n-hop subgraph around a note'), and specifies output ('explicit node list and edge list') with a key detail (undirected links). This distinguishes it from sibling tools like get_backlinks or get_context_bundle.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines2/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

No explicit guidance on when to use this tool vs alternatives like get_backlinks (which also returns links). The description implies use for a full subgraph but doesn't state exclusion criteria or when not to use it.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

get_notes_by_tagGet Notes By TagA
Read-onlyIdempotent

List every note carrying a given tag.

ParametersJSON Schema
NameRequiredDescriptionDefault
tagYesTag without the leading #, e.g. 'project/alpha'.
includeNestedNoInclude notes tagged with nested children of this tag (default true).

TDQS

A3.6/5.0
Behavior3/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Annotations already declare readOnlyHint, idempotentHint, and destructiveHint, covering safety and idempotency. The description adds no further behavioral details beyond the purpose, such as whether notes are returned in sorted order or any limits. It is consistent but not additive.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is a single, concise sentence with no wasted words. It is appropriately front-loaded and efficient for a simple tool.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given the simple nature of the tool, the description combined with the schema and annotations provides adequate context. However, it could explicitly state that tag matching is exact (case-sensitive?) and mention the default nesting behavior, though these are partially covered in the parameter descriptions.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Both parameters have detailed descriptions in the schema (100% coverage), so the tool description adds no extra meaning beyond what the schema provides. The description does not elaborate on the parameters.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states the tool lists notes filtered by a given tag, using a specific verb ('List') and resource ('notes'). It is distinct from sibling tools like 'list_notes' (all notes) and 'search_notes' (full-text search).

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines2/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

No guidance is provided on when to use this tool versus alternatives. It does not mention that for broader searches, 'search_notes' or 'list_notes' might be more appropriate, nor does it specify any prerequisites or context.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

get_obsidian_settingsGet Obsidian SettingsA
Read-onlyIdempotent

Read the Templates folder and enabled/disabled core plugins from persisted vault settings.

ParametersJSON Schema
NameRequiredDescriptionDefault

No parameters

TDQS

A4.3/5.0
Behavior4/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Annotations already declare readOnlyHint and destructiveHint, so the description adds value by detailing what specific settings are read (Templates folder, core plugins). No contradictions.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Single sentence, front-loaded with the core action—efficient and no wasted words.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a parameterless read tool with rich annotations, the description fully explains what the tool retrieves, leaving no gaps.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

No parameters exist, and schema coverage is 100%. Baseline is 4 as description need not explain params. It correctly omits param details.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states the tool reads the Templates folder and core plugins settings from vault settings, using a specific verb and distinct resource. It stands out from siblings like read_note or search_notes by focusing on settings.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines3/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

No explicit guidance on when to use this tool versus alternatives like vault_overview or read_note. Usage is implied but not directly stated.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

list_folderList FolderA
Read-onlyIdempotent

List the immediate child folders, Markdown notes, and attachments in one vault folder.

ParametersJSON Schema
NameRequiredDescriptionDefault
folderNoVault-relative folder. Omit for the vault root.

TDQS

A4/5.0
Behavior4/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Annotations already indicate readOnlyHint=true and destructiveHint=false. The description adds value by specifying 'immediate' children (non-recursive) and the types of items listed (folders, notes, attachments). This provides useful behavioral context beyond annotations.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is a single sentence with no wasted words. It is front-loaded with the verb and scope, making it easy for an agent to quickly understand the tool's purpose.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a simple read-only list tool with one optional parameter and no output schema, the description is largely complete. It specifies what is listed and scoped. However, it does not describe the output format (e.g., list of paths or objects), which could be useful.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 100% (the parameter 'folder' has a description). The overall description does not add additional meaning to the parameter beyond what the schema already provides, though it contextualizes the parameter within the list operation.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states the verb 'List' and the resource 'immediate child folders, Markdown notes, and attachments', scoped to 'one vault folder'. This distinguishes it from siblings like list_notes (which lists all notes) and vault_overview (broader).

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines3/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description implies usage for viewing contents of a single folder, but provides no explicit guidance on when to use this tool versus alternatives like list_notes or vault_overview. No exclusions or when-not-to-use are mentioned.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

list_notesList NotesA
Read-onlyIdempotent

List note paths explicitly, optionally scoped to a folder, with pagination. Use this instead of an empty full-text search when enumerating files. Pass properties to project specific frontmatter fields (e.g. status, project) alongside each note without reading every note individually.

ParametersJSON Schema
NameRequiredDescriptionDefault
limitNoMax notes (default 100).
folderNoVault-relative folder. Omit for the vault root.
offsetNoZero-based result offset.
recursiveNoInclude nested folders (default true).
propertiesNoFrontmatter field names to include per note, e.g. ['status', 'project']. Missing fields are null.

TDQS

A4.4/5.0
Behavior4/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Annotations already declare readOnlyHint, idempotentHint, and no destructive hint. The description adds behavioral context: returns paths (not full content), supports folder scoping, pagination, and the ability to project frontmatter fields via the properties parameter. There is no contradiction with annotations.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is three sentences long, front-loaded with the main purpose, followed by a usage guideline, then an explanation of a key parameter. Every sentence serves a purpose with no redundancy.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

The tool has 5 parameters, all documented in schema, and no output schema. The description explains what is returned (paths and optionally frontmatter fields) and mentions pagination. This is adequate for a read-only list operation, though it could be more explicit about the return format (array, structure).

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 100%, so baseline is 3. The description adds meaning by explaining the purpose of the properties parameter: 'to project specific frontmatter fields... without reading every note individually.' It also contextualizes limit/offset as pagination. This adds value beyond the schema descriptions.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states 'List note paths' with optional folder scoping and pagination. It explicitly distinguishes itself from sibling tools like search_notes by advising 'Use this instead of an empty full-text search when enumerating files.' The verb and resource are specific and unambiguous.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description provides a clear when-to-use: 'Use this instead of an empty full-text search when enumerating files.' This helps differentiate from search_notes. However, it does not explicitly list when not to use or mention other alternatives among the many sibling tools.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

list_tagsList TagsA
Read-onlyIdempotent

List the full tag hierarchy (including nested #parent/child tags) with note counts.

ParametersJSON Schema
NameRequiredDescriptionDefault

No parameters

TDQS

A4.1/5.0
Behavior4/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Annotations already declare readOnlyHint=true, idempotentHint=true, destructiveHint=false, making the non-destructive nature clear. The description adds valuable context about the hierarchical output and note counts, which annotations don't cover.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is a single, front-loaded sentence with no unnecessary words. It fully conveys the tool's purpose and key details.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a simple read-only tool with no output schema, the description completely covers what the tool returns (tag hierarchy with note counts). No additional information is needed.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

There are no parameters, and schema description coverage is 100%. The description does not need to add parameter semantics; baseline is 4.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states the tool lists the full tag hierarchy with note counts, distinguishing it from siblings like get_notes_by_tag (which retrieves notes for a specific tag).

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines2/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

No guidance is provided on when to use this tool versus alternatives (e.g., get_notes_by_tag). The description lacks explicit when/when-not or exclusion criteria.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

move_noteMove NoteA
Destructive

Move a note to a new vault-relative path and update every resolvable wikilink/Markdown link that pointed to it. Fails if the destination exists.

ParametersJSON Schema
NameRequiredDescriptionDefault
toYesNew vault-relative path; .md is added automatically.
fromYesExisting note path, title, or alias.
updateLinksNoRewrite inbound links (default true).

TDQS

A4/5.0
Behavior4/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Description adds crucial behaviors beyond annotations: link updating and failure condition. Annotations say destructiveHint=true but no further details. Description fills gap with concrete side effects.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Two sentences, zero waste. Each sentence conveys essential information: action, side effect, and constraint. Front-loaded with verb and resource.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Covers purpose, key behavior, and failure case. Missing prerequisites (e.g., note must exist) and return value. Given no output schema, description could mention success signal. Still fairly complete for a mutation tool with good annotations.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 100%, so description adds little beyond schema. It restates 'vault-relative' path and link update behavior, but doesn't clarify parameter types or defaults more than the schema's own descriptions.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description states a specific verb (Move), resource (note), and key behaviors (update links, fails if destination exists). It distinguishes from sibling tools like rename_note by specifying path change and link updating.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines3/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Only implicit usage context: fails on destination exists. No explicit when-to-use, when-not-to-use, or alternatives (e.g., rename_note for just renaming). Sibling tools exist but no guidance.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

patch_sectionPatch SectionA
DestructiveIdempotent

Replace the content under one heading, preserving the heading and the rest of the note.

ParametersJSON Schema
NameRequiredDescriptionDefault
pathYesExisting note path, title, or alias.
contentYesNew Markdown section content.
headingYesHeading text, without # markers.

TDQS

A4/5.0
Behavior4/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Annotations provide destructiveHint=true and idempotentHint=true. The description adds behavioral context by stating it preserves the heading and rest of the note, going beyond the annotations. However, it does not disclose edge cases like missing heading or multiple matches.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is a single, front-loaded sentence that efficiently conveys the core operation with zero wasted words.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given three parameters, no output schema, and annotations present, the description covers the essential behavior. It lacks details on error handling (e.g., heading not found) but is adequate for a straightforward patch operation.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 100% with each parameter described clearly in the schema (e.g., 'Existing note path, title, or alias'). The description adds no additional parameter meaning beyond what the schema already provides.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description 'Replace the content under one heading, preserving the heading and the rest of the note' clearly states the specific verb (replace) and resource (content under a heading), distinguishing it from siblings like replace_text (global replacement) or append_to_note.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines3/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description implies usage for modifying a section under a heading but does not explicitly state when to use this tool vs. alternatives like replace_text or update_frontmatter. No exclusions or prerequisites are mentioned.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

read_fileRead Vault FileA
Read-onlyIdempotent

Read any indexed vault file. Markdown delegates to read_note; PDF/Office/OpenDocument/EPUB/RTF/text/code/data files return locally extracted, paginated text; supported images return MCP image content. Legacy or unknown binary formats return metadata and a clear unsupported status.

ParametersJSON Schema
NameRequiredDescriptionDefault
pageNoPDF page number.
pathYesVault-relative file path (or resolvable filename).
limitNoMaximum text lines (default 500).
sheetNoXLSX sheet name.
slideNoPPTX slide number.
offsetNoZero-based extracted-text line offset.

TDQS

A4.3/5.0
Behavior4/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Annotations already declare read-only and idempotent behavior. The description adds valuable context not present in annotations: it explains output forms (paginated text, MCP image content, unsupported status), format-type branching, and delegation behavior for Markdown. This exceeds the minimum expected from annotated tools.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is two sentences with high information density. The first sentence anchors the tool's core purpose; the second efficiently lists format-specific behavior. Every clause contributes useful details without repetition or irrelevant padding.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

This is a multi-format file reader with branching behavior, but the description covers all main output modes: Markdown delegation, text extraction with pagination, image content, and unsupported binary fallback. Combined with complete schema descriptions, this is sufficient for an agent to predict and interpret results.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 100%, so all six parameters are individually documented. The description adds a context-level explanation of pagination and image output, but does not enrich semantics for specific parameters like sheet, slide, or offset. The schema already handles the heavy lifting.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states the tool's function: reading any indexed vault file. It also distinguishes itself from the read_note sibling by specifying that Markdown files delegate to read_note, while other formats return extracted text or image content. This is a specific verb-resource pairing with explicit scope.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description gives clear context for when read_file is appropriate: for PDFs, Office documents, images, and other non-Markdown files. It also implies that Markdown reading should go through read_note. However, it does not explicitly say 'use read_note instead of read_file for Markdown,' so the guidance is clear but slightly indirect.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

read_noteRead NoteA
Read-onlyIdempotent

Read a note's full content plus its graph context header (outlinks, backlinks, tags, frontmatter). Optionally read just one heading's section.

ParametersJSON Schema
NameRequiredDescriptionDefault
pathYesNote path, title, or alias.
limitNoMaximum lines to return (default 500).
offsetNoZero-based line offset within the selected content.
headingNoOnly return the section under this heading.

Output Schema

ParametersJSON Schema
NameRequiredDescription
pathNo
tagsNo
errorNo
titleNo
contentNo
headingNo
warningNo
outlinksNo
backlinksNo
paginationNo
frontmatterNo

TDQS

A4.3/5.0
Behavior4/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Annotations already declare readOnly and idempotent hints. The description adds value by specifying the exact returned content (full content + graph context header) and optional heading filtering, which goes beyond the annotation hints.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Two sentences, no wasted words. The main behavior is front-loaded, and the optional feature is clearly stated. Perfectly concise.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given the output schema exists to document return values, the description completes the context by explaining what data is returned (content + graph context) and the optional heading filter. All parameters are covered in schema, so no gaps remain.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 100% with detailed parameter descriptions. The description reiterates the optional heading feature but does not add new semantic meaning beyond what the schema provides, achieving the baseline score.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

Description clearly states the tool reads a note's full content along with graph context (outlinks, backlinks, tags, frontmatter) and optionally a specific heading section. This distinguishes it from siblings like 'get_backlinks' which only returns backlinks.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description implies usage: use when you need note content and graph context, or just a heading section. However, it does not explicitly state when not to use this tool or name specific alternatives, leaving a minor gap.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

remove_frontmatter_fieldRemove Frontmatter FieldA
DestructiveIdempotent

Remove exactly one YAML frontmatter field without replacing the note body.

ParametersJSON Schema
NameRequiredDescriptionDefault
pathYesExisting note path, title, or alias.
fieldYesTop-level frontmatter field name.

TDQS

A3.8/5.0
Behavior3/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Annotations already convey destructiveHint=true and idempotentHint=true. The description adds that it removes the field without replacing the note body. However, it does not clarify behavior when the field does not exist, which could conflict with the idempotentHint (the operation might error instead of being idempotent). Some ambiguity remains.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

A single, front-loaded sentence with no wasted words. Every part is essential and the structure is optimal for quick comprehension.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given the annotations and schema, the description is mostly complete. It could improve by mentioning edge cases (e.g., field not found) or return behavior, but these are not critical for a simple removal operation with idempotentHint.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 100%, so the schema already documents both parameters. The description adds only that the field is 'top-level frontmatter field name,' which repeats the schema description. No additional semantic value beyond the schema.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states the action ('Remove exactly one YAML frontmatter field') and the constraint ('without replacing the note body'), distinguishing it from siblings like update_frontmatter which modifies fields.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines3/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description implies usage for removing a single field but does not explicitly state when to use this vs. alternatives, nor provide any when-not guidance or exclusions. With siblings like update_frontmatter and replace_text, clearer differentiation would help.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

remove_tagsRemove TagsA
DestructiveIdempotent

Remove one or more tags from a note's frontmatter tags array.

ParametersJSON Schema
NameRequiredDescriptionDefault
pathYesExisting note path, title, or alias.
tagsYesTags to remove, with or without a leading #.

TDQS

A3.6/5.0
Behavior2/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Annotations already indicate destructiveHint=true, idempotentHint=true, and readOnlyHint=false. The description adds no further behavioral context (e.g., what happens if a tag is missing, if the path is invalid, or side effects). While not contradictory, it misses an opportunity to clarify behavior beyond annotations.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is a single sentence, immediately conveys the core action, and contains no extraneous words. It is front-loaded and efficient.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a simple mutating tool with 2 parameters and no output schema, the description is largely sufficient. However, it could mention error handling for non-existent tags or invalid paths. Annotations cover safety aspects. Overall, provides adequate context for typical use.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 100% with both parameters documented. The description adds minimal value beyond the schema—it restates the purpose. Baseline of 3 is appropriate as the description does not enhance understanding of the parameters' syntax or constraints.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states the verb 'remove', the resource 'tags from a note's frontmatter `tags` array', and implies the scope. It distinguishes from sibling tool 'add_tags' which does the opposite, and 'remove_frontmatter_field' which removes the entire field.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines3/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description implies when to use (to remove tags) but lacks explicit guidance on when not to use it or mention of alternatives. Sibling tools like 'remove_frontmatter_field' or 'add_tags' are not referenced, so an agent might need to infer context.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

rename_noteRename NoteA
Destructive

Rename a note within its current folder and update links that point to it.

ParametersJSON Schema
NameRequiredDescriptionDefault
pathYesExisting note path, title, or alias.
newNameYesNew filename only; use move_note to change folders.
updateLinksNoRewrite inbound links (default true).

TDQS

A4.3/5.0
Behavior4/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Annotations already indicate destructiveHint=true, so the tool is destructive. The description adds that it updates links, which is behavioral information beyond annotations. No contradiction; description aligns with destructive nature.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Single concise sentence that is front-loaded with the primary action. No redundant information. Every word earns its place.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness3/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

No output schema, but return values are typical for a rename operation. Description does not explain behavior when updateLinks is false or details about path resolution. Somewhat complete but could be richer for a mutation tool with destructive hint.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 100%, baseline 3. Description adds extra meaning for 'newName' parameter: 'New filename only; use move_note to change folders.' This guides the agent on correct usage. Also clarifies updateLinks boolean. Adds value beyond schema.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states it renames a note within its current folder and updates links. The verb 'rename' is specific, and the resource 'note' is unambiguous. The description distinguishes from sibling tools like move_note (which changes folder) and delete_note.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description implies when to use this tool by stating 'within its current folder', contrasting with move_note for folder changes. However, it does not explicitly provide when-not or list alternatives. An agent would infer the usage context but lacks explicit guidance.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

rename_tagRename TagA
Destructive

Rename a tag vault-wide, across both frontmatter tags arrays and inline #tag text. Defaults to dry-run and creates a rollback snapshot (restorable via rollback_bulk_edit) when applied.

ParametersJSON Schema
NameRequiredDescriptionDefault
toYesNew tag name, with or without a leading #.
fromYesExisting tag name, with or without a leading #.
dryRunNoPreview only (default true). Set false to apply.
includeNestedNoAlso rename child tags under from/ (default false), e.g. project/a -> newname/a.

TDQS

A4.7/5.0
Behavior5/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Adds behavioral details beyond annotations: dry-run default, rollback snapshot creation, and renaming across both frontmatter and inline tags.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Two sentences, no wasted words, action and scope are front-loaded.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Despite no output schema, the description covers scope, both tag types, safety features, and recovery mechanism, making it complete for a rename tool.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 100%, but description adds value by explaining dryRun's default behavior and the rollback context, beyond parameter descriptions.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description states 'Rename a tag vault-wide' with specific scope and resource, clearly distinguishing from sibling tools like rename_note or add_tags.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

It mentions dry-run default and rollback snapshot for safe usage, implying when to apply changes, but lacks explicit comparison to alternatives like add_tags or remove_tags.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

replace_textReplace TextA
Destructive

Replace exact text in one note without overwriting the full note. Multiple matches require all: true or an exact expectedOccurrences guard.

ParametersJSON Schema
NameRequiredDescriptionDefault
allNoReplace every match (default false).
findYesExact text to find.
pathYesExisting note path, title, or alias.
replaceYesReplacement text; may be empty.
expectedOccurrencesNoAbort unless this many matches exist.

TDQS

A4.1/5.0
Behavior3/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Annotations already declare destructiveHint=true, so the description correctly implies modification without full overwrite. However, it does not elaborate on reversibility or side effects, missing an opportunity to add value beyond annotations.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is two sentences with no unnecessary words. The main purpose is front-loaded, and the guidance on multiple matches is concise.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness3/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a destructive tool with 5 parameters and no output schema, the description is minimal. It does not explain return values or error conditions, and it omits details about path resolution. Adequate but could be more complete.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

With 100% schema description coverage, the baseline is 3. The description adds value by explaining the guard relationship between 'all' and 'expectedOccurrences' for multiple matches, which is not evident from the schema alone.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states the action 'replace exact text in one note' and distinguishes from overwriting the full note. It also provides guidance on handling multiple matches, which differentiates it from siblings like bulk_replace or patch_section.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description provides clear context on when to use 'all' or 'expectedOccurrences' for multiple matches, but does not explicitly state when not to use this tool or mention alternatives among siblings.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

rollback_bulk_editRollback Bulk EditA
DestructiveIdempotent

Restore every file from a rollback snapshot created by bulk_replace or rename_tag.

ParametersJSON Schema
NameRequiredDescriptionDefault
rollbackIdYesRollback ID returned by bulk_replace.

TDQS

A4.3/5.0
Behavior3/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Annotations already declare destructiveHint=true and idempotentHint=true, which the description does not contradict. The description adds minimal extra behavioral context (e.g., that it restores 'every file from a rollback snapshot'), but this is largely redundant given the annotations.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is a single, concise sentence with no wasted words. It is front-loaded with the key verb 'restore'.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a simple tool with one parameter and no output schema, the description is fully complete. It clearly explains the tool's purpose and the source of the required parameter.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

The schema covers the only parameter with 100% description. The description adds value by stating that rollbackId is returned by bulk_replace, providing context not in the schema.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states the action ('restore every file') and the specific resource ('rollback snapshot created by bulk_replace or rename_tag'). It distinguishes this tool from its siblings by specifying the exact source tools that generate the snapshots.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description implies usage when you have a rollbackId from bulk_replace or rename_tag, providing clear context. However, it does not explicitly state when not to use it or list alternatives beyond the implied sibling tools.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

search_filesSearch FilesA
Read-onlyIdempotent

Search extracted text from non-Markdown vault files (PDF, DOCX, PPTX, XLSX, OpenDocument, EPUB, RTF, and text/code/data files). Extraction is local, cached, and incremental.

ParametersJSON Schema
NameRequiredDescriptionDefault
limitNoMax results (default 10).
queryNoFull-text query. Omit to list attachments.
folderNoOptional vault-relative folder scope.
extensionNoOptional extension filter, e.g. pdf or pptx.

TDQS

A4.2/5.0
Behavior4/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Annotations already declare readOnlyHint, idempotentHint, and destructiveHint, so safety is clear. The description adds useful behavioral context beyond those annotations by stating extraction is local, cached, and incremental, which implies privacy and performance characteristics. It does not contradict annotations.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is two concise sentences, front-loaded with the main action and immediately scoped by file formats. The second sentence adds high-value behavioral context without redundancy or filler.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a simple read-only search tool with good annotations and full schema coverage, the description is nearly complete: clear purpose, file scopes, and extraction behavior. It could slightly improve by noting result shape or caveats around indexing staleness, but that is minor given the schema and sibling context.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 100%, and each parameter already has meaningful documentation. The description adds broad context about what is searched (extracted text from non-Markdown files), but does not materially extend the semantics of the individual query, limit, folder, or extension parameters.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly identifies the action ('Search extracted text') and the exact resource scope ('non-Markdown vault files'), specifying concrete file types. This firmly distinguishes it from sibling tools like search_notes, which target Markdown notes.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description gives clear context for when to use the tool: when searching text inside non-Markdown vault files. It does not explicitly name alternative tools or say 'use search_notes for Markdown', but the 'non-Markdown' scope strongly implies the intended boundary.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

search_notesSearch NotesA
Read-onlyIdempotent

Full-text search over note content and titles, with optional tag/folder filters. Each result includes its outgoing/incoming link counts and tags.

ParametersJSON Schema
NameRequiredDescriptionDefault
tagNoFilter to notes carrying this tag (nested tags match as a prefix).
limitNoMax results (default 10).
queryNoFull-text search query (FTS5 syntax). Omit to just filter by tag/folder.
folderNoFilter to notes under this vault-relative folder path.

TDQS

A4.2/5.0
Behavior4/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Annotations already declare readOnlyHint, idempotentHint, destructiveHint, so the description adds non-obvious behavioral context by noting that results include outgoing/incoming link counts and tags.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Two succinct sentences, no filler, front-loaded with the core action. Every sentence earns its place.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given no output schema, description specifies result content (link counts and tags). Lacks details on sorting or pagination, but limit is in schema. Sufficient for a search tool with good annotations.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 100% with detailed parameter descriptions (e.g., 'nested tags match as a prefix'), so the description adds minimal parameter-specific value beyond summarizing the filters. Baseline 3 is appropriate.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states it performs 'full-text search over note content and titles' with optional filters, which distinguishes it from siblings like list_notes (just list) and get_notes_by_tag (filter by tag only).

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description implies usage when full-text search is needed, and the distinction from other search tools (regex_search, list_notes) is clear, though it doesn't explicitly state when not to use or name alternatives.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

set_hotkeySet Obsidian HotkeyA
DestructiveIdempotent

Set persisted hotkey bindings for an exact Obsidian command ID. The app may need a vault reload; command IDs cannot be runtime-validated by the standalone server.

ParametersJSON Schema
NameRequiredDescriptionDefault
hotkeysYesBindings; pass an empty array to clear this command's custom hotkeys.
commandIdYesExact command ID, e.g. insert-template.

TDQS

A4.2/5.0
Behavior4/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Annotations indicate destructiveHint=true and idempotentHint=true, and the description adds valuable behavioral context: the app may need a vault reload and command IDs cannot be runtime-validated. This goes beyond what annotations provide.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Two concise sentences that are front-loaded with the main action. No fluff; every sentence adds value.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given the 2 parameters, high schema coverage, and annotations, the description covers the essential behavioral aspects. It could mention error behavior or default hotkey behavior, but it is largely complete.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 100% with helpful property descriptions. The description adds a note about validation for commandId but does not significantly enhance understanding beyond the schema. Baseline 3 is appropriate.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states the tool sets persisted hotkey bindings for a specific Obsidian command ID. It uses a specific verb ('Set') and resource ('hotkey bindings'), and the detail about exact command ID distinguishes it from general hotkey tools.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description provides clear context about when to use the tool (to set hotkeys) and mentions side effects like vault reload and validation limitations. However, it does not explicitly state when not to use it or name alternatives like get_hotkeys.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

set_templates_folderSet Templates FolderA
DestructiveIdempotent

Set the persisted folder used by Obsidian's Templates core plugin.

ParametersJSON Schema
NameRequiredDescriptionDefault
folderYesVault-relative Templates folder path.

TDQS

A3.5/5.0
Behavior3/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Annotations already indicate destructiveHint=true and idempotentHint=true, which align with the description. The description does not add extra behavioral context beyond what annotations provide, such as error handling or side effects.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

A single concise sentence that immediately conveys the purpose. No extraneous information, efficiently front-loaded.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness3/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a simple one-parameter tool with no output schema, the description is minimal but adequate. It could be more complete by explaining the effect on the plugin's behavior or persistence, but it is not insufficient.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 100% with a clear parameter description. The tool description adds no additional meaning to the parameter beyond what the schema already provides, meeting the baseline.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states the action ('set'), the resource ('persisted folder'), and the context ('Obsidian's Templates core plugin'). It uniquely identifies the tool among siblings, as no other sibling sets a templates folder.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines2/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

No guidance is provided on when to use this tool versus alternatives, nor any prerequisites or conditions. The description is purely declarative without usage context.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

update_frontmatterUpdate FrontmatterA
DestructiveIdempotent

Merge one or more fields into a note's YAML frontmatter without replacing its body.

ParametersJSON Schema
NameRequiredDescriptionDefault
pathYesExisting note path, title, or alias.
fieldsYesFields to add or replace.

TDQS

A4.2/5.0
Behavior4/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Annotations already indicate destructive and idempotent behavior. Description adds key detail that body is preserved, which is valuable context beyond basic safety flags.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Single sentence, zero redundancy. Every word earns its place.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a simple frontmatter update tool with complete schema and annotations, the description is sufficient. Could mention idempotency but not required.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema covers both parameters fully. Description mentions 'merge' and 'fields' but adds no extra constraints or format hints, so baseline score applies.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

Describes specific action (merge fields into frontmatter) and explicitly states body is not replaced, clearly distinguishing from siblings like replace_text, append_to_note, and remove_frontmatter_field.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Implies when to use (updating frontmatter without affecting body), but lacks explicit exclusions or alternatives. Still clear enough for the agent.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

validate_baseValidate Obsidian BaseA
Read-onlyIdempotent

Statically validate YAML and core structural fields in a .base file or fenced base block. Reports the limit that formula semantics and rendering require a live Obsidian app.

ParametersJSON Schema
NameRequiredDescriptionDefault
pathNoVault-relative .base or Markdown path.
contentNoBase YAML or Markdown containing fenced base blocks; overrides path.

TDQS

A4/5.0
Behavior4/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Annotations already indicate safety, idempotency, and non-destructiveness. The description adds value by specifying validation scope and a constraint (requires live Obsidian for formula semantics).

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Two concise sentences: first states primary function, second adds an important caveat. No unnecessary words.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given the simple parameter set and no output schema, the description provides sufficient detail about what is validated and a key limitation. Could mention the scope of 'core structural fields' but overall adequate.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 100% and descriptions are clear. The tool description does not add extra parameter-level meaning beyond schema documentation.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states the action (validate) and the resource (.base file or fenced base block), making it easy to distinguish from sibling tools.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines3/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

No explicit guidance on when to use this tool versus alternatives; the limitation mention is helpful but does not provide usage context.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

vault_overviewVault OverviewA
Read-onlyIdempotent

Get a high-level picture of the vault: note counts, top tags, hub notes by PageRank, and recently modified notes. Good first call at the start of a conversation.

ParametersJSON Schema
NameRequiredDescriptionDefault

No parameters

TDQS

A4.9/5.0
Behavior5/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Annotations already declare readOnlyHint=true, idempotentHint=true, destructiveHint=false. Description adds valuable detail on what specific data is returned (counts, tags, PageRank, recent modifications), enhancing transparency beyond annotations.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Two sentences, no wasted words. Front-loaded with purpose, then lists specifics, then usage guidance.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given zero parameters and no output schema, the description fully specifies what the tool returns and when to use it. No gaps.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

No parameters; schema description coverage is 100% trivially. Baseline for 0 parameters is 4. Description does not need to add parameter info.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

Clearly states verb 'Get' and resource 'high-level picture of the vault' with specific outputs (note counts, top tags, hub notes by PageRank, recently modified notes). Distinguishes itself from siblings which are more specific operations.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines5/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Explicitly says 'Good first call at the start of a conversation,' providing clear guidance on when to use.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

vault_statusVault StatusA
Read-onlyIdempotent

Report mount-guard state, index freshness, indexed counts, write availability, and the last full reconciliation.

ParametersJSON Schema
NameRequiredDescriptionDefault

No parameters

TDQS

A4.3/5.0
Behavior4/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Annotations already indicate read-only, idempotent, non-destructive behavior. The description adds specific metrics reported, which is useful context beyond annotations. Could mention authorization or rate limits but not necessary for a simple status check.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

One sentence, front-loaded with 'Report', covers all key aspects without waste. Excellent conciseness.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

With no output schema, the description adequately lists what the tool returns. For a simple status tool, this is complete enough.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

No parameters exist, and schema coverage is 100%. Baseline 4 per guidelines for zero parameters. No additional parameter info needed.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description explicitly states the tool reports specific vault status metrics (mount-guard state, index freshness, indexed counts, write availability, last full reconciliation), clearly distinguishing it from sibling tools like vault_overview or search_notes.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines3/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description implies usage for retrieving vault status, but does not explicitly state when to use this tool versus alternatives or provide any exclusions. Adequate but lacks explicit guidance.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Tool Schema Changelog

Recent tool additions, removals, and schema changes observed during successful MCP inspections. Dates show when Glama detected each change.

  1. 2 tool updatesv0.8.1
    • Addedread_file
    • Addedsearch_files
  2. 1 tool updatev0.7.0
    • Addedvault_status
  3. 16 tool updatesv0.6.0
    • Addedadd_tags
    • Addedapply_template
    • Addedbulk_remove_frontmatter_field
    • Addedbulk_update_frontmatter
    • Changedfind_orphans1 field changed
      • addedInput schema / additionalProperties
        Added value: +false
    • Changedfind_unresolved1 field changed
      • addedInput schema / additionalProperties
        Added value: +false
    • Changedget_hotkeys1 field changed
      • addedInput schema / additionalProperties
        Added value: +false
    • Changedget_obsidian_settings1 field changed
      • addedInput schema / additionalProperties
        Added value: +false
    • Changedget_related1 field changed
      • addedInput schema / properties / method
        Added value: +{
        +  "description": "Similarity method (default jaccard).",
        +  "enum": [
        +    "jaccard",
        +    "semantic"
        +  ],
        +  "type": "string"
        +}
    • Changedlist_notes1 field changed
      • addedInput schema / properties / properties
        Added value: +{
        +  "description": "Frontmatter field names to include per note, e.g. ['status', 'project']. Missing fields are null.",
        +  "items": {
        +    "minLength": 1,
        +    "type": "string"
        +  },
        +  "type": "array"
        +}
    • Changedlist_tags1 field changed
      • addedInput schema / additionalProperties
        Added value: +false
    • Changedread_note2 fields changed
      • addedOutput schema / properties / error
        Added value: +{
        +  "type": "string"
        +}
      • removedOutput schema / required
        Removed value: -[
        -  "path",
        -  "title",
        -  "content",
        -  "frontmatter",
        -  "outlinks",
        -  "backlinks",
        -  "tags",
        -  "pagination"
        -]
    • Addedremove_tags
    • Addedrename_tag
    • Addedsemantic_search
    • Changedvault_overview1 field changed
      • addedInput schema / additionalProperties
        Added value: +false
  4. 31 tool updatesv0.1.0
    • First observedappend_to_note
    • First observedbulk_replace
    • First observedcreate_note
    • First observeddelete_note
    • First observedfind_orphans
    • First observedfind_path
    • First observedfind_unresolved
    • First observedget_backlinks
    • First observedget_context_bundle
    • First observedget_hotkeys
    • First observedget_neighborhood
    • First observedget_notes_by_tag
    • First observedget_obsidian_settings
    • First observedget_related
    • First observedlist_folder
    • First observedlist_notes
    • First observedlist_tags
    • First observedmove_note
    • First observedpatch_section
    • First observedread_note
    • First observedregex_search
    • First observedremove_frontmatter_field
    • First observedrename_note
    • First observedreplace_text
    • First observedrollback_bulk_edit
    • First observedsearch_notes
    • First observedset_hotkey
    • First observedset_templates_folder
    • First observedupdate_frontmatter
    • First observedvalidate_base
    • First observedvault_overview

TDQS

A4.1/5.0
Disambiguation5/5

Each tool has a clearly defined and distinct purpose. Despite the large number of tools, descriptions are detailed and differentiate overlapping functionalities like search_notes, regex_search, and semantic_search. No two tools appear to perform the same action.

Naming Consistency5/5

All tool names follow a consistent verb_noun snake_case pattern (e.g., get_backlinks, create_note, bulk_update_frontmatter). The naming is predictable and makes tool functions easy to infer.

Tool Count3/5

With 38 tools, the count is above the typical 'well-scoped' range of 3-15. However, the server aims to cover a broad domain (Obsidian vault management), and each tool has a specific use case. The count is borderline but still reasonable for the given scope.

Completeness5/5

The tool set covers virtually all essential operations for an Obsidian vault: note CRUD, search (full-text, regex, semantic), graph exploration, tag and frontmatter management, bulk editing with rollback, and vault settings. There are no obvious missing features.

Maintenance

ActivityMaintained
ResponsivenessWithin a week

Resources

Unclaimed servers have limited discoverability.

Looking for Admin?

If you are the server author, to access and configure the admin panel.

Related MCP Connectors

Related MCP Servers

  • F
    license
    Not graded
    quality
    Not graded
    maintenance
    Enables AI assistants to read, write, search, and navigate Obsidian vault notes with support for CRUD operations, full-text search, graph navigation, daily notes, and frontmatter management.
    4,785
    -
  • A
    license
    Not graded
    quality
    D
    maintenance
    Enables Claude to interact with an Obsidian vault via the Local REST API plugin, supporting file operations, search, periodic notes, commands, and semantic search.
    4,785
    MIT
  • A
    license
    Not graded
    quality
    D
    maintenance
    Enables reading, writing, searching, and managing an Obsidian vault through Claude, operating directly on markdown files via Node.js fs without requiring the Obsidian app.
    5,784
    MIT
  • F
    license
    A
    quality
    C
    maintenance
    Enables Claude to create, read, update, and search notes in a local Obsidian vault, with automatic YAML frontmatter and folder management.
    7
    1
    -

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/junnnnnw00/obsidian-everywhere'

If you have feedback or need assistance with the MCP directory API, please join our Discord server