obsidian-brain MCP server
December 1, 2024 ยท View on GitHub
Give claude access to your obsidian brain
Install
Claude Desktop
On MacOS: ~/Library/Application\ Support/Claude/claude_desktop_config.json
On Windows: %APPDATA%/Claude/claude_desktop_config.json
Published Servers Configuration
"mcpServers": {
"obsidian-brain": {
"command": "uvx",
"args": [
"obsidian-brain@0.1.3"
],
"env": {
"OBSIDIAN_MIND_PATH": "/Users/myuser/path/to/obsidian/vault/"
}
}
}
Development
Development/Unpublished Servers Configuration
"mcpServers": {
"obsidian-brain": {
"command": "uv",
"args": [
"--directory",
"/Users/shubhaankar/github.com/Shubhaankar-Sharma/obsidian_brain",
"run",
"obsidian-brain"
],
"env": {
"OBSIDIAN_MIND_PATH": "/path/to/obsidian/vault"
}
}
}
Building and Publishing
To prepare the package for distribution:
- Sync dependencies and update lockfile:
uv sync
- Build package distributions:
uv build
This will create source and wheel distributions in the dist/ directory.
- Publish to PyPI:
uv publish
Note: You'll need to set PyPI credentials via environment variables or command flags:
- Token:
--tokenorUV_PUBLISH_TOKEN - Or username/password:
--username/UV_PUBLISH_USERNAMEand--password/UV_PUBLISH_PASSWORD
Debugging
Since MCP servers run over stdio, debugging can be challenging. For the best debugging experience, we strongly recommend using the MCP Inspector.
You can launch the MCP Inspector via npm with this command:
npx @modelcontextprotocol/inspector uv --directory /Users/shubhaankar/github.com/Shubhaankar-Sharma/obsidian_brain run obsidian-brain
Upon launching, the Inspector will display a URL that you can access in your browser to begin debugging.