vault-mcp-tools 1.0.0

package/CHANGELOG.md

@@ -0,0 +1,25 @@
+# Changelog
+
+All notable changes to vault-mcp-tools will be documented in this file.
+
+## [1.0.0] - 2026-04-10
+
+### Added
+- **35 tools** for complete Obsidian vault interaction
+  - Note operations: read, create, update, patch, delete, move, rename (with wikilink updates)
+  - Search: full-text, by tag, by frontmatter, structured power-search (text + tags + frontmatter + folder)
+  - Graph: outgoing links, backlinks, orphans, dead ends, unresolved links
+  - Frontmatter: get, set, remove properties
+  - Tags: list, get note tags, rename vault-wide (with dry-run)
+  - Folders: list, create, move (with link updates), delete (empty-only)
+  - Canvas: read and list .canvas files
+  - Bookmarks: read bookmark tree
+  - Vault info: stats, link resolution
+  - REST-only (3): execute command, list commands, open in Obsidian
+- **7 MCP resources** — vault info, structure, tags, graph summary, bookmarks, recent notes, per-note content
+- **6 MCP prompts** — daily summary, vault health check, note connections, research & link, inbox triage, weekly review
+- **Security hardening** — path traversal prevention, null byte rejection, sensitive directory guard (.obsidian, .git, .trash), symlink protection, Zod input size limits, error path sanitization, HTTP Bearer token auth, 10MB request body limit, CORS
+- **Stability** — per-file write locking, search memory optimization (5 matches/file, 300-char line truncation), folder move resilience with partial failure warnings, watcher write-mute
+- **Dual transport** — stdio (default) for Claude Code/Cursor, HTTP for MCPize/remote
+- **Cross-platform** — tested on Windows, macOS, Linux with Node 18, 20, 22
+- **CI/CD** — GitHub Actions for test/lint/build on push, publish workflow on release

package/LICENSE

@@ -0,0 +1,190 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to the Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by the Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding any notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   Copyright 2025 Mark Afable
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,252 @@
+# vault-mcp
+
+MCP server for complete Obsidian vault interaction. 35 tools covering notes, search, graph, frontmatter, tags, folders, canvas, and bookmarks.
+
+Filesystem-first: parses `.md` files directly from disk. No Obsidian process required. Optional REST API integration adds 3 bonus tools when Obsidian is running.
+
+## Features
+
+**Notes** -- Read, create, update, patch (surgical edits), delete, move, rename. All move/rename operations automatically update wikilinks vault-wide.
+
+**Search** -- Full-text search, tag search, frontmatter search, and structured power-search combining text + tags + frontmatter + folder scope with AND logic.
+
+**Graph** -- Outgoing links, backlinks, orphan detection, dead-end detection, unresolved link finder.
+
+**Frontmatter** -- Get, set, and remove YAML frontmatter properties.
+
+**Tags** -- List all tags with counts, get note tags, rename tags vault-wide (with dry-run).
+
+**Folders** -- List, create, move (with link updates), delete (empty-only safety).
+
+**Canvas** -- Read and parse `.canvas` files into structured JSON.
+
+**Bookmarks** -- Read the Obsidian bookmark tree.
+
+**Vault** -- Info, stats, link resolution.
+
+## Quick Start
+
+```bash
+OBSIDIAN_VAULT_PATH="/path/to/vault" npx vault-mcp-tools
+```
+
+## Installation
+
+### Claude Code / Claude Desktop
+
+Add to `.mcp.json` in your project root (Claude Code) or Claude Desktop config:
+
+```json
+{
+  "mcpServers": {
+    "vault-mcp": {
+      "command": "npx",
+      "args": ["-y", "vault-mcp-tools"],
+      "env": {
+        "OBSIDIAN_VAULT_PATH": "/path/to/your/vault"
+      }
+    }
+  }
+}
+```
+
+### Cursor
+
+Add to `.cursor/mcp.json` in your project root:
+
+```json
+{
+  "mcpServers": {
+    "vault-mcp": {
+      "command": "npx",
+      "args": ["-y", "vault-mcp-tools"],
+      "env": {
+        "OBSIDIAN_VAULT_PATH": "/path/to/your/vault"
+      }
+    }
+  }
+}
+```
+
+### Windsurf
+
+Add to `~/.codeium/windsurf/mcp_config.json`:
+
+```json
+{
+  "mcpServers": {
+    "vault-mcp": {
+      "command": "npx",
+      "args": ["-y", "vault-mcp-tools"],
+      "env": {
+        "OBSIDIAN_VAULT_PATH": "/path/to/your/vault"
+      }
+    }
+  }
+}
+```
+
+### Global Install
+
+```bash
+npm install -g vault-mcp-tools
+OBSIDIAN_VAULT_PATH="/path/to/vault" vault-mcp-tools
+```
+
+## Configuration
+
+| Variable | Required | Default | Description |
+|----------|----------|---------|-------------|
+| `OBSIDIAN_VAULT_PATH` | Yes | -- | Absolute path to your Obsidian vault |
+| `OBSIDIAN_REST_TOKEN` | No | -- | Bearer token for Obsidian REST API plugin |
+| `OBSIDIAN_REST_PORT` | No | `27124` | Port for Obsidian REST API |
+| `OBSIDIAN_TRANSPORT` | No | `stdio` | Transport mode: `stdio` or `http` |
+| `OBSIDIAN_HTTP_PORT` | No | `3000` | HTTP server port (when transport=http) |
+| `OBSIDIAN_HTTP_AUTH_TOKEN` | No | -- | Bearer token for HTTP transport auth |
+
+## Tools (35)
+
+### Note Operations (7)
+
+| Tool | Description | R/W |
+|------|-------------|-----|
+| `vault_read_note` | Read note content and metadata | R |
+| `vault_create_note` | Create a new note | W |
+| `vault_update_note` | Replace note content | W |
+| `vault_patch_note` | Surgical edit at heading/block/frontmatter | W |
+| `vault_delete_note` | Permanently delete a note | W |
+| `vault_move_note` | Move note, update all wikilinks | W |
+| `vault_rename_note` | Rename note, update all wikilinks | W |
+
+### Search (4)
+
+| Tool | Description | R/W |
+|------|-------------|-----|
+| `vault_search` | Full-text search with line-level context | R |
+| `vault_search_by_tag` | Find notes with a specific tag | R |
+| `vault_search_by_frontmatter` | Find notes by frontmatter property | R |
+| `vault_search_structured` | Power-search: text + tags + frontmatter + folder | R |
+
+### Graph (5)
+
+| Tool | Description | R/W |
+|------|-------------|-----|
+| `vault_get_links` | Get outgoing links (resolved + unresolved) | R |
+| `vault_get_backlinks` | Get all notes linking to a note | R |
+| `vault_get_orphans` | Find notes with zero incoming links | R |
+| `vault_get_dead_ends` | Find notes with zero outgoing links | R |
+| `vault_get_unresolved` | Find all broken wikilinks | R |
+
+### Frontmatter (3)
+
+| Tool | Description | R/W |
+|------|-------------|-----|
+| `vault_get_properties` | Get all frontmatter properties | R |
+| `vault_set_property` | Set a frontmatter property | W |
+| `vault_remove_property` | Remove a frontmatter property | W |
+
+### Tags (3)
+
+| Tool | Description | R/W |
+|------|-------------|-----|
+| `vault_list_tags` | List all tags with counts | R |
+| `vault_get_note_tags` | Get tags for a specific note | R |
+| `vault_rename_tag` | Rename a tag vault-wide (supports dry-run) | W |
+
+### Folders (4)
+
+| Tool | Description | R/W |
+|------|-------------|-----|
+| `vault_list_folder` | List files and subfolders | R |
+| `vault_create_folder` | Create a new folder | W |
+| `vault_move_folder` | Move/rename folder, update all wikilinks | W |
+| `vault_delete_folder` | Delete empty folder (safety constraint) | W |
+
+### Canvas (2)
+
+| Tool | Description | R/W |
+|------|-------------|-----|
+| `vault_read_canvas` | Read and parse a .canvas file | R |
+| `vault_list_canvases` | List all canvas files | R |
+
+### Bookmarks (1)
+
+| Tool | Description | R/W |
+|------|-------------|-----|
+| `vault_get_bookmarks` | Read the bookmark tree | R |
+
+### Vault Info (3)
+
+| Tool | Description | R/W |
+|------|-------------|-----|
+| `vault_info` | Vault name, path, note/folder counts | R |
+| `vault_stats` | Detailed stats (sizes, oldest/newest, tags) | R |
+| `vault_resolve_link` | Resolve wikilink to file path | R |
+
+### REST-Only (3, requires Obsidian + REST API plugin)
+
+| Tool | Description | R/W |
+|------|-------------|-----|
+| `vault_execute_command` | Execute an Obsidian command by ID | W |
+| `vault_list_commands` | List all registered Obsidian commands | R |
+| `vault_open_in_obsidian` | Open a note in the Obsidian UI | W |
+
+## Resources (7)
+
+| URI | Description |
+|-----|-------------|
+| `obsidian://vault/info` | Vault info (name, path, counts) |
+| `obsidian://vault/tags` | All tags with counts |
+| `obsidian://vault/recent` | 10 most recently modified notes |
+| `obsidian://note/{path}` | Full note content + metadata |
+| `obsidian://search/{query}` | Search results |
+| `obsidian://tag/{tag}` | Notes with a specific tag |
+| `obsidian://folder/{path}` | Folder listing |
+
+## Prompts (6)
+
+| Prompt | Description | Arguments |
+|--------|-------------|-----------|
+| `daily_summary` | Daily vault activity summary | `date` (optional) |
+| `vault_health_check` | Analyze vault health and suggest fixes | -- |
+| `show_connections` | Map connections for a note | `notePath` |
+| `research_brief` | Research summary on a topic from vault | `topic` |
+| `inbox_processing` | Process inbox notes for triage | `inboxFolder` (optional) |
+| `weekly_review` | Weekly review of vault changes | `weekStart` (optional) |
+
+## Transport
+
+**stdio** (default): Standard input/output. For Claude Code, Cursor, and other local MCP clients.
+
+```bash
+OBSIDIAN_VAULT_PATH="/path/to/vault" vault-mcp
+```
+
+**http**: HTTP server at `/mcp` endpoint. For MCPize, remote access, or custom integrations.
+
+```bash
+OBSIDIAN_VAULT_PATH="/path/to/vault" OBSIDIAN_TRANSPORT=http OBSIDIAN_HTTP_PORT=3000 vault-mcp
+```
+
+## REST Enhancement
+
+Install the [Obsidian Local REST API](https://github.com/coddingtonbear/obsidian-local-rest-api) plugin to unlock 3 bonus tools. vault-mcp auto-detects the REST API at startup.
+
+```bash
+OBSIDIAN_VAULT_PATH="/path/to/vault" OBSIDIAN_REST_TOKEN="your-token" vault-mcp
+```
+
+## Development
+
+```bash
+git clone https://github.com/afable702/obsidian-mcp-server.git
+cd obsidian-mcp-server
+npm install
+npm test          # 361 tests
+npm run lint      # TypeScript strict mode check
+npm run build     # Build to dist/
+```
+
+## License
+
+Apache 2.0

package/dist/index.d.ts

@@ -0,0 +1,2 @@
+
+export {  }