Metadata-Version: 2.3
Name: obsidian-brain
Version: 0.1.0
Summary: Give claude access to your obsidian brain
Author-email: spongeboi <hi@spongeboi.com>
Requires-Python: >=3.10
Requires-Dist: flagembedding>=1.3.2
Requires-Dist: httpx>=0.27.2
Requires-Dist: lancedb>=0.16.0
Requires-Dist: langchain-community>=0.3.8
Requires-Dist: langchain-core>=0.3.21
Requires-Dist: markdown>=3.7
Requires-Dist: mcp>=1.0.0
Requires-Dist: rank-bm25>=0.2.2
Requires-Dist: sentence-transformers>=3.3.1
Requires-Dist: unstructured>=0.16.8
Requires-Dist: watchfiles>=1.0.0
Requires-Dist: whoosh>=2.7.4
Description-Content-Type: text/markdown

# 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`

<details>
  <summary>Development/Unpublished Servers Configuration</summary>
  ```
  "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"
      }
    }
  }
  ```
</details>

<details>
  <summary>Published Servers Configuration</summary>
  ```
  "mcpServers": {
    "obsidian-brain": {
      "command": "uvx",
      "args": [
        "obsidian-brain"
      ]
    }
  }
  ```
</details>

## Development

### Building and Publishing

To prepare the package for distribution:

1. Sync dependencies and update lockfile:
```bash
uv sync
```

2. Build package distributions:
```bash
uv build
```

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

3. Publish to PyPI:
```bash
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](https://github.com/modelcontextprotocol/inspector).


You can launch the MCP Inspector via [`npm`](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm) with this command:

```bash
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.