Name: MCPVault
Author: bitbonsai

1

Configure your MCP client

AI Platform Config

{
  "mcpServers": {
    "obsidian": {
      "command": "npx",
      "args": ["@bitbonsai/mcpvault@latest", "/path/to/your/vault"]
    }
  }
}

Use the CLI

opencode mcp add

Interactive wizard — select local, then enter the command: npx -y @bitbonsai/mcpvault@latest /path/to/your/vault

Or configure manually:

{
  "$schema": "https://opencode.ai/config.json",
  "mcp": {
    "obsidian": {
      "type": "local",
      "command": ["npx", "-y", "@bitbonsai/mcpvault@latest", "/path/to/your/vault"]
    }
  }
}

Configuration Scopes

OpenCode supports multiple config locations:

opencode.jsonIn your project root for per-project config (recommended)

~/.config/opencode/opencode.jsonGlobal config for all projects

Usage Examples

After configuration, OpenCode can access your vault:

Read my meeting notes from yesterdaySearch my vault for notes about machine learningCreate a new note summarizing our discussion

Use the CLI

gemini mcp add obsidian -- npx @bitbonsai/mcpvault@latest /path/to/your/vault

Or configure manually in ~/.gemini/settings.json:

{
  "mcpServers": {
    "obsidian": {
      "command": "npx",
      "args": ["@bitbonsai/mcpvault@latest", "/path/to/your/vault"]
    }
  }
}

Usage Examples

After configuration, use commands like:

Read my daily note from yesterdaySearch my vault for meeting notesCreate a new note about project ideas

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.

Package download: npx downloads MCPVault when the client starts the server.

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, MCPVault uses the current working directory as vault root.

npx @bitbonsai/mcpvault@latestnpm start

2

Test with MCP Inspector

Terminal

# Install MCP Inspector globally

$npm install -g @modelcontextprotocol/inspector

# Test MCPVault 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.

Use it to:

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

What "private" means:

MCPVault reads files from the vault path you configure

MCPVault has no hosted service that receives your vault files

Path checks keep file tools inside the configured vault

Your AI client or provider may receive note content used in requests

Verify the connection

Restart your client, then ask it to list MCPVault tools or search for a known note.

Search notesEdit contentOrganize filesBatch operations

Install MCPVault

Configure your MCP client

Test with MCP Inspector

Verify the connection