Skip to content

Conversation

@vanmarkic
Copy link

Summary

  • Adds comprehensive documentation for installing the MCP server outside the Obsidian vault
  • Addresses use cases like OneDrive compatibility and multi-vault setups
  • Provides step-by-step installation instructions with platform-specific paths

Changes

  • Added new section to README.md with external installation guide
  • Includes configuration examples for different scenarios
  • Documents environment variable setup for external installations

Related Issue

Addresses enhancement #28

🤖 Generated with Claude Code

…jacksteamdev#28)

Added detailed documentation for users who need to install the MCP server binary outside their Obsidian vault directory, particularly for users affected by cloud sync services (OneDrive, Google Drive) that automatically remove executable files.

**New Documentation Includes:**

1. **Step-by-step installation guide:**
   - Creating external installation directory
   - Downloading the correct platform binary
   - Setting executable permissions
   - Manual MCP client configuration

2. **Platform-specific paths:**
   - macOS/Linux: ~/.local/share/obsidian-mcp-tools/bin/
   - Windows: %LOCALAPPDATA%\obsidian-mcp-tools\bin\

3. **Complete configuration examples:**
   - JSON configuration with absolute paths
   - Environment variable setup
   - API key integration

4. **Benefits clearly outlined:**
   - Cloud sync compatibility
   - Binary/data separation
   - Multi-vault support
   - Independent update management

This provides a workaround for issue jacksteamdev#28 until native UI support for custom installation paths can be implemented. Users can now manually install the server outside their vault and configure it to work with any MCP client.

Addresses jacksteamdev#28
@netlify
Copy link

netlify bot commented Nov 15, 2025

Deploy Preview for superb-starlight-b5acb5 canceled.

Name Link
🔨 Latest commit 2774f67
🔍 Latest deploy log https://app.netlify.com/projects/superb-starlight-b5acb5/deploys/6918c13e8cd91f0008867e34

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants