Quick Install
Get MCPVault running in seconds with any MCP-compatible platform
Configure Your AI Platform
{
"mcpServers": {
"obsidian": {
"command": "npx",
"args": ["@bitbonsai/mcpvault@latest", "/path/to/your/vault"]
}
}
}Optional no-path mode: if your client starts MCPVault from inside your vault folder, you can omit the vault path and use current working directory.
npx @bitbonsai/mcpvault@latest"args": ["@bitbonsai/mcpvault@latest"]Read-only mode: add --read-only after the vault path. Mutating tools are hidden from discovery and rejected if called directly.
"args": ["@bitbonsai/mcpvault@latest", "/path/to/vault", "--read-only"]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
~/Library/Application Support/Claude/claude_desktop_config.json%APPDATA%\Claude\claude_desktop_config.json~/.claude.jsonclaude mcp add-json --scope user for global access~/Library/Application Support/ChatGPT/chatgpt_config.json%APPDATA%\ChatGPT\chatgpt_config.json~/.gemini/settings.jsonopencode.json~/.config/opencode/opencode.json~/.codex/config.toml%USERPROFILE%\.codex\config.tomlNeed your vault path?
Option and choose Copy "..." as Pathname.Shift, right-click your vault folder, and choose Copy as path.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, MCPVault uses the current working directory as vault root.
npx @bitbonsai/mcpvault@latestnpm startDevelopers: Test with MCP Inspector
MCP Inspector provides a web UI to test all MCP methods interactively.
- Testing server functionality before integration
- Debugging MCP method calls and responses
- Exploring available tools and resources
- Development and troubleshooting
What "private" means:
You're all set!
Restart your AI platform and you'll see MCPVault connected. Your AI assistant can now safely read, search, and manage your Obsidian vault.