Quick Install

Get MCP-Vault running in seconds with any MCP-compatible platform

1

Configure Your AI Platform

AI Platform Config

Optional no-path mode: if your client starts MCP-Vault from inside your vault folder, you can omit the vault path and use current working directory.

npx @bitbonsai/mcpvault@latest "args": ["@bitbonsai/mcpvault@latest"]

Supported note file types: .md, .markdown, .txt, .base, and .canvas.

No pre-installation needed! npx automatically downloads and runs the server when needed.

Config file locations
Claude Desktop (JSON)
macOS: ~/Library/Application\ Support/Claude/claude_desktop_config.json
Windows: %APPDATA%\Claude\claude_desktop_config.json
Claude Code (CLI)
User scope: ~/.claude.json
Use claude mcp add-json --scope user for global access
ChatGPT+ Desktop (JSON)
macOS: ~/Library/Application Support/ChatGPT/chatgpt_config.json
Windows: %APPDATA%\ChatGPT\chatgpt_config.json
Gemini CLI (JSON)
All platforms: ~/.gemini/settings.json
OpenCode (JSON)
Per project: opencode.json
Global: ~/.config/opencode/opencode.json
OpenAI Codex (TOML)
macOS/Linux: ~/.codex/config.toml
Windows: %USERPROFILE%\.codex\config.toml
Need your vault path?
macOS: In Finder, right-click your vault folder while holding Option and choose Copy "..." as Pathname.
Windows: In File Explorer, hold Shift, right-click your vault folder, and choose Copy as path.
Linux: Open a terminal in your vault folder and run pwd.

Replace /path/to/your/vault with that full absolute path.

Optional CWD mode

You can omit the vault path entirely when your client starts this server from inside your vault directory. In that case, MCP-Vault uses the current working directory as vault root.

npx @bitbonsai/mcpvault@latest npm start
2

Developers: Test with MCP Inspector

Terminal
# Install MCP Inspector globally
$ npm install -g @modelcontextprotocol/inspector
# Test MCP-Vault server
$ mcp-inspector npx @bitbonsai/mcpvault@latest /path/to/vault
Opens interactive web interface at http://localhost:5173

MCP Inspector provides a web UI to test all MCP methods interactively.

Perfect for:
  • Testing server functionality before integration
  • Debugging MCP method calls and responses
  • Exploring available tools and resources
  • Development and troubleshooting
View on GitHub for more details

Works with all MCP-compatible platforms: Claude Desktop, ChatGPT+, Claude Code, OpenCode, Gemini CLI, Cursor IDE, Windsurf, and more coming soon!
Use the same configuration with your platform's MCP server settings.

What "private" means:

Your vault files stay on your computer
We never see, store, or transmit your data
Only you and your AI assistant can access your notes
AI providers (Anthropic, OpenAI) process content you share with them

For commercial Claude users: Your data won't be used for AI training.

You're all set!

Restart your AI platform and you'll see MCP-Vault connected. Your AI assistant can now safely read, search, and manage your Obsidian vault.

Search notes Edit content Organize files Batch operations