Skip to main content

Give claude access to your obsidian brain

Project description

obsidian-brain MCP server

Give claude access to your obsidian brain

Components

Resources

The server implements a simple note storage system with:

  • Custom note:// URI scheme for accessing individual notes
  • Each note resource has a name, description and text/plain mimetype

Prompts

The server provides a single prompt:

  • summarize-notes: Creates summaries of all stored notes
    • Optional "style" argument to control detail level (brief/detailed)
    • Generates prompt combining all current notes with style preference

Tools

The server implements one tool:

  • add-note: Adds a new note to the server
    • Takes "name" and "content" as required string arguments
    • Updates server state and notifies clients of resource changes

Configuration

[TODO: Add configuration details specific to your implementation]

Quickstart

Install

Claude Desktop

On MacOS: ~/Library/Application\ Support/Claude/claude_desktop_config.json On Windows: %APPDATA%/Claude/claude_desktop_config.json

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" } } } ```
Published Servers Configuration ``` "mcpServers": { "obsidian-brain": { "command": "uvx", "args": [ "obsidian-brain" ] } } ```

Development

Building and Publishing

To prepare the package for distribution:

  1. Sync dependencies and update lockfile:
uv sync
  1. Build package distributions:
uv build

This will create source and wheel distributions in the dist/ directory.

  1. Publish to PyPI:
uv publish

Note: You'll need to set PyPI credentials via environment variables or command flags:

  • Token: --token or UV_PUBLISH_TOKEN
  • Or username/password: --username/UV_PUBLISH_USERNAME and --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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

obsidian_brain-0.1.0.tar.gz (176.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

obsidian_brain-0.1.0-py3-none-any.whl (8.6 kB view details)

Uploaded Python 3

File details

Details for the file obsidian_brain-0.1.0.tar.gz.

File metadata

  • Download URL: obsidian_brain-0.1.0.tar.gz
  • Upload date:
  • Size: 176.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.5.4

File hashes

Hashes for obsidian_brain-0.1.0.tar.gz
Algorithm Hash digest
SHA256 2b28ad9e26d407b8ad2580af3111a004f409583b518d5b138e95df222f49f3bf
MD5 6c6183276c95f4f06a16e9c69d9dc66a
BLAKE2b-256 8bfdff76125cd42fcde915587ed898626f0280ed366bb5f639c758fb390979e5

See more details on using hashes here.

File details

Details for the file obsidian_brain-0.1.0-py3-none-any.whl.

File metadata

File hashes

Hashes for obsidian_brain-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 1713526f10dcd59861b1069c262fd1cb92cedcc178cd3f1ddcb3e9071d602015
MD5 f40c81a3ae333ec5b736ca9aef578eea
BLAKE2b-256 3f7f505639fe198ec3d11d7a5d9118854c6a3c6b276da3b14d0fc307f7e9937a

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page