@mauricio.wolff/mcp-obsidian 0.5.4 → 0.5.5

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +44 -5
  2. package/package.json +13 -6
package/README.md CHANGED
@@ -1,8 +1,16 @@
1
+ <div align="center">
2
+ <img width="256" height="256" alt="image" src="https://github.com/user-attachments/assets/1e21d898-811b-42c2-a810-bf921dde0f58" />
3
+ </div>
4
+
1
5
  # MCP-Obsidian
2
6
 
3
- A lightweight Model Context Protocol (MCP) server for safe Obsidian vault access. This server provides AI assistants with the ability to read and write notes in an Obsidian vault while preventing YAML frontmatter corruption.
7
+ A universal AI bridge for Obsidian vaults using the Model Context Protocol (MCP) standard. Connect any MCP-compatible AI assistant to your knowledge base - works with Claude, ChatGPT, and future AI tools. This server provides safe read/write access to your notes while preventing YAML frontmatter corruption.
8
+
9
+ 🌐 **Website:** [mcp-obsidian.org](https://mcp-obsidian.org)
10
+
11
+ **Universal Compatibility:** Works with any MCP-compatible AI assistant including Claude Desktop, Claude Code, ChatGPT Desktop (Enterprise+), IntelliJ IDEA 2025.1+, Cursor IDE, Windsurf IDE, and future AI platforms that adopt the MCP standard.
4
12
 
5
- **Supported AI Platforms:** Claude Desktop, Claude Code, ChatGPT Desktop (Enterprise+), IntelliJ IDEA 2025.1+, Cursor IDE, and other MCP-compatible clients.
13
+ https://github.com/user-attachments/assets/657ac4c6-1cd2-4cc3-829f-fd095a32f71c
6
14
 
7
15
  ## Quick Start (5 minutes)
8
16
 
@@ -57,6 +65,17 @@ A lightweight Model Context Protocol (MCP) server for safe Obsidian vault access
57
65
 
58
66
  **Success indicators:** Your AI should be able to list files and read notes from your vault.
59
67
 
68
+ ## Why MCP-Obsidian?
69
+
70
+ ### Universal AI Compatibility
71
+ Built on the open Model Context Protocol standard, MCP-Obsidian is not locked to any single AI provider. As more AI assistants adopt MCP, your investment in this tool grows more valuable. Today it works with Claude and ChatGPT - tomorrow it will work with whatever AI tools emerge.
72
+
73
+ ### Future-Proof Your Knowledge Base
74
+ Instead of waiting for each AI company to build Obsidian integrations, MCP-Obsidian provides a universal adapter that works with any MCP-compatible assistant. One tool, endless possibilities.
75
+
76
+ ### Open Standard, No Lock-in
77
+ MCP is an open protocol. You're not tied to any specific vendor or platform. Your notes remain yours, accessible through any compatible AI assistant.
78
+
60
79
  ## Features
61
80
 
62
81
  - ✅ Safe frontmatter parsing and validation using gray-matter
@@ -68,12 +87,15 @@ A lightweight Model Context Protocol (MCP) server for safe Obsidian vault access
68
87
  - Search: `search_notes` with content and frontmatter support
69
88
  - Metadata: `get_frontmatter`, `update_frontmatter`, `get_notes_info`
70
89
  - Tag management: `manage_tags` (add, remove, list)
71
- - ✅ **NEW:** Write modes: `overwrite`, `append`, `prepend` for flexible content editing
72
- - ✅ **NEW:** Tag management: add, remove, and list tags in notes
90
+ - ✅ Write modes: `overwrite`, `append`, `prepend` for flexible content editing
91
+ - ✅ Tag management: add, remove, and list tags in notes
73
92
  - ✅ Safe deletion with confirmation requirement to prevent accidents
74
93
  - ✅ Automatic path trimming to handle whitespace in inputs
75
94
  - ✅ TypeScript support with Node.js runtime (using tsx for execution)
76
95
  - ✅ Comprehensive error handling and validation
96
+ - ✅ **Performance optimized**: No unnecessary token consumption, efficient for large vaults
97
+ - ✅ **Zero dependencies**: No Obsidian plugins required, works with any vault structure
98
+ - ✅ **Intelligent link handling**: Smart processing of internal links and references
77
99
 
78
100
  ## Prerequisites
79
101
 
@@ -104,6 +126,15 @@ npm install
104
126
  npx @modelcontextprotocol/inspector npm start /path/to/your/vault
105
127
  ```
106
128
 
129
+ **Pro tip:** Use MCP Inspector to test all server functionality before configuring with AI clients:
130
+ ```bash
131
+ # Install globally for easier access
132
+ npm install -g @modelcontextprotocol/inspector
133
+
134
+ # Test with any vault
135
+ mcp-inspector npx @mauricio.wolff/mcp-obsidian@latest /path/to/your/vault
136
+ ```
137
+
107
138
  ## Usage
108
139
 
109
140
  ### Running the Server
@@ -216,6 +247,7 @@ claude mcp add obsidian --scope user npx @mauricio.wolff/mcp-obsidian /path/to/y
216
247
  **Confirmed MCP Support:**
217
248
  - **IntelliJ IDEA 2025.1+** - Native MCP client support
218
249
  - **Cursor IDE** - Built-in MCP compatibility
250
+ - **Windsurf IDE** - Full MCP integration
219
251
  - **Zed, Replit, Codeium, Sourcegraph** - In development
220
252
  - **Microsoft Copilot Studio** - Native MCP support with one-click server connections
221
253
 
@@ -238,6 +270,12 @@ Most modern MCP clients use similar JSON configuration patterns. Refer to your s
238
270
  - "List all markdown files in my 'Projects' folder"
239
271
  - "Delete the old draft note 'draft-ideas.md' (with confirmation)"
240
272
 
273
+ #### Advanced Use Cases:
274
+ - **Knowledge Synthesis**: "Summarize all my research notes tagged with 'machine-learning' from the last month"
275
+ - **Project Management**: "Update the status in all project notes to 'completed' and add today's date"
276
+ - **Content Analysis**: "Find all notes that mention 'API design' and create a comprehensive guide"
277
+ - **Smart Tagging**: "Review my untagged notes and suggest appropriate tags based on content"
278
+
241
279
  ## Troubleshooting
242
280
 
243
281
  ### Common Issues
@@ -685,6 +723,7 @@ This MCP server implements several security measures to protect your Obsidian va
685
723
  - `src/frontmatter.ts` - YAML frontmatter handling with gray-matter
686
724
  - `src/filesystem.ts` - Safe file operations with path validation
687
725
  - `src/pathfilter.ts` - Directory and file filtering
726
+ - `src/search.ts` - Note search functionality with content and frontmatter support
688
727
  - `src/types.ts` - TypeScript type definitions
689
728
 
690
729
  ## Contributing
@@ -697,4 +736,4 @@ This MCP server implements several security measures to protect your Obsidian va
697
736
 
698
737
  ## License
699
738
 
700
- MIT
739
+ MIT
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@mauricio.wolff/mcp-obsidian",
3
- "version": "0.5.4",
4
- "description": "Lightweight MCP server for safe Obsidian vault access",
3
+ "version": "0.5.5",
4
+ "description": "Universal AI bridge for Obsidian vaults - connect any MCP-compatible assistant",
5
5
  "author": "bitbonsai",
6
6
  "license": "MIT",
7
7
  "type": "module",
@@ -47,12 +47,19 @@
47
47
  "mcp",
48
48
  "obsidian",
49
49
  "model-context-protocol",
50
+ "universal",
51
+ "ai-bridge",
52
+ "mcp-server",
50
53
  "claude",
54
+ "chatgpt",
51
55
  "ai",
52
- "node",
53
- "filesystem",
54
- "frontmatter",
55
- "yaml"
56
+ "knowledge-management",
57
+ "pkm",
58
+ "vault",
59
+ "notes",
60
+ "markdown",
61
+ "future-proof",
62
+ "open-standard"
56
63
  ],
57
64
  "publishConfig": {
58
65
  "access": "public"