vault-bridge 1.0.3__tar.gz

vault_bridge-1.0.3/PKG-INFO

@@ -0,0 +1,122 @@
+Metadata-Version: 2.4
+Name: vault-bridge
+Version: 1.0.3
+Summary: Bridge your AI assistant to local knowledge vaults — read, write, and search notes without cloud dependencies
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+Requires-Dist: fastmcp-slim[server]<4.0,>=3.4
+Requires-Dist: pyyaml>=6.0
+Requires-Dist: structlog>=24.1
+Requires-Dist: pydantic-settings>=2.3
+Provides-Extra: dev
+Requires-Dist: pytest>=8.0; extra == "dev"
+Requires-Dist: pytest-asyncio>=0.23; extra == "dev"
+Requires-Dist: pytest-cov>=5.0; extra == "dev"
+Requires-Dist: ruff>=0.4; extra == "dev"
+Requires-Dist: mypy>=1.10; extra == "dev"
+Requires-Dist: types-PyYAML; extra == "dev"
+
+# Vault Bridge
+
+Bridge your AI assistant to local knowledge vaults — read, write, search, and manage notes without cloud dependencies.
+
+## Features
+
+- **read_note** — Read a note with optional frontmatter parsing
+- **write_note** — Write notes with YAML frontmatter support
+- **list_notes** — List notes with glob filtering and recursion
+- **search_notes** — Regex search across vault content
+- **search_frontmatter** — Query notes by frontmatter key/value
+- **get_daily_note** — Get or create daily notes with templates
+
+## Installation
+
+```bash
+pip install vault-bridge
+```
+
+## Usage
+
+```bash
+vault-bridge
+```
+
+Or configure in your MCP client:
+
+```json
+{
+  "mcpServers": {
+    "vault": {
+      "command": "vault-bridge",
+      "env": {
+        "VAULT_BRIDGE_VAULT_PATH": "C:/path/to/vault"
+      }
+    }
+  }
+}
+```
+
+## Configuration
+
+| Environment Variable | Default | Description |
+|---------------------|---------|-------------|
+| `VAULT_BRIDGE_VAULT_PATH` | Current directory | Path to vault root |
+| `VAULT_BRIDGE_MAX_FILE_SIZE` | 10MB | Max file size for operations |
+| `VAULT_BRIDGE_DEFAULT_ENCODING` | utf-8 | Text encoding |
+| `VAULT_BRIDGE_INDEX_FRONTMATTER` | true | Parse YAML frontmatter |
+| `VAULT_BRIDGE_FOLLOW_SYMLINKS` | false | Follow symlinks |
+
+## Tool Reference
+
+### read_note
+```json
+{
+  "path": "Projects/roadmap.md",
+  "include_frontmatter": true
+}
+```
+
+### write_note
+```json
+{
+  "path": "Projects/new-idea.md",
+  "content": "# New Idea\n\nDetails here...",
+  "frontmatter": { "tags": ["idea", "draft"], "status": "wip" }
+}
+```
+
+### list_notes
+```json
+{
+  "path": "Projects",
+  "glob_pattern": "**/*.md",
+  "recursive": true
+}
+```
+
+### search_notes
+```json
+{
+  "pattern": "MCP",
+  "path": ".",
+  "max_results": 50
+}
+```
+
+### search_frontmatter
+```json
+{
+  "key": "status",
+  "value": "done",
+  "operator": "eq"
+}
+```
+
+### get_daily_note
+```json
+{
+  "date": "2026-08-21",
+  "folder": "Daily Notes",
+  "create_if_missing": true
+}
+```

vault_bridge-1.0.3/README.md

@@ -0,0 +1,104 @@
+# Vault Bridge
+
+Bridge your AI assistant to local knowledge vaults — read, write, search, and manage notes without cloud dependencies.
+
+## Features
+
+- **read_note** — Read a note with optional frontmatter parsing
+- **write_note** — Write notes with YAML frontmatter support
+- **list_notes** — List notes with glob filtering and recursion
+- **search_notes** — Regex search across vault content
+- **search_frontmatter** — Query notes by frontmatter key/value
+- **get_daily_note** — Get or create daily notes with templates
+
+## Installation
+
+```bash
+pip install vault-bridge
+```
+
+## Usage
+
+```bash
+vault-bridge
+```
+
+Or configure in your MCP client:
+
+```json
+{
+  "mcpServers": {
+    "vault": {
+      "command": "vault-bridge",
+      "env": {
+        "VAULT_BRIDGE_VAULT_PATH": "C:/path/to/vault"
+      }
+    }
+  }
+}
+```
+
+## Configuration
+
+| Environment Variable | Default | Description |
+|---------------------|---------|-------------|
+| `VAULT_BRIDGE_VAULT_PATH` | Current directory | Path to vault root |
+| `VAULT_BRIDGE_MAX_FILE_SIZE` | 10MB | Max file size for operations |
+| `VAULT_BRIDGE_DEFAULT_ENCODING` | utf-8 | Text encoding |
+| `VAULT_BRIDGE_INDEX_FRONTMATTER` | true | Parse YAML frontmatter |
+| `VAULT_BRIDGE_FOLLOW_SYMLINKS` | false | Follow symlinks |
+
+## Tool Reference
+
+### read_note
+```json
+{
+  "path": "Projects/roadmap.md",
+  "include_frontmatter": true
+}
+```
+
+### write_note
+```json
+{
+  "path": "Projects/new-idea.md",
+  "content": "# New Idea\n\nDetails here...",
+  "frontmatter": { "tags": ["idea", "draft"], "status": "wip" }
+}
+```
+
+### list_notes
+```json
+{
+  "path": "Projects",
+  "glob_pattern": "**/*.md",
+  "recursive": true
+}
+```
+
+### search_notes
+```json
+{
+  "pattern": "MCP",
+  "path": ".",
+  "max_results": 50
+}
+```
+
+### search_frontmatter
+```json
+{
+  "key": "status",
+  "value": "done",
+  "operator": "eq"
+}
+```
+
+### get_daily_note
+```json
+{
+  "date": "2026-08-21",
+  "folder": "Daily Notes",
+  "create_if_missing": true
+}
+```

vault_bridge-1.0.3/pyproject.toml

@@ -0,0 +1,70 @@
+[project]
+name = "vault-bridge"
+version = "1.0.3"
+description = "Bridge your AI assistant to local knowledge vaults — read, write, and search notes without cloud dependencies"
+readme = "README.md"
+requires-python = ">=3.11"
+dependencies = [
+    "fastmcp-slim[server]>=3.4,<4.0",
+    "pyyaml>=6.0",
+    "structlog>=24.1",
+    "pydantic-settings>=2.3",
+]
+
+[project.scripts]
+vault-bridge = "obsidian_mcp.server:main"
+
+[project.optional-dependencies]
+dev = [
+    "pytest>=8.0",
+    "pytest-asyncio>=0.23",
+    "pytest-cov>=5.0",
+    "ruff>=0.4",
+    "mypy>=1.10",
+    "types-PyYAML",
+]
+
+[tool.ruff]
+target-version = "py311"
+line-length = 100
+select = ["E", "F", "I", "UP", "W", "C4", "PT", "PTH", "SIM", "T10", "ARG", "RUF"]
+ignore = [
+    "S101",
+    "PTH123",
+    "ARG001",
+    "ARG002",
+    "TRY003",
+    "PLC0415",
+    "PLR2004",
+    "ARG002",
+    "SIM102",
+    "INP001",
+    "F401",
+    "W292",
+    "S603",
+    "PLW1510",
+    "PLW0603",
+    "W293",
+    "W291",
+    "E501",
+    "UP015",
+    "RUF022",
+    "I001",
+    "BLE001",
+]
+fixable = ["ALL"]
+unfixable = []
+
+[tool.ruff.format]
+quote-style = "double"
+indent-style = "space"
+
+[tool.mypy]
+python_version = "3.11"
+warn_return_any = true
+warn_unused_configs = true
+disallow_untyped_defs = true
+strict = true
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/obsidian_mcp"]

vault_bridge-1.0.3/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

vault_bridge-1.0.3/src/obsidian_mcp/__init__.py

@@ -0,0 +1,8 @@
+"""Obsidian MCP Server package."""
+
+from .core import ObsidianCore
+from .models import ObsidianConfig
+from .server import create_mcp_server
+
+__all__ = ["ObsidianConfig", "ObsidianCore", "create_mcp_server"]
+__version__ = "1.0.2"

vault_bridge-1.0.3/src/obsidian_mcp/configure.py

@@ -0,0 +1,169 @@
+"""Auto-configure CLI for vault-bridge — one-command setup like natestrong."""
+
+import json
+import sys
+from pathlib import Path
+from typing import Any, TypedDict
+
+import click
+
+from .logging import get_logger
+
+logger = get_logger(__name__)
+
+
+class ClientConfig(TypedDict):
+    config_path: Path
+    server_key: str
+    template: dict[str, Any]
+
+
+CLIENT_CONFIGS: dict[str, ClientConfig] = {
+    "claude_desktop": {
+        "config_path": Path.home() / "AppData" / "Roaming" / "Claude" / "claude_desktop_config.json",
+        "server_key": "vault-bridge",
+        "template": {
+            "mcpServers": {
+                "vault-bridge": {
+                    "command": "uvx",
+                    "args": ["vault-bridge", "{vault_path}"],
+                }
+            }
+        },
+    },
+    "cursor": {
+        "config_path": Path.home() / ".cursor" / "mcp.json",
+        "server_key": "vault-bridge",
+        "template": {
+            "mcpServers": {
+                "vault-bridge": {
+                    "command": "uvx",
+                    "args": ["vault-bridge", "{vault_path}"],
+                }
+            }
+        },
+    },
+    "windsurf": {
+        "config_path": Path.home() / ".codeium" / "windsurf" / "mcp_config.json",
+        "server_key": "vault-bridge",
+        "template": {
+            "mcpServers": {
+                "vault-bridge": {
+                    "command": "uvx",
+                    "args": ["vault-bridge", "{vault_path}"],
+                }
+            }
+        },
+    },
+}
+
+
+def load_existing_config(config_path: Path) -> dict[str, Any]:
+    """Load existing JSON config or return empty."""
+    if config_path.exists():
+        try:
+            with open(config_path, encoding="utf-8") as f:
+                data: dict[str, Any] = json.load(f)
+                return data
+        except json.JSONDecodeError:
+            return {}
+    return {}
+
+
+def save_config(config_path: Path, config: dict[str, Any]) -> None:
+    """Save JSON config with pretty formatting."""
+    config_path.parent.mkdir(parents=True, exist_ok=True)
+    with open(config_path, "w", encoding="utf-8") as f:
+        json.dump(config, f, indent=2)
+
+
+def update_config_for_client(config: dict[str, Any], server_key: str, vault_path: str) -> dict[str, Any]:
+    """Update config with vault-bridge server entry."""
+    if "mcpServers" not in config:
+        config["mcpServers"] = {}
+
+    config["mcpServers"][server_key] = {
+        "command": "uvx",
+        "args": ["vault-bridge", vault_path],
+    }
+    return config
+
+
+@click.command()
+@click.option(
+    "--vault-path",
+    "-v",
+    required=True,
+    type=click.Path(exists=True, file_okay=False, dir_okay=True, path_type=Path),
+    help="Path to the Obsidian vault root directory.",
+)
+@click.option(
+    "--client",
+    "-c",
+    type=click.Choice(list(CLIENT_CONFIGS.keys())),
+    default="claude_desktop",
+    help="Target client to configure.",
+)
+@click.option(
+    "--force",
+    "-f",
+    is_flag=True,
+    help="Overwrite existing vault-bridge configuration.",
+)
+@click.option(
+    "--dry-run",
+    is_flag=True,
+    help="Show what would be changed without writing.",
+)
+def main(vault_path: Path, client: str, force: bool, dry_run: bool) -> int:
+    """Auto-configure vault-bridge for your AI client.
+    
+    Example:
+        vault-bridge-configure -v "/path/to/vault" -c claude_desktop
+    """
+    vault_path = vault_path.resolve()
+
+    # Validate vault
+    if not (vault_path / ".obsidian").exists() and not any(vault_path.glob("*.md")):
+        logger.warning("configure.not_vault", path=str(vault_path))
+        click.echo(f"Warning: {vault_path} doesn't appear to be an Obsidian vault (.obsidian folder missing, no .md files)", err=True)
+        if not force:
+            return 1
+
+    client_config = CLIENT_CONFIGS[client]
+    config_path = client_config["config_path"]
+    server_key = client_config["server_key"]
+
+    logger.info("configure.start", vault_path=str(vault_path), client=client)
+
+    # Load existing config
+    existing: dict[str, Any] = load_existing_config(config_path)
+
+    # Check for existing entry
+    if server_key in existing.get("mcpServers", {}) and not force:
+        logger.warning("configure.exists", config_path=str(config_path))
+        click.echo(f"vault-bridge already configured in {config_path}. Use --force to overwrite.", err=True)
+        return 1
+
+    # Update config
+    updated: dict[str, Any] = update_config_for_client(existing, server_key, str(vault_path))
+
+    if dry_run:
+        click.echo(f"Would update {config_path}:")
+        click.echo(json.dumps(updated, indent=2))
+        return 0
+
+    # Save
+    save_config(config_path, updated)
+
+    logger.info("configure.success", config_path=str(config_path))
+    click.echo(f"✓ Configured vault-bridge for {client}")
+    click.echo(f"  Config: {config_path}")
+    click.echo(f"  Vault:  {vault_path}")
+    click.echo(f"  Restart {client} to apply changes.")
+
+    return 0
+
+
+if __name__ == "__main__":
+    sys.exit(main())