Obsidian Everywhere
Enables Claude clients to interact with an Obsidian vault as a knowledge graph, supporting full-text search, backlink traversal, neighborhood exploration, and note creation/append.
README
<div align="center">
🧠 Obsidian Everywhere
Your Obsidian vault, as a graph, in every Claude client.
Local Claude Code · Claude Desktop · a remote box over Tailscale · claude.ai web & mobile — one server, every surface.
</div>
This is a graph server, not a markdown file server. Claude shouldn't see
your vault as "a folder of .md files" — it should see notes and links as a
graph: backlink traversal, n-hop neighborhoods, and topic-centered context
bundles are first-class tools, not an afterthought bolted onto a file
reader. Unresolved links stay in the graph (that's a real signal about your
vault, same as it is in Obsidian itself), and every response is structured
for what an LLM actually needs — explicit link relationships, not just raw
text.
Contents
- Features
- Where does this actually run?
- Quickstart
- Configuration
- Development
- Project status
- Contributing
- License
Features
vault (.md files)
│ parse · watch
▼
SQLite index (FTS5) ⇄ in-memory graph (graphology)
│ n-hop · shortest path · PageRank
▼
14 MCP tools
│
▼
stdio · bearer-token HTTP · OAuth HTTP
- 🧩 Real graph 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 — kept in sync incrementally as files change, never rebuilt from scratch.
- 🛠️ 14 graph-native MCP tools — 12 read-only, 2 write.
- 🔌 Three ways to connect — stdio for local Claude clients, Streamable HTTP with a static bearer token for a remote Claude Code over Tailscale, and Streamable HTTP with OAuth 2.1 (PKCE + Dynamic Client Registration) for the claude.ai custom connector.
<details> <summary><strong>Full tool list</strong></summary>
Read
| Tool | What it does |
|---|---|
vault_overview |
Note counts, top tags, PageRank hub notes, recently modified — a starting orientation |
search_notes |
Full-text search with tag/folder filters, each result annotated with link counts and tags |
read_note |
Full note + graph context header (outlinks/backlinks/tags/frontmatter); optional heading-scoped read |
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 similarity over shared tags/neighbors) |
Write
| Tool | What it does |
|---|---|
create_note |
Create a new note (with frontmatter); reindexed immediately — the next tool call already sees it |
append_to_note |
Append to a note, optionally under a specific heading; fails closed if the heading isn't found |
create_note/append_to_note 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.
</details>
See docs/architecture.md for how it's built and
docs/deploy.md for the full deployment topology
(LaunchAgent, Docker, Cloudflare Tunnel).
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 where
you're typing claude from — the server always runs on the vault
machine; only the client connection method changes.
Where you run claude from |
What you need |
|---|---|
| The same machine as the vault | stdio. Nothing else — Claude Code/Desktop spawns the server directly. |
| A different machine you control (a lab/work server, another laptop, an SSH box) | Bearer-token HTTP + a private network between the two machines (we recommend Tailscale — free, five-minute setup, works across NAT/firewalls without port forwarding). |
| 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
Run this on the vault machine (wherever your .md files live):
git clone https://github.com/junnnnnw00/obsidian-everywhere.git
cd obsidian-everywhere
npm install
npm run build
Option A — Claude Code, same machine as the vault (stdio)
Still on the vault machine:
claude mcp add obsidian-everywhere -- node "$(pwd)/dist/cli.js" /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 -- node "$(pwd)/dist/cli.js"
Option A′ — Claude Desktop, same machine as the vault
Add to claude_desktop_config.json on the vault machine:
{
"mcpServers": {
"obsidian-everywhere": {
"command": "node",
"args": ["/absolute/path/to/obsidian-everywhere/dist/cli.js", "/absolute/path/to/your/vault"]
}
}
}
Option B — Claude Code on a different machine (a lab/work server, etc.)
Step 1 — set up a private network between the two machines, if you don't have one already. Easiest option is Tailscale:
# on BOTH the vault machine and the machine you'll run `claude` from
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:
OBSIDIAN_VAULT_PATH=/path/to/vault OBSIDIAN_EVERYWHERE_TOKEN=$(openssl rand -hex 32) \
node dist/http-cli.js
Keep this 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. —
wherever you actually type claude), using the vault machine's Tailscale
address from step 1:
claude mcp add --transport http obsidian-everywhere \
http://<vault-machine-tailscale-name>:3737/mcp \
--header "Authorization: Bearer <the token from step 2>"
That's it — claude on the second machine now has full 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 (including the no-domain-needed
Quick Tunnel option for testing). Once your server is reachable at
https://your-domain:
- claude.ai → Settings → Connectors → Add custom connector
- Server URL:
https://your-domain/mcp - claude.ai auto-discovers the OAuth flow and shows this server's sign-in
page — enter the
OAUTH_LOGIN_SECRETyou 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 (default: <vault>/.obsidian-everywhere/index.db) |
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 create_note/append_to_note (default: write tools on) |
OAUTH_ENABLE_WRITE_TOOLS |
oauth-http-cli.js |
Set to true to enable create_note/append_to_note on the public connector (default: off) |
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
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
v0.1, feature-complete: full graph engine, all three transports (stdio,
bearer-token HTTP, OAuth HTTP), 14 MCP tools including write tools. A few
things need a human to finish (registering the claude.ai connector, an
actual Cloudflare Tunnel account) since they require a browser/account —
see docs/deploy.md. Tested against both the fixture vault and a real
58-note personal vault with Korean content.
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.
推荐服务器
Baidu Map
百度地图核心API现已全面兼容MCP协议,是国内首家兼容MCP协议的地图服务商。
Playwright MCP Server
一个模型上下文协议服务器,它使大型语言模型能够通过结构化的可访问性快照与网页进行交互,而无需视觉模型或屏幕截图。
Magic Component Platform (MCP)
一个由人工智能驱动的工具,可以从自然语言描述生成现代化的用户界面组件,并与流行的集成开发环境(IDE)集成,从而简化用户界面开发流程。
Audiense Insights MCP Server
通过模型上下文协议启用与 Audiense Insights 账户的交互,从而促进营销洞察和受众数据的提取和分析,包括人口统计信息、行为和影响者互动。
VeyraX
一个单一的 MCP 工具,连接你所有喜爱的工具:Gmail、日历以及其他 40 多个工具。
graphlit-mcp-server
模型上下文协议 (MCP) 服务器实现了 MCP 客户端与 Graphlit 服务之间的集成。 除了网络爬取之外,还可以将任何内容(从 Slack 到 Gmail 再到播客订阅源)导入到 Graphlit 项目中,然后从 MCP 客户端检索相关内容。
Kagi MCP Server
一个 MCP 服务器,集成了 Kagi 搜索功能和 Claude AI,使 Claude 能够在回答需要最新信息的问题时执行实时网络搜索。
e2b-mcp-server
使用 MCP 通过 e2b 运行代码。
Neon MCP Server
用于与 Neon 管理 API 和数据库交互的 MCP 服务器
Exa MCP Server
模型上下文协议(MCP)服务器允许像 Claude 这样的 AI 助手使用 Exa AI 搜索 API 进行网络搜索。这种设置允许 AI 模型以安全和受控的方式获取实时的网络信息。