@mauricio.wolff/mcp-obsidian 0.6.1 → 0.6.4

package/README.md

@@ -14,10 +14,10 @@ A universal AI bridge for Obsidian vaults using the Model Context Protocol (MCP)
 
 <div align="center">
 
-[![GitHub Stars](https://img.shields.io/github/stars/bitbonsai/mcp-obsidian?style=flat&logo=github&logoColor=white&color=9065ea&labelColor=262626)](https://github.com/bitbonsai/mcp-obsidian) 
-[![GitHub Sponsors](https://img.shields.io/github/sponsors/BitBonsai?style=flat&logo=github&logoColor=white&color=9065ea&labelColor=262626)](https://github.com/sponsors/bitbonsai) 
-[![GitHub Sponsors](https://img.shields.io/github/sponsors/BitBonsai?style=flat&logo=github&logoColor=white&color=9065ea&labelColor=262626)](https://github.com/sponsors/bitbonsai) 
-[![Ko-Fi](https://img.shields.io/badge/Ko--fi-Support%20Me-9065ea?style=flat&logo=ko-fi&logoColor=white&labelColor=262626)](https://ko-fi.com/bitbonsai) 
+[![GitHub Stars](https://img.shields.io/github/stars/bitbonsai/mcp-obsidian?style=flat&logo=github&logoColor=white&color=9065ea&labelColor=262626)](https://github.com/bitbonsai/mcp-obsidian)
+[![npm version](https://img.shields.io/npm/v/@mauricio.wolff/mcp-obsidian?style=flat&logo=npm&logoColor=white&color=9065ea&labelColor=262626)](https://www.npmjs.com/package/@mauricio.wolff/mcp-obsidian)
+[![GitHub Sponsors](https://img.shields.io/github/sponsors/BitBonsai?style=flat&logo=github&logoColor=white&color=9065ea&labelColor=262626)](https://github.com/sponsors/bitbonsai)
+[![Ko-Fi](https://img.shields.io/badge/Ko--fi-Support%20Me-9065ea?style=flat&logo=ko-fi&logoColor=white&labelColor=262626)](https://ko-fi.com/bitbonsai)
 [![Liberapay](https://img.shields.io/badge/Liberapay-Weekly%20Support-9065ea?style=flat&logo=liberapay&logoColor=white&labelColor=262626)](https://liberapay.com/bitbonsai/)
 
 </div>
@@ -110,6 +110,8 @@ MCP is an open protocol. You're not tied to any specific vendor or platform. You
 - ✅ Automatic path trimming to handle whitespace in inputs
 - ✅ TypeScript support with Node.js runtime (using tsx for execution)
 - ✅ Comprehensive error handling and validation
+- ✅ **Token-optimized responses**: 40-60% smaller responses with minified field names and compact JSON (v0.6.3+)
+- ✅ **Optional pretty-printing**: Set `prettyPrint: true` for human-readable debugging
 - ✅ **Performance optimized**: No unnecessary token consumption, efficient for large vaults
 - ✅ **Zero dependencies**: No Obsidian plugins required, works with any vault structure
 - ✅ **Intelligent link handling**: Smart processing of internal links and references
@@ -362,16 +364,21 @@ Read a note from the vault with parsed frontmatter.
 {
   "name": "read_note",
   "arguments": {
-    "path": "project-ideas.md"
+    "path": "project-ideas.md",
+    "prettyPrint": false
   }
 }
 ```
 
-**Response:**
+**Response (optimized for tokens):**
+```json
+{"fm":{"title":"Project Ideas","tags":["projects","brainstorming"],"created":"2023-01-15T10:30:00.000Z"},"content":"# Project Ideas\n\n## AI Tools\n- MCP server for Obsidian\n- Voice note transcription\n\n## Web Apps\n- Task management system"}
+```
+
+**Response (with prettyPrint: true):**
 ```json
 {
-  "path": "project-ideas.md",
-  "frontmatter": {
+  "fm": {
     "title": "Project Ideas",
     "tags": ["projects", "brainstorming"],
     "created": "2023-01-15T10:30:00.000Z"
@@ -432,24 +439,15 @@ List files and directories in the vault.
 {
   "name": "list_directory",
   "arguments": {
-    "path": "Projects"
+    "path": "Projects",
+    "prettyPrint": false
   }
 }
 ```
 
-**Response:**
+**Response (optimized):**
 ```json
-{
-  "path": "Projects",
-  "directories": [
-    "AI-Tools",
-    "Web-Development"
-  ],
-  "files": [
-    "project-template.md",
-    "roadmap.md"
-  ]
-}
+{"dirs":["AI-Tools","Web-Development"],"files":["project-template.md","roadmap.md"]}
 ```
 
 ### `delete_note`
@@ -494,21 +492,15 @@ Extract only the frontmatter from a note without reading the full content.
 {
   "name": "get_frontmatter",
   "arguments": {
-    "path": "project-ideas.md"
+    "path": "project-ideas.md",
+    "prettyPrint": false
   }
 }
 ```
 
-**Response:**
+**Response (optimized, returns frontmatter directly):**
 ```json
-{
-  "path": "project-ideas.md",
-  "frontmatter": {
-    "title": "Project Ideas",
-    "tags": ["projects", "brainstorming"],
-    "created": "2023-01-15T10:30:00.000Z"
-  }
-}
+{"title":"Project Ideas","tags":["projects","brainstorming"],"created":"2023-01-15T10:30:00.000Z"}
 ```
 
 ### `manage_tags`
@@ -572,28 +564,24 @@ Search for notes in the vault by content or frontmatter.
     "limit": 5,
     "searchContent": true,
     "searchFrontmatter": false,
-    "caseSensitive": false
+    "caseSensitive": false,
+    "prettyPrint": false
   }
 }
 ```
 
-**Response:**
+**Response (optimized with minified field names):**
 ```json
-{
-  "query": "machine learning",
-  "resultCount": 3,
-  "results": [
-    {
-      "path": "ai-research.md",
-      "title": "AI Research Notes",
-      "excerpt": "...machine learning algorithms are...",
-      "matchCount": 2,
-      "lineNumber": 15
-    }
-  ]
-}
+[{"p":"ai-research.md","t":"AI Research Notes","ex":"...machine learning...","mc":2,"ln":15}]
 ```
 
+**Field names:**
+- `p` = path
+- `t` = title
+- `ex` = excerpt (21 chars context)
+- `mc` = match count
+- `ln` = line number
+
 ### `move_note`
 Move or rename a note in the vault.
 
@@ -629,34 +617,21 @@ Read multiple notes in a batch (maximum 10 files).
   "arguments": {
     "paths": ["note1.md", "note2.md", "note3.md"],
     "includeContent": true,
-    "includeFrontmatter": true
+    "includeFrontmatter": true,
+    "prettyPrint": false
   }
 }
 ```
 
-**Response:**
+**Response (optimized, shortened field names):**
 ```json
-{
-  "successful": [
-    {
-      "path": "note1.md",
-      "frontmatter": {"title": "Note 1"},
-      "content": "# Note 1\n\nContent here..."
-    }
-  ],
-  "failed": [
-    {
-      "path": "note2.md",
-      "error": "File not found"
-    }
-  ],
-  "summary": {
-    "successCount": 1,
-    "failureCount": 1
-  }
-}
+{"ok":[{"path":"note1.md","frontmatter":{"title":"Note 1"},"content":"# Note 1\n\nContent here..."}],"err":[{"path":"note2.md","error":"File not found"}]}
 ```
 
+**Field names:**
+- `ok` = successful reads
+- `err` = failed reads
+
 ### `update_frontmatter`
 Update frontmatter of a note without changing content.
 
@@ -690,24 +665,15 @@ Get metadata for notes without reading full content.
 {
   "name": "get_notes_info",
   "arguments": {
-    "paths": ["note1.md", "note2.md"]
+    "paths": ["note1.md", "note2.md"],
+    "prettyPrint": false
   }
 }
 ```
 
-**Response:**
+**Response (optimized, returns array directly):**
 ```json
-{
-  "notes": [
-    {
-      "path": "note1.md",
-      "size": 1024,
-      "modified": 1695456000000,
-      "hasFrontmatter": true
-    }
-  ],
-  "count": 1
-}
+[{"path":"note1.md","size":1024,"modified":1695456000000,"hasFrontmatter":true}]
 ```
 
 ## Security Considerations

package/dist/server.js

@@ -6,9 +6,46 @@ import { FileSystemService } from "./src/filesystem.js";
 import { FrontmatterHandler } from "./src/frontmatter.js";
 import { PathFilter } from "./src/pathfilter.js";
 import { SearchService } from "./src/search.js";
-const vaultPath = process.argv[2];
+import { readFileSync } from "fs";
+import { fileURLToPath } from "url";
+import { dirname, join } from "path";
+// Get package.json version
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = dirname(__filename);
+const packageJson = JSON.parse(readFileSync(join(__dirname, "../package.json"), "utf-8"));
+const VERSION = packageJson.version;
+// Handle --version and --help flags
+const arg = process.argv[2];
+if (arg === "--version" || arg === "-v") {
+    console.log(VERSION);
+    process.exit(0);
+}
+if (arg === "--help" || arg === "-h") {
+    console.log(`
+@mauricio.wolff/mcp-obsidian v${VERSION}
+
+Universal AI bridge for Obsidian vaults - connect any MCP-compatible assistant
+
+Usage:
+  npx @mauricio.wolff/mcp-obsidian <vault-path>
+
+Arguments:
+  <vault-path>    Path to your Obsidian vault directory
+
+Options:
+  --version, -v   Show version number
+  --help, -h      Show this help message
+
+Examples:
+  npx @mauricio.wolff/mcp-obsidian ~/Documents/MyVault
+  npx @mauricio.wolff/mcp-obsidian /path/to/obsidian/vault
+`);
+    process.exit(0);
+}
+const vaultPath = arg;
 if (!vaultPath) {
     console.error("Usage: npx @mauricio.wolff/mcp-obsidian /path/to/vault");
+    console.error("Run 'npx @mauricio.wolff/mcp-obsidian --help' for more information");
     process.exit(1);
 }
 // Initialize services
@@ -18,7 +55,7 @@ const fileSystem = new FileSystemService(vaultPath, pathFilter, frontmatterHandl
 const searchService = new SearchService(vaultPath, pathFilter);
 const server = new Server({
     name: "mcp-obsidian",
-    version: "0.6.1"
+    version: VERSION
 }, {
     capabilities: {
         tools: {},
@@ -36,6 +73,11 @@ server.setRequestHandler(ListToolsRequestSchema, async () => {
                         path: {
                             type: "string",
                             description: "Path to the note relative to vault root"
+                        },
+                        prettyPrint: {
+                            type: "boolean",
+                            description: "Format JSON response with indentation (default: false)",
+                            default: false
                         }
                     },
                     required: ["path"]
@@ -106,6 +148,11 @@ server.setRequestHandler(ListToolsRequestSchema, async () => {
                             type: "string",
                             description: "Path relative to vault root (default: '/')",
                             default: "/"
+                        },
+                        prettyPrint: {
+                            type: "boolean",
+                            description: "Format JSON response with indentation (default: false)",
+                            default: false
                         }
                     }
                 }
@@ -157,6 +204,11 @@ server.setRequestHandler(ListToolsRequestSchema, async () => {
                             type: "boolean",
                             description: "Case sensitive search (default: false)",
                             default: false
+                        },
+                        prettyPrint: {
+                            type: "boolean",
+                            description: "Format JSON response with indentation (default: false)",
+                            default: false
                         }
                     },
                     required: ["query"]
@@ -206,6 +258,11 @@ server.setRequestHandler(ListToolsRequestSchema, async () => {
                             type: "boolean",
                             description: "Include frontmatter (default: true)",
                             default: true
+                        },
+                        prettyPrint: {
+                            type: "boolean",
+                            description: "Format JSON response with indentation (default: false)",
+                            default: false
                         }
                     },
                     required: ["paths"]
@@ -244,6 +301,11 @@ server.setRequestHandler(ListToolsRequestSchema, async () => {
                             type: "array",
                             items: { type: "string" },
                             description: "Array of note paths to get info for"
+                        },
+                        prettyPrint: {
+                            type: "boolean",
+                            description: "Format JSON response with indentation (default: false)",
+                            default: false
                         }
                     },
                     required: ["paths"]
@@ -258,6 +320,11 @@ server.setRequestHandler(ListToolsRequestSchema, async () => {
                         path: {
                             type: "string",
                             description: "Path to the note relative to vault root"
+                        },
+                        prettyPrint: {
+                            type: "boolean",
+                            description: "Format JSON response with indentation (default: false)",
+                            default: false
                         }
                     },
                     required: ["path"]
@@ -319,15 +386,15 @@ server.setRequestHandler(CallToolRequestSchema, async (request) => {
         switch (name) {
             case "read_note": {
                 const note = await fileSystem.readNote(trimmedArgs.path);
+                const indent = trimmedArgs.prettyPrint ? 2 : undefined;
                 return {
                     content: [
                         {
                             type: "text",
                             text: JSON.stringify({
-                                path: trimmedArgs.path,
-                                frontmatter: note.frontmatter,
+                                fm: note.frontmatter,
                                 content: note.content
-                            }, null, 2)
+                            }, null, indent)
                         }
                     ]
                 };
@@ -367,15 +434,15 @@ server.setRequestHandler(CallToolRequestSchema, async (request) => {
             }
             case "list_directory": {
                 const listing = await fileSystem.listDirectory(trimmedArgs.path || '');
+                const indent = trimmedArgs.prettyPrint ? 2 : undefined;
                 return {
                     content: [
                         {
                             type: "text",
                             text: JSON.stringify({
-                                path: trimmedArgs.path || '/',
-                                directories: listing.directories,
+                                dirs: listing.directories,
                                 files: listing.files
-                            }, null, 2)
+                            }, null, indent)
                         }
                     ]
                 };
@@ -403,15 +470,12 @@ server.setRequestHandler(CallToolRequestSchema, async (request) => {
                     searchFrontmatter: trimmedArgs.searchFrontmatter,
                     caseSensitive: trimmedArgs.caseSensitive
                 });
+                const indent = trimmedArgs.prettyPrint ? 2 : undefined;
                 return {
                     content: [
                         {
                             type: "text",
-                            text: JSON.stringify({
-                                query: trimmedArgs.query,
-                                resultCount: results.length,
-                                results: results
-                            }, null, 2)
+                            text: JSON.stringify(results, null, indent)
                         }
                     ]
                 };
@@ -438,18 +502,15 @@ server.setRequestHandler(CallToolRequestSchema, async (request) => {
                     includeContent: trimmedArgs.includeContent,
                     includeFrontmatter: trimmedArgs.includeFrontmatter
                 });
+                const indent = trimmedArgs.prettyPrint ? 2 : undefined;
                 return {
                     content: [
                         {
                             type: "text",
                             text: JSON.stringify({
-                                successful: result.successful,
-                                failed: result.failed,
-                                summary: {
-                                    successCount: result.successful.length,
-                                    failureCount: result.failed.length
-                                }
-                            }, null, 2)
+                                ok: result.successful,
+                                err: result.failed
+                            }, null, indent)
                         }
                     ]
                 };
@@ -471,28 +532,24 @@ server.setRequestHandler(CallToolRequestSchema, async (request) => {
             }
             case "get_notes_info": {
                 const result = await fileSystem.getNotesInfo(trimmedArgs.paths);
+                const indent = trimmedArgs.prettyPrint ? 2 : undefined;
                 return {
                     content: [
                         {
                             type: "text",
-                            text: JSON.stringify({
-                                notes: result,
-                                count: result.length
-                            }, null, 2)
+                            text: JSON.stringify(result, null, indent)
                         }
                     ]
                 };
             }
             case "get_frontmatter": {
                 const note = await fileSystem.readNote(trimmedArgs.path);
+                const indent = trimmedArgs.prettyPrint ? 2 : undefined;
                 return {
                     content: [
                         {
                             type: "text",
-                            text: JSON.stringify({
-                                path: trimmedArgs.path,
-                                frontmatter: note.frontmatter
-                            }, null, 2)
+                            text: JSON.stringify(note.frontmatter, null, indent)
                         }
                     ]
                 };

package/dist/src/search.js

@@ -45,8 +45,8 @@ export class SearchService {
                 const index = searchIn.indexOf(searchQuery);
                 if (index !== -1) {
                     // Extract excerpt around first match
-                    const excerptStart = Math.max(0, index - 50);
-                    const excerptEnd = Math.min(searchableText.length, index + searchQuery.length + 50);
+                    const excerptStart = Math.max(0, index - 21);
+                    const excerptEnd = Math.min(searchableText.length, index + searchQuery.length + 21);
                     let excerpt = searchableText.slice(excerptStart, excerptEnd).trim();
                     // Add ellipsis if excerpt is truncated
                     if (excerptStart > 0)
@@ -66,11 +66,11 @@ export class SearchService {
                     // Extract title from filename
                     const title = relativePath.split('/').pop()?.replace(/\.md$/, '') || relativePath;
                     results.push({
-                        path: relativePath,
-                        title: title,
-                        excerpt: excerpt,
-                        matchCount: matchCount,
-                        lineNumber: lineNumber
+                        p: relativePath,
+                        t: title,
+                        ex: excerpt,
+                        mc: matchCount,
+                        ln: lineNumber
                     });
                 }
             }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mauricio.wolff/mcp-obsidian",
-  "version": "0.6.1",
+  "version": "0.6.4",
   "description": "Universal AI bridge for Obsidian vaults - connect any MCP-compatible assistant",
   "author": "bitbonsai",
   "license": "MIT",