Metadata-Version: 2.3
Name: mcp-obsidian-vault
Version: 0.1.1
Summary: Claude Desktop MCP server for Obsidian vaults
License: MIT
Keywords: obsidian,mcp,claude,ai,notes
Author: ldraney
Requires-Python: >=3.10,<4
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Requires-Dist: mcp (>=1.0.0)
Description-Content-Type: text/markdown

# Obsidian MCP

**Give Claude Desktop access to your Obsidian vault. No plugins required.**

Install the extension, and Claude can read your notes, search them, create new ones, and open them in Obsidian.

## What Is This?

An MCP server that connects Claude Desktop to your Obsidian vault:

- **Auto-discovers your vaults** — no config needed
- **Read & search notes** — find anything in your vault
- **Create & edit notes** — write to your vault from Claude
- **Open in Obsidian** — jump to any note in the app

## Installation

```bash
uvx obsidian-mcp
```

That's it. Claude Desktop will detect the server.

## How It Works

We use Obsidian's native interfaces—no community plugins required:

| What | How |
|------|-----|
| Find your vaults | Read `obsidian.json` (Obsidian stores vault paths here) |
| Read/write notes | Direct filesystem access (your vault is just markdown files) |
| Search | Full-text search across all notes |
| Open notes | Native `obsidian://` URI scheme |

## Status

**Early Development** — Building the foundation:

| Phase | What | Status |
|-------|------|--------|
| 1 | Vault discovery | Planned |
| 2 | Read/write notes | Planned |
| 3 | Search | Planned |
| 4 | URI integration | Planned |
| 5 | PyPI + uvx release | Planned |

See [issues](https://github.com/ldraney/obsidian-mcp/issues) for detailed roadmap.

## Documentation

| Document | What's Inside |
|----------|---------------|
| [docs/user-story.html](docs/user-story.html) | Vision, user journey |
| [docs/architecture.html](docs/architecture.html) | Technical diagrams |
| [docs/roadmap.html](docs/roadmap.html) | Development phases |
| [CLAUDE.md](CLAUDE.md) | Development approach |

Open the `.html` files in your browser to see the diagrams.

## Why Another Obsidian MCP?

There are several Obsidian MCP servers on PyPI. This one is different:

1. **Zero config** — auto-discovers vaults, no paths to configure
2. **No plugins** — doesn't require Obsidian REST API plugin
3. **Hybrid approach** — filesystem for data, native URIs for actions
4. **Clean SDK** — `obsidian-sdk` can be used standalone

## Architecture

```
obsidian-sdk/          # Pure Python SDK (published separately)
├── client.py          # High-level ObsidianClient
├── vault.py           # Vault discovery
├── notes.py           # Note CRUD
└── search.py          # Full-text search

obsidian-mcp-server/   # MCP server wrapping the SDK
├── server.py          # MCP tools
└── __main__.py        # Entry point
```

## Contributing

This project is in early development. Check the [issues](https://github.com/ldraney/obsidian-mcp/issues) if you want to help.

## License

MIT

