vault-mcp
Provides tools for searching, reading, creating, editing, renaming, and relating notes within an Obsidian-style markdown vault, including YAML frontmatter and wiki-link support.
Click on "Install Server".
Wait a few minutes for the server to deploy. Once ready, it will show a "Started" state.
In the chat, type
@followed by the MCP server name and your instructions, e.g., "@vault-mcpWhat notes do I have about the OpenAI API?"
That's it! The server will respond to your query, and you can continue using it as needed.
Here is a step-by-step guide with screenshots.
vault-mcp
An MCP server that exposes a markdown vault (Obsidian-style: YAML frontmatter +
[[wiki-links]]) as a shared memory substrate for coding/research agents —
Claude Code, Gemini CLI, Codex, or anything else that speaks MCP.
Design
The vault is the source of truth. Durable, human-readable markdown files, versioned by git/jj. The server never stores state anywhere else.
The DuckDB index is disposable infrastructure. Frontmatter and wiki-links are parsed into an in-memory DuckDB database that backs search filters,
related, andquery. It is rebuilt from the files on demand (30s TTL, invalidated on every write) and is never authoritative.Writes are constrained verbs, never arbitrary file writes. Each write tool targets one convention-enforced location (an atomic note, an inbox item, a journal log line). Version control is the safety net.
The rule that matters more than the machinery, baked into the server's MCP instructions so every connected agent receives it:
The vault is a collection of durable, human-readable artifacts — not an agent transcript store. Do not create memories merely because information appeared in a conversation. Write a memory only when it represents a durable fact, decision, idea, relationship, or useful piece of project context.
Related MCP server: research-memory-mcp
Tool surface
Tool | Kind | What it does |
| read |
|
| read | resolve a vault-relative path, note name, or frontmatter alias (typos auto-correct above 0.95 similarity; below that the error carries did-you-mean candidates) |
| read | graph neighborhood: outlinks, backlinks, unresolved links, shared-tag neighbors |
| read | read-only SQL (DuckDB dialect, SELECT/WITH only) over |
| read | most recently modified notes |
| write | atomic idea note in |
| write | exact string replacement anywhere in a note (frontmatter included); |
| write | replace a note's entire body; the frontmatter block is preserved verbatim |
| write | rename file + first H1 to the new title and rewrite |
| write | open action item under |
| write | timestamped line in today's journal |
| admin | force index rebuild; returns note/link counts |
Index schema for query:
notes(path, name, title, type, tags VARCHAR[], aliases VARCHAR[], date, status,
frontmatter JSON, modified TIMESTAMP, size, body /* SELECT columns, not * */)
links(source /* note path */, target /* wiki-link name as written */)Ranked search is DuckDB's FTS extension (BM25; digits searchable, stopwords
disabled — see docs/research/duckdb-fts.md for the extension's real
constraints). The FTS index builds lazily, once per rebuild, on first ranked
query.
templates/, raw/, and dot-directories are excluded from indexing and search.
Configuration
The vault root defaults to ~/Documents/seandavis; override with the
VAULT_MCP_ROOT environment variable.
Requires ripgrep (rg) on PATH.
Transports
vault-mcp speaks stdio by default. Pass --http to serve streamable HTTP
at /mcp (--host/--port, default 127.0.0.1:8787; also settable via
VAULT_MCP_HTTP, VAULT_MCP_HOST, VAULT_MCP_PORT).
Claude Code
# stdio (local spawn)
claude mcp add vault-memory -- uv run --directory ~/Documents/git/vault-mcp vault-mcp
# HTTP (shared server, e.g. over the tailnet)
claude mcp add --transport http vault-memory https://<machine>.<tailnet>.ts.net/mcpGemini CLI (~/.gemini/settings.json)
{
"mcpServers": {
"vault-memory": {
"command": "uv",
"args": ["run", "--directory", "/Users/davsean/Documents/git/vault-mcp", "vault-mcp"]
}
}
}Codex (~/.codex/config.toml)
[mcp_servers.vault-memory]
command = "uv"
args = ["run", "--directory", "/Users/davsean/Documents/git/vault-mcp", "vault-mcp"]Serving the tailnet
One HTTP server co-located with the vault gives every dev machine the same memory substrate — one canonical index, one writer (which also keeps Obsidian-sync conflicts down, since remote machines write through the API instead of writing files and hoping sync merges them).
macOS (launchd)
On the (Mac) machine that owns the vault, run the server as a LaunchAgent so it starts at login and restarts if it dies:
mkdir -p ~/.local/state # log destination
cp deploy/com.seandavis.vault-mcp.plist ~/Library/LaunchAgents/
launchctl bootstrap gui/$(id -u) ~/Library/LaunchAgents/com.seandavis.vault-mcp.plistThe agent runs deploy/vault-mcp-tailnet.sh, which waits for tailscaled,
resolves the machine's Tailscale IP, and binds it directly on port 9321 —
no tailscale serve layer needed.
macOS privacy (TCC): launchd jobs have no access to
~/Documents, so if the repo or the vault lives there the agent dies withOperation not permittedin the log. Grant Full Disk Access to the job's interpreter — System Settings → Privacy & Security → Full Disk Access → + → ⌘⇧G →/bin/sh— then restart it withlaunchctl kickstart -k gui/$(id -u)/com.seandavis.vault-mcp. (Terminal sessions don't hit this because the terminal app carries the grant; launchd carries none.)
Verify and manage it with:
launchctl print gui/$(id -u)/com.seandavis.vault-mcp | head # state
tail -f ~/.local/state/vault-mcp-http.log # logs
launchctl kickstart -k gui/$(id -u)/com.seandavis.vault-mcp # restart (e.g. after git pull)
launchctl bootout gui/$(id -u)/com.seandavis.vault-mcp # stop + unloadClients on the tailnet connect to http://<tailscale-ip>:9321/mcp, e.g.:
claude mcp add --transport http vault-memory http://100.72.62.9:9321/mcpLinux (systemd)
The same wrapper script works as a systemd user service on a Linux tailnet
member — deploy/vault-mcp.service carries the install steps in its header
(copy to ~/.config/systemd/user/, systemctl --user enable --now vault-mcp,
and loginctl enable-linger so it survives logout).
Security model
On the tailnet the server runs with no auth; Tailscale is the auth layer.
That holds only while it binds the machine's Tailscale IP (what the wrapper
does) or loopback behind tailscale serve — never bind 0.0.0.0. If you
want TLS and a stable DNS name instead of the raw IP, the loopback +
tailscale serve --bg --https=443 127.0.0.1:8787 arrangement still works;
the direct bind is just fewer moving parts.
OAuth (optional)
For any deployment where network trust isn't enough (the public Bioconductor layer, or defense-in-depth on the tailnet), turn on OAuth:
export VAULT_MCP_OAUTH_CLIENT_ID=$(gcloud secrets versions access latest --secret=vault-mcp-oauth-client-id)
export VAULT_MCP_OAUTH_CLIENT_SECRET=$(gcloud secrets versions access latest --secret=vault-mcp-oauth-client-secret)
vault-mcp --http --auth google --base-url https://<machine>.<tailnet>.ts.netThis is the MCP spec's OAuth 2.1 flow (via FastMCP's OAuth proxy): clients
like Claude Code discover the server's auth metadata and pop the browser
login on their own — the claude mcp add --transport http ... line doesn't
change. Register <base-url>/auth/callback as an authorized redirect URI on
the OAuth client (Google Cloud console → Credentials).
Providers are a registry in src/vault_mcp/auth.py — google and github
are wired; adding another is one entry (all FastMCP providers take
client_id / client_secret / base_url). For launchd, use
deploy/vault-mcp-http.sh, which pulls the credentials from Google Secret
Manager at boot so secrets never sit in the plist.
Development
uv run pytest # fixture-vault tests + a read-only smoke test on the real vault
uv run vault-mcp # run the server on stdio
uv run python -m vault_mcp.eval # retrieval eval (query set: <vault>/.vault-mcp/eval.yaml)Retrieval benchmark
vault_mcp.eval runs a fixed query set against each search engine and reports
rank-of-first-expected-hit, hit rate, MRR, and latency per engine
(uv run python -m vault_mcp.eval). Query sets reference real note paths, so
they live inside the vault (<vault>/.vault-mcp/eval.yaml), never in this repo.
Representative results on a ~2,200-note vault, 11 queries spanning topical paraphrases, substring/exact-phrase/regex lookups, and digit-bearing identifiers:
engine | hit@5 | hit@10 | mean latency |
| 70% | 90% | ~100 ms |
| 40% | 40% | ~75 ms |
The engines are complementary, not redundant: substring, exact-phrase, and regex queries all miss in ranked mode and hit in exact mode (BM25 tokenizes and has no phrase syntax), while topical paraphrases do the reverse (literal matching can't cross word gaps). The first ranked query after a rebuild pays the lazy BM25 index build (~200 ms at this size); a warm full index rebuild is ~630 ms.
Known failure mode: natural-language questions against long notes — the FTS extension normalizes even title-restricted matches by whole-document length, so short notes outrank long ones with exact title matches. A title-term bonus is the planned fix (tracked on the wayfinder map).
Roadmap
v0.2 — consolidation agent. Nightly promotion pass modeled on memory consolidation: scan the episodic tier (journal, inbox), search existing memories, then propose creates/merges/updates for human approval — never silent rewrites of the long-term store.
Public community layer. Anonymous-read project memory for a community (first target: Bioconductor) — same primitives (files + index + MCP), plus a curated
INDEX.mdas the human orientation layer, served without exposing private state.Embeddings — only if needed. Added as another disposable index, and only once keyword + metadata + link retrieval demonstrably misses; not part of the ontology.
Available Tools
12 toolsadd_inbox_itemA
Add an open action item to the vault inbox (the source of truth for all open action items). Use for tasks/follow-ups, not ideas or status.
| Name | Required | Description | Default |
|---|---|---|---|
| text | Yes |
Output Schema
| Name | Required | Description |
|---|---|---|
No output parameters | ||
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With no annotations, the description carries the burden of disclosing behavior. It does so by referring to the inbox as 'the source of truth' and specifying 'open action item,' indicating a write operation to a canonical store. However, it does not mention side effects, permissions, or reversibility, leaving some aspects implicit.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is two sentences, front-loaded with the primary action and followed by clear usage guidance. Every word earns its place, with no redundancy or unnecessary detail.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given the tool's simplicity (single parameter, no annotations), the description covers purpose and usage effectively. The presence of an output schema handles return values, and the usage guidance compensates for the lack of parameter specifics. Minor gaps remain regarding error cases or integration with other tools, but overall it is sufficiently complete.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
The schema has 0% description coverage for the 'text' parameter, and the description does not explicitly explain its format or content. However, the phrase 'Add an open action item' strongly implies that 'text' is the action item's text, providing minimal semantic value beyond the schema.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states the tool adds an open action item to the vault inbox, naming the resource and specifying the object ('open action item'). It distinguishes itself from sibling tools by focusing on action items rather than notes, making its purpose unambiguous.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description explicitly says 'Use for tasks/follow-ups, not ideas or status,' providing both positive and negative usage cases. This helps the agent choose this tool over alternatives like create_note or append_daily.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
append_dailyA
Append a timestamped entry to today's journal Log — for decisions, conclusions, work accomplished, and key insights as they happen.
| Name | Required | Description | Default |
|---|---|---|---|
| text | Yes |
Output Schema
| Name | Required | Description |
|---|---|---|
No output parameters | ||
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With no annotations, the description carries the burden of behavioral disclosure. It adds 'timestamped' and 'today's journal Log', but omits details like whether the log is auto-created, idempotency, or permission needs. Given the tool's simplicity, this is adequate but not comprehensive.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is a single, front-loaded sentence with no wasted words. It clearly communicates the action, target, and content scope in a compact form.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a one-parameter append tool with an output schema available, the description covers core behavior and usage context adequately. It doesn't address edge cases like missing log creation, but it's sufficient for typical use.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
The schema only provides a type 'string' for 'text', while the description gives the parameter semantic meaning by listing suitable content (decisions, conclusions, etc.) and implying automatic timestamping. This compensates well for the 0% schema coverage.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description uses a specific verb 'Append' plus a clear resource 'today's journal Log', and specifies content types (decisions, conclusions, etc.). This distinguishes it from sibling tools like create_note or edit_note which target general notes rather than a daily log.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
It conveys when to use the tool ('as they happen' for decisions/conclusions/work) which is clear context. However, it does not explicitly state when not to use it or mention alternatives, so it falls short of a full 5.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
create_noteA
Create an atomic idea note in notes/ (one idea per note, template frontmatter enforced). Use for durable ideas/insights worth keeping — search first to avoid duplicating an existing note; link related notes in the content with [[wiki-links]]. Fails if the note already exists.
| Name | Required | Description | Default |
|---|---|---|---|
| tags | No | ||
| title | Yes | ||
| source | No | ||
| content | Yes |
Output Schema
| Name | Required | Description |
|---|---|---|
No output parameters | ||
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With no annotations, the description carries the full burden and does well. It discloses atomicity (one idea per note), template frontmatter enforcement, and the failure condition on duplicates. It also mentions the wiki-link convention for related notes, making the expected behavior clear.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Three sentences, all valuable and front-loaded with the primary action. No filler, and the structure flows logically from purpose to usage to failure behavior.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
The description covers purpose, usage, failure, and linking convention, which is solid for a create tool. However, it omits details about tags/source and the exact frontmatter template, leaving some spec ambiguity that could matter for a note-taking tool with a template.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema coverage is 0%, so the description must compensate. It adds meaning around content (wiki-links) and frontmatter enforcement, but does not explain the 'tags' or 'source' parameters, which are left to names alone. This partially compensates but not fully.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states the tool creates an atomic idea note in a specific directory, with a specific verb and resource. It distinguishes the creation operation from sibling modification tools (edit, update, rename) by emphasizing the 'create' semantics and the constraint that it fails if a note exists.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description explicitly says to use it for durable ideas/insights, advises searching first to avoid duplicates (thereby pointing to the search tool as an alternative), and notes that it fails if the note already exists, implying that edit/update are for existing notes.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
edit_noteA
Surgically correct an existing note by exact string replacement.
old_text must occur exactly once in the note's current text — read_note first and copy the passage verbatim, adding surrounding lines if it is not unique. Works anywhere in the file, frontmatter included. Prefer this over update_note for corrections: it cannot drop text you did not quote.
| Name | Required | Description | Default |
|---|---|---|---|
| new_text | Yes | ||
| old_text | Yes | ||
| name_or_path | Yes |
Output Schema
| Name | Required | Description |
|---|---|---|
No output parameters | ||
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With no annotations, the description carries the full burden. It discloses the uniqueness constraint ('old_text must occur exactly once'), the safety property ('cannot drop text you did not quote'), and workspace scope. However, it does not mention error handling (e.g., if old_text is missing) or whether the operation is reversible.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is compact: exactly four sentences. It front-loads the core purpose, then provides actionable usage guidance. No filler or redundancy; every sentence earns its place.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a mutation tool with no annotations, the description covers key use cases: how to invoke correctly (read_note first, ensure uniqueness), when to prefer it over update_note, and its safety property. Since an output schema exists (per context signals), return values need not be described. Minor gaps remain (e.g., error behavior, case sensitivity), but the description is largely sufficient.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema coverage is 0%, so the description must compensate. It explicitly explains old_text ('must occur exactly once', 'copy the passage verbatim') and indirectly implies new_text as replacement. It does not explain name_or_path, but the term is self-explanatory. Overall, it adds meaning to old_text and gives usage tips, but not exhaustive coverage of all parameters.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description starts with a specific verb+resource: 'Surgically correct an existing note by exact string replacement.' This clearly distinguishes it from sibling update_note by emphasizing exact string replacement. It also notes it works anywhere in the file, including frontmatter, further clarifying scope.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
Explicitly directs users to read_note first and copy the passage verbatim, adding surrounding lines if not unique. It also states 'Prefer this over update_note for corrections: it cannot drop text you did not quote,' providing a clear alternative and rationale.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
queryA
Run read-only SQL (DuckDB dialect; SELECT/WITH only) over the vault metadata index. The index is rebuilt from the files — it is never a source of truth.
Schema: notes(path, name, title, type, tags VARCHAR[], aliases VARCHAR[], date, status, frontmatter JSON, modified TIMESTAMP, size, body /* full note text — SELECT specific columns, not * /) links(source / path /, target / wiki-link name as written */)
Examples: SELECT type, count() FROM notes GROUP BY type ORDER BY 2 DESC SELECT path, title FROM notes WHERE list_contains(tags, 'memory') SELECT target, count() n FROM links GROUP BY target ORDER BY n DESC LIMIT 20 SELECT path, json_extract_string(frontmatter, '$.status') FROM notes WHERE type = 'projects'
| Name | Required | Description | Default |
|---|---|---|---|
| sql | Yes | ||
| limit | No |
Output Schema
| Name | Required | Description |
|---|---|---|
No output parameters | ||
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
No annotations are provided, so the description carries full burden. It discloses the read-only nature, DuckDB dialect, restriction to SELECT/WITH, and importantly notes the index is rebuilt from files and is never a source of truth. It also warns against selecting 'body' with '*', adding safety-relevant behavioral detail. This goes well beyond minimal disclosure.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is front-loaded with the core purpose, then provides a compact schema and four illustrative examples. Every sentence adds value: the schema clarifies available columns, and examples show realistic queries. It is long but not wasteful, efficiently structured with clear sections.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given the tool's complexity (SQL dialect, custom schema), the description is remarkably thorough. It includes the table schemas, query constraints, examples, and a caveat about data freshness. An output schema exists, so return-value documentation is not needed. No significant gaps remain for an agent to invoke the tool correctly.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 0%, so the description must compensate. It provides multiple SQL examples that implicitly demonstrate the 'sql' parameter usage, but the 'limit' parameter is not mentioned at all. The examples give meaningful context for the sql parameter, yet the description falls short of fully compensating for the missing schema descriptions, especially for limit.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description opens with 'Run read-only SQL (DuckDB dialect; SELECT/WITH only) over the vault metadata index,' which clearly identifies the tool as a SQL query interface for vault metadata. This verb+resource+scope formulation distinguishes it from siblings like search (natural language) and read_note (single note retrieval).
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description states the tool is read-only and works specifically over the metadata index, implying usage for analytical queries rather than full-text or note retrieval. It does not explicitly name alternatives or exclusions, but the context is clear enough that an agent can infer when to use it. Lacks explicit 'use instead' guidance for siblings.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
read_noteA
Read a note by wiki-link name (e.g. 'icegate') or vault-relative path (e.g. 'notes/icegate.md'). Returns the resolved path and full content.
| Name | Required | Description | Default |
|---|---|---|---|
| name_or_path | Yes |
Output Schema
| Name | Required | Description |
|---|---|---|
No output parameters | ||
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
No annotations are provided, so the description carries the full burden. It discloses the read-only nature and the return value (resolved path and full content), but it does not mention error handling when a note is not found or resolution failures.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Two sentences, no filler, front-loaded with the action and resource. Every word contributes useful information, and the format is easy to scan.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
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 (one parameter, read operation) and the presence of an output schema, the description is complete enough. It explains how to specify the note and what is returned, leaving no critical gaps.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
The schema provides only a bare string parameter with no description. The description compensates fully by explaining the parameter can be a wiki-link name or vault-relative path and gives concrete examples, adding meaning beyond the schema.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states the tool reads a note by wiki-link name or vault-relative path, with a specific verb ('Read') and resource ('note'). It distinguishes from siblings like search or edit by specifying exactly how to identify and retrieve a note.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description provides clear context for when to use the tool: when you have a note's name or path. It does not explicitly exclude alternatives, but the input format examples make the usage scenario obvious.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
recentB
Most recently modified notes, optionally filtered by type.
| Name | Required | Description | Default |
|---|---|---|---|
| type | No | ||
| limit | No |
Output Schema
| Name | Required | Description |
|---|---|---|
| result | Yes |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With no annotations, the description must disclose behavior. It only states 'most recently modified' (implying sort order) and optional type filtering. It does not clarify return format, pagination, or whether this is a read-only operation.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is a single concise sentence that gets to the point. It is front-loaded with the primary purpose ('Most recently modified notes') and adds the optional filter as a secondary detail.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a simple list tool with an output schema, the description covers the core functionality, but lacks specifics on type values, limit behavior, and expected response structure. The presence of an output schema mitigates the lack of return documentation, but the parameter semantics remain incomplete.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
The description references the 'type' parameter through 'optionally filtered by type', but does not explain valid type values. The 'limit' parameter is entirely omitted, leaving its purpose and effects unclear. Since schema coverage is 0%, this is insufficient.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly identifies the tool's function: returning recently modified notes with an optional type filter. It distinguishes this from sibling tools like search, query, and read_note by focusing on recency rather than content search or specific note retrieval.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
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 rather than search, query, or related. The description does not mention alternatives, prerequisites, or excluded scenarios.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
refresh_indexA
Force a rebuild of the metadata index from the files on disk. Returns note and link counts.
| Name | Required | Description | Default |
|---|---|---|---|
No parameters | |||
Output Schema
| Name | Required | Description |
|---|---|---|
No output parameters | ||
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
No annotations are provided, so the description carries the full burden. It discloses that the tool forces a rebuild and returns note and link counts, but it does not mention side effects such as whether the existing index is replaced entirely, whether the operation is safe during concurrent access, or any permission requirements.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is two short sentences with no unnecessary words. It front-loads the action and directly states the return value, making it highly concise and well-structured.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a zero-parameter tool with an output schema, the description fully covers what the tool does and what it returns. It is complete for a simple maintenance operation, though additional context about usage could be included but is not essential here.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
The tool has zero parameters, so the parameter burden is minimal. The description does not need to explain parameter details, and the baseline score of 4 applies.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description uses a specific verb ('Force a rebuild') and resource ('metadata index') with a clear source ('files on disk'), distinguishing it from sibling note CRUD and search tools. It unambiguously states the tool's function.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description implies usage after disk changes or when the index is stale, but it does not explicitly state when to use this tool versus alternatives or when not to use it. No exclusion criteria or comparative guidance is provided.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
rename_noteA
Rename a note to a new title. The file becomes slugify(new_title).md in the same directory, the first H1 heading is set to the new title, and [[wiki-links]] to the old name anywhere in the vault are rewritten to the new one (|alias and #heading forms preserved). Fails if a note with the target name already exists. Returns old_path, path, links_rewritten.
| Name | Required | Description | Default |
|---|---|---|---|
| new_title | Yes | ||
| name_or_path | Yes |
Output Schema
| Name | Required | Description |
|---|---|---|
No output parameters | ||
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With no annotations, the description fully discloses behavior: file naming via slugify, H1 heading update, wiki-link rewriting with alias/heading preservation, failure on existing target name, and return values. These are concrete side effects and constraints an agent needs to know.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Three sentences with no filler. The first sentence states the core purpose, and the following sentences provide essential detail on behavior and return values. Everything earns its place.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
The description covers the action, file behavior, heading updates, link rewriting, collision handling, and key return values. The only minor gap is fully defining the name_or_path parameter format, but the parameter name and context make it understandable. The presence of an output schema reduces the need to document return structure.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema coverage is 0%, so the description must compensate. It thoroughly explains new_title (file becomes slugify(new_title).md and H1 updates), but name_or_path is only implied as the note to rename. It doesn't clarify whether it accepts a title, path, or note ID, leaving a gap for that parameter.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description opens with a specific verb+resource: 'Rename a note to a new title.' It then details the exact behavior (file renamed to slugify(new_title).md, H1 updated, wiki-links rewritten), which fully distinguishes it from siblings like edit_note or update_note.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The context is unambiguous: this tool is for renaming a note. However, it does not explicitly mention alternatives or exclusionary guidance (e.g., use edit_note for content changes). The clear scope and description of side effects make the usage evident, but explicit differentiation from sibling tools is missing.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
searchC
Search the vault's markdown files.
| Name | Required | Description | Default |
|---|---|---|---|
| tag | No | Filter to notes carrying this frontmatter tag. | |
| type | No | Filter by note type — the frontmatter `type` field, else the top-level directory (e.g. notes, decisions, journal, people, wiki). | |
| limit | No | Maximum number of notes to return. | |
| match | No | "ranked" (default) — BM25 relevance over title + body; best for topical recall ("what do I know about X"). Terms are stemmed and OR'd; there is no phrase or boolean syntax. "exact" — literal substring line-match via ripgrep, with line numbers; use for identifiers and exact phrases. "regex" — ripgrep regular expression. | ranked |
| query | Yes | What to find. |
Output Schema
| Name | Required | Description |
|---|---|---|
| result | Yes |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With no annotations provided, the description carries the full burden of behavioral disclosure, but it only states the basic function. It does not mention search modes, limitations, or result behavior, though the schema's 'match' parameter description does provide meaningful detail about BM25 vs ripgrep semantics. The description itself adds no behavioral context beyond what is inferable from the schema.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is a single, clear sentence with no fluff, effectively stating the tool's purpose. It is appropriately concise, though it could be enriched with a bit more context without becoming verbose.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Despite a detailed input schema and output schema, the tool description is minimal and does not provide tool-level context such as when to use it vs siblings or how the search behaves overall. It does not explain return values, but the output schema presumably covers that. Overall, the description is incomplete for guiding an agent on when and why to invoke this tool.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, so all five parameters are already well-documented. The tool description adds no parameter-level meaning beyond the schema, hitting the baseline of 3 for high coverage.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states a specific action ('Search') and resource ('the vault's markdown files'), conveying the tool's core purpose. It does not explicitly differentiate from sibling tools like 'query' or 'related', but the statement is unambiguous about what it operates on.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description offers no guidance on when to use this tool versus alternatives. While the 'match' parameter description in the schema provides some usage context (ranked for topical recall, exact for identifiers), the tool description itself does not mention any exclusions, prerequisites, or alternative tool recommendations.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
update_noteA
Rewrite a note's entire body. The frontmatter block is preserved verbatim (use edit_note to change frontmatter). Everything below it is replaced with content — read_note first and carry forward anything that should survive. For targeted corrections use edit_note instead.
| Name | Required | Description | Default |
|---|---|---|---|
| content | Yes | ||
| name_or_path | Yes |
Output Schema
| Name | Required | Description |
|---|---|---|
No output parameters | ||
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With no annotations provided, the description carries the full burden of behavioral disclosure. It explicitly states that the frontmatter is preserved verbatim, while everything below it is replaced with content, and warns to read first to avoid losing data. This clearly reveals the tool's destructive behavior and the safe usage pattern, going beyond simple 'update' phrasing.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is three sentences long, each earning its place: the main action, a key preservation rule with an alternative, and a usage warning. It is entirely relevant, front-loaded, and contains no filler. This is a model of conciseness.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a simple two-parameter update tool with no annotations, the description covers the core behavior, the main pitfall (data loss), and the alternative tool for different needs. The presence of an output schema means return values don't need explanation. It is complete enough for an agent to select and invoke the tool correctly.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 0%, so the description must compensate for the bare parameter definitions. It adds some meaning for 'content' by specifying that everything below frontmatter is replaced with it, but it doesn't explicitly explain 'name_or_path' beyond what the schema shows. Since the tool is simple and the parameters are inferable, the description partially compensates but leaves some ambiguity.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states the tool's function with a specific verb and resource: 'Rewrite a note's entire body.' It also distinguishes itself from edit_note by explicitly mentioning that frontmatter is preserved and that edit_note should be used for frontmatter changes and targeted corrections. This leaves no ambiguity about what the tool does.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description gives direct guidance on when to use this tool versus alternatives: 'use edit_note to change frontmatter' and 'For targeted corrections use edit_note instead.' It also advises reading the note first and carrying forward any content that should survive, which is practical usage instruction. This fully satisfies the dimension.
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.
12 tool updates
v0.1.0- First observed
add_inbox_item - First observed
append_daily - First observed
create_note - First observed
edit_note - First observed
query - First observed
read_note - First observed
recent - First observed
refresh_index - First observed
related - First observed
rename_note - First observed
search - First observed
update_note
TDQS
Most tools target distinct actions (read, search, query, create, edit, rename, etc.), but search and query both retrieve notes via different mechanisms, and edit_note vs update_note have subtle differences that could cause misselection. Overall, the detailed descriptions help clarify boundaries.
Eight tools follow a verb_noun pattern (read_note, create_note, edit_note, rename_note, update_note, add_inbox_item, append_daily, refresh_index), but four tools use single-word names (query, search, related, recent) that deviate from the pattern. This mixed convention is still readable but not fully consistent.
Twelve tools is well within the ideal 3-15 range for a domain of this scope. Each tool serves a clear purpose, covering retrieval, creation, modification, and maintenance without unnecessary bloat.
The vault domain has solid coverage for creating, reading, updating, renaming, and querying notes, but there is no delete or remove tool, which is a notable gap in the note lifecycle. Additional operations like archiving are also absent, though the core workflows are mostly covered.
Maintenance
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
Markdown-based note-taking with a hosted MCP server. Your notes serve you and your AI.
One memory, every AI. A shared, user-owned markdown memory your AI clients read and write over MCP.
Google Keep-style notes app with an MCP server for AI agents to read/write notes.
Serve a folder of Markdown notes as an MCP server: hybrid search, reading, and sourced answers.
Related MCP Servers
- AlicenseNot gradedqualityAmaintenanceBuilt-in MCP server that gives AI agents direct access to an Obsidian vault for reading, writing, searching notes, and executing commands.722,879MIT
- AlicenseNot gradedqualityBmaintenanceAn MCP server that provides controlled read/write tools for managing local-first research memory in an Obsidian vault, enabling AI agents to maintain project context across sessions.111MIT
- AlicenseNot gradedqualityAmaintenanceAn MCP server that enables AI agents to read, search, and write to your Obsidian vault.4MIT
- AlicenseNot gradedqualityBmaintenanceMCP server that turns a git-versioned Markdown vault into a queryable memory for AI agents, providing tools like brain_search, brain_read, and brain_neighbors.1Apache 2.0
Latest Blog Posts
- Who's Calling? MCP Hosts Are an Identity Blind Spot (And the Spec Knows It)By Om-Shree-0709 on .mcpAgent IdentityOAuth 2.1
- Your AI Chatbot Just Exposed Your CEO's Salary to an InternBy Om-Shree-0709 on .Agent IdentityMCP SecurityOAuth Delegation
- Why MCP Servers Need Execution Sandboxing (And Why Your Current Stack Isn't Enough)By Om-Shree-0709 on .Agentic AiPrompt InjectionWebAssembly
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/seandavi/vault-mcp'
If you have feedback or need assistance with the MCP directory API, please join our Discord server