obsidian-brain

Obsidian-Brain MCP Server

Unlock the powerful capabilities of your Obsidian Brain with the MCP (Model Context Protocol) server. This project enables seamless integration and interaction with your Obsidian vault, providing a robust framework for managing your knowledge and boosting productivity.

Features

• Easy Configuration: Set up your Obsidian Brain server effortlessly with straightforward command settings tailored for both published and unpublished server configurations.
• Multi-Platform Support: Compatible with both MacOS and Windows, ensuring you can access your knowledge base regardless of your operating system.
• Development Friendly: Whether you're building a personal project or contributing to the community, you'll find ample tools to help manage dependencies and publish your work.

Server Configuration Examples

Development Configuration

To configure an unpublished server, use the following command setup:

"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"
    }
  }
}

Published Configuration

For published servers, your configuration will look like:

"mcpServers": {
  "obsidian-brain": {
    "command": "uvx",
    "args": [
      "obsidian-brain"
    ],
    "env": {
      "OBSIDIAN_MIND_PATH": "/path/to/obsidian/vault"
    }
  }
}

Building and Publishing Your Package

Easily prepare your application for distribution with these simple commands:

1. Sync your dependencies and update the lockfile:

   uv sync
   

2. Build your package distributions:

   uv build
   

   This generates the necessary source and wheel distributions in the dist/ directory.
3. Publish to PyPI:

   uv publish
   

   Be sure to set up PyPI credentials securely using environment variables or command flags.

Debugging Made Easy

Debugging MCP servers can be tricky. For optimal results, utilize the MCP Inspector to streamline the debugging process:

npx @modelcontextprotocol/inspector uv --directory /Users/shubhaankar/github.com/Shubhaankar-Sharma/obsidian_brain run obsidian-brain

Launch the Inspector to view a dedicated URL for debugging in your browser.

Leverage the capabilities of your Obsidian Brain today with the MCP server, transforming how you organize and access your knowledge!