obsidian-mcp-server 1.5.4 → 1.5.6

package/Dockerfile

@@ -24,7 +24,8 @@ RUN npm prune --production
 FROM node:22-slim
 
 ENV NODE_ENV=production \
-    PATH="/home/service-user/.local/bin:${PATH}"
+    PATH="/home/service-user/.local/bin:${PATH}" \
+    OBSIDIAN_API_KEY="abc"
 
 # Install mcp-proxy globally for runtime use
 # Combine update, install, and clean in one layer
@@ -59,4 +60,4 @@ USER service-user
 
 # Define the command to run the application
 # CMD ["mcp-proxy", "node", "build/index.js"] # Keep original for reference
-CMD ["mcp-proxy", "node", "build/index.js"]
+CMD ["node", "build/index.js"]

package/README.md

@@ -1,8 +1,8 @@
 # Obsidian MCP Server
 
 [![TypeScript](https://img.shields.io/badge/TypeScript-5.8.3-blue.svg)](https://www.typescriptlang.org/)
-[![Model Context Protocol](https://img.shields.io/badge/MCP-1.10.1-green.svg)](https://modelcontextprotocol.io/)
-[![Version](https://img.shields.io/badge/Version-1.5.4-blue.svg)](https://opensource.org/licenses/Apache-2.0)
+[![Model Context Protocol](https://img.shields.io/badge/MCP-1.10.2-green.svg)](https://modelcontextprotocol.io/)
+[![Version](https://img.shields.io/badge/Version-1.5.6-blue.svg)](https://opensource.org/licenses/Apache-2.0)
 [![Status](https://img.shields.io/badge/Status-Stable-green.svg)]()
 [![GitHub](https://img.shields.io/github/stars/cyanheads/obsidian-mcp-server?style=social)](https://github.com/cyanheads/obsidian-mcp-server)
 

package/build/index.js

@@ -14,7 +14,7 @@ if (import.meta.url === `file://${process.argv[1]}`) {
 // Export the run function and other important modules
 export { run } from "./mcp/server.js";
 export * from "./obsidian/index.js";
-export * from "./tools/index.js";
 export * from "./resources/index.js";
+export * from "./tools/index.js";
 export * from "./utils/index.js";
 //# sourceMappingURL=index.js.map

package/build/mcp/handlers.js

@@ -1,11 +1,8 @@
-/**
- * MCP server request handlers
- */
-import { ListToolsRequestSchema, CallToolRequestSchema, ListResourcesRequestSchema, ReadResourceRequestSchema } from "@modelcontextprotocol/sdk/types.js";
+import { CallToolRequestSchema, ListResourcesRequestSchema, ListToolsRequestSchema, ReadResourceRequestSchema } from "@modelcontextprotocol/sdk/types.js";
 import { ObsidianError } from "../utils/errors.js";
-import { validateToolArguments } from "../utils/validation.js";
-import { rateLimiter } from "../utils/rate-limiting.js";
 import { createLogger, ErrorCategoryType } from "../utils/logging.js";
+import { rateLimiter } from "../utils/rate-limiting.js";
+import { validateToolArguments } from "../utils/validation.js";
 import { DEFAULT_TIMEOUT_CONFIG, McpErrorCode } from "./types.js";
 // Create a logger for request handlers
 const logger = createLogger('McpHandlers');

package/build/mcp/index.js

@@ -1,7 +1,7 @@
 /**
  * MCP module exports
  */
-export * from './types.js';
 export * from './handlers.js';
 export * from './server.js';
+export * from './types.js';
 //# sourceMappingURL=index.js.map

package/build/mcp/server.js

@@ -1,16 +1,16 @@
 /**
  * MCP server implementation
  */
-import { config } from "dotenv";
 import { Server } from "@modelcontextprotocol/sdk/server/index.js";
 import { StdioServerTransport } from "@modelcontextprotocol/sdk/server/stdio.js";
+import { config } from "dotenv";
+import { ObsidianClient } from "../obsidian/client.js";
+import { createTagResource } from "../resources/index.js";
+import { createToolHandlerMap, createToolHandlers } from "../tools/index.js";
 import { ObsidianError } from "../utils/errors.js"; // Import ObsidianError
 import { createLogger, ErrorCategoryType } from "../utils/logging.js";
 import { rateLimiter } from "../utils/rate-limiting.js";
-import { createTagResource } from "../resources/index.js";
-import { createToolHandlers, createToolHandlerMap } from "../tools/index.js";
-import { ObsidianClient } from "../obsidian/client.js";
-import { setupToolListingHandler, setupToolCallingHandler, setupResourceListingHandler, setupResourceReadingHandler } from "./handlers.js";
+import { setupResourceListingHandler, setupResourceReadingHandler, setupToolCallingHandler, setupToolListingHandler } from "./handlers.js";
 import { McpErrorCode } from "./types.js";
 // Create a logger for the server
 const logger = createLogger('McpServer');

package/build/obsidian/client.js

@@ -1,16 +1,13 @@
-/**
- * Obsidian REST API client implementation
- */
 import axios from "axios";
-import { Agent } from "node:https";
 import { readFileSync } from "fs";
-import { fileURLToPath } from 'url';
+import { Agent } from "node:https";
 import { dirname, join } from "path";
-import { createLogger } from '../utils/logging.js';
+import { fileURLToPath } from 'url';
 import { ObsidianError } from '../utils/errors.js';
-import { validateFilePath, sanitizeHeader } from '../utils/validation.js';
-import { DEFAULT_OBSIDIAN_CONFIG } from './types.js';
+import { createLogger } from '../utils/logging.js';
+import { sanitizeHeader, validateFilePath } from '../utils/validation.js';
 import { createMissingAPIKeyMessage, handleAxiosError } from './errors.js';
+import { DEFAULT_OBSIDIAN_CONFIG } from './types.js';
 // Logger for the ObsidianClient
 const logger = createLogger('ObsidianClient');
 // Get package version for user agent

package/build/obsidian/index.js

@@ -2,6 +2,6 @@
  * Exports for the Obsidian module
  */
 export * from './client.js';
-export * from './types.js';
 export * from './errors.js';
+export * from './types.js';
 //# sourceMappingURL=index.js.map

package/build/resources/index.js

@@ -1,8 +1,8 @@
 /**
  * Resources module exports
  */
-export * from './types.js';
 export * from './tags.js';
+export * from './types.js';
 import { TagResource } from './tags.js';
 /**
  * Create and return the tag resource

package/build/resources/tags.js

@@ -1,6 +1,6 @@
 import pLimit from 'p-limit'; // Import p-limit
-import { PropertyManager } from "../tools/properties/manager.js";
 import { sep } from "path";
+import { PropertyManager } from "../tools/properties/manager.js";
 import { createLogger, ErrorCategoryType } from "../utils/logging.js";
 // Create a logger for tag resources
 const logger = createLogger('TagResource');
@@ -77,8 +77,13 @@ export class TagResource {
                     // This call is now rate-limited
                     const content = await this.client.getFileContents(filename);
                     // Only extract tags from frontmatter YAML
-                    const properties = this.propertyManager.parseProperties(content);
-                    return { filename, tags: properties.tags || [] };
+                    const parseResult = this.propertyManager.parseProperties(content);
+                    // Handle potential parsing errors before accessing properties
+                    if (parseResult.error) {
+                        logger.warn(`Skipping tags for ${filename} due to parsing error: ${parseResult.error.message}`);
+                        return { filename, tags: [] }; // Return empty tags on error
+                    }
+                    return { filename, tags: parseResult.properties.tags || [] };
                 }
                 catch (error) {
                     logger.error(`Failed to process file ${filename}:`, errorToObject(error));
@@ -175,9 +180,11 @@ export class TagResource {
         }
     }
     /**
-     * Get the content for the resource
+     * Get the content for the resource, optionally filtering by path.
+     * Note: The path filtering logic assumes the tool handler passes the path correctly.
      */
-    async getContent() {
+    // TODO: Verify how the path argument is passed from the tool handler
+    async getContent(filterPath) {
         logger.startTimer('get_tags_content');
         try {
             if (!this.isInitialized) {
@@ -187,15 +194,36 @@ export class TagResource {
             else {
                 await this.updateCacheIfNeeded();
             }
+            let filteredTagEntries = [];
+            // Filter tags based on the provided path
+            if (filterPath) {
+                // Normalize path to ensure it ends with a separator for accurate startsWith check
+                const normalizedFilterPath = filterPath.endsWith(sep) ? filterPath : filterPath + sep;
+                logger.debug(`Filtering tags for path: ${normalizedFilterPath}`);
+                filteredTagEntries = Array.from(this.tagCache.entries())
+                    .map(([name, files]) => {
+                    // Filter files within each tag entry
+                    const relevantFiles = Array.from(files).filter(file => file.startsWith(normalizedFilterPath));
+                    return { name, files: new Set(relevantFiles) };
+                })
+                    .filter(tagEntry => tagEntry.files.size > 0); // Keep only tags that exist in the filtered path
+                logger.debug(`Found ${filteredTagEntries.length} tags after filtering.`);
+            }
+            else {
+                // If no path provided, use all tags from the cache
+                filteredTagEntries = Array.from(this.tagCache.entries()).map(([name, files]) => ({ name, files }));
+            }
             const response = {
-                tags: Array.from(this.tagCache.entries())
-                    .map(([name, files]) => ({
+                tags: filteredTagEntries
+                    .map(({ name, files }) => ({
                     name,
                     count: files.size,
                     files: Array.from(files).sort()
                 }))
-                    .sort((a, b) => b.count - a.count || a.name.localeCompare(b.name)),
+                    .sort((a, b) => b.count - a.count || a.name.localeCompare(b.name)), // Sort filtered results
                 metadata: {
+                    // Note: Metadata currently reflects the entire vault cache, even when filtered.
+                    // Adjust calculation here if path-specific metadata is desired.
                     totalOccurrences: Array.from(this.tagCache.values())
                         .reduce((sum, files) => sum + files.size, 0),
                     uniqueTags: this.tagCache.size,

package/build/tools/base.js

@@ -1,7 +1,7 @@
+import { McpErrorCode } from "../mcp/types.js";
 import { ObsidianError } from "../utils/errors.js";
-import { tokenCounter } from "../utils/tokenization.js";
 import { createLogger, ErrorCategoryType } from "../utils/logging.js";
-import { McpErrorCode } from "../mcp/types.js";
+import { tokenCounter } from "../utils/tokenization.js";
 // Create a logger for tool operations
 const logger = createLogger('Tools');
 /**

package/build/tools/files/content.js

@@ -1,5 +1,5 @@
-import { BaseToolHandler } from "../base.js";
 import { createLogger } from "../../utils/logging.js";
+import { BaseToolHandler } from "../base.js";
 // Create a logger for file content operations
 const logger = createLogger('FileContentTools');
 /**
@@ -8,7 +8,7 @@ const logger = createLogger('FileContentTools');
 export const FILE_CONTENT_TOOL_NAMES = {
     GET_FILE_CONTENTS: "obsidian_get_file_contents",
     APPEND_CONTENT: "obsidian_append_content",
-    PATCH_CONTENT: "obsidian_patch_content"
+    UPDATE_CONTENT: "obsidian_update_content" // Renamed from PATCH_CONTENT
 };
 /**
  * Tool handler for getting file contents
@@ -20,7 +20,7 @@ export class GetFileContentsToolHandler extends BaseToolHandler {
     getToolDescription() {
         return {
             name: this.name,
-            description: "Return the content of a single file in your vault. Supports markdown files, text files, and other readable formats. Returns the raw content including any YAML frontmatter.",
+            description: "Retrieves the full content of a specified file within your Obsidian vault. Supports various readable file formats.",
             examples: [
                 {
                     description: "Get content of a markdown note",
@@ -69,7 +69,7 @@ export class AppendContentToolHandler extends BaseToolHandler {
     getToolDescription() {
         return {
             name: this.name,
-            description: "Append content to a new or existing file in the vault.",
+            description: "Appends the provided content to the end of a specified file in the vault. If the file does not exist, it will be created.",
             examples: [
                 {
                     description: "Append a new task",
@@ -120,17 +120,17 @@ export class AppendContentToolHandler extends BaseToolHandler {
 /**
  * Tool handler for updating file content
  */
-export class PatchContentToolHandler extends BaseToolHandler {
+export class UpdateContentToolHandler extends BaseToolHandler {
     constructor(client) {
-        super(FILE_CONTENT_TOOL_NAMES.PATCH_CONTENT, client);
+        super(FILE_CONTENT_TOOL_NAMES.UPDATE_CONTENT, client); // Renamed from PATCH_CONTENT
     }
     getToolDescription() {
         return {
-            name: this.name,
-            description: "Update the entire content of an existing note or create a new one.",
+            name: this.name, // Will be obsidian_update_content
+            description: "Overwrites the entire content of a specified file in the vault with the provided content. If the file does not exist, it will be created.",
             examples: [
                 {
-                    description: "Update a note's content",
+                    description: "Overwrite a note's content",
                     args: {
                         filepath: "project.md",
                         content: "# Project Notes\n\nThis will replace the entire content of the note."
@@ -147,7 +147,7 @@ export class PatchContentToolHandler extends BaseToolHandler {
                     },
                     content: {
                         type: "string",
-                        description: "New content for the note (replaces existing content)"
+                        description: "The new, complete content for the file (overwrites existing content)."
                     }
                 },
                 required: ["filepath", "content"]

package/build/tools/files/index.js

@@ -1,10 +1,10 @@
 /**
  * File operation tools exports
  */
-export * from './list.js';
 export * from './content.js';
-import { ListFilesInVaultToolHandler, ListFilesInDirToolHandler } from './list.js';
-import { GetFileContentsToolHandler, AppendContentToolHandler, PatchContentToolHandler } from './content.js';
+export * from './list.js';
+import { AppendContentToolHandler, GetFileContentsToolHandler, UpdateContentToolHandler } from './content.js';
+import { ListFilesInDirToolHandler, ListFilesInVaultToolHandler } from './list.js';
 /**
  * Create all file-related tool handlers
  * @param client The ObsidianClient instance
@@ -16,7 +16,7 @@ export function createFileToolHandlers(client) {
         new ListFilesInDirToolHandler(client),
         new GetFileContentsToolHandler(client),
         new AppendContentToolHandler(client),
-        new PatchContentToolHandler(client)
+        new UpdateContentToolHandler(client)
     ];
 }
 //# sourceMappingURL=index.js.map

package/build/tools/files/list.js

@@ -1,5 +1,5 @@
-import { BaseToolHandler } from "../base.js";
 import { createLogger } from "../../utils/logging.js";
+import { BaseToolHandler } from "../base.js";
 // Create a logger for file operations
 const logger = createLogger('FileTools');
 /**
@@ -19,7 +19,7 @@ export class ListFilesInVaultToolHandler extends BaseToolHandler {
     getToolDescription() {
         return {
             name: this.name,
-            description: "Lists all files and directories in the root directory of your Obsidian vault. Returns a hierarchical structure of files and folders, including metadata like file type.",
+            description: "Lists all files and directories within the root of your Obsidian vault. Returns a hierarchical structure detailing files, folders, and their types.",
             examples: [
                 {
                     description: "List all files in vault",
@@ -74,7 +74,7 @@ export class ListFilesInDirToolHandler extends BaseToolHandler {
     getToolDescription() {
         return {
             name: this.name,
-            description: "Lists all files and directories that exist in a specific Obsidian directory. Returns a hierarchical structure showing files, folders, and their relationships. Useful for exploring vault organization and finding specific files.",
+            description: "Lists files and directories within a specific folder in your Obsidian vault. Returns a hierarchical structure. Note: Empty directories may not be included in the results. Useful for exploring vault organization.",
             examples: [
                 {
                     description: "List files in Documents folder",

package/build/tools/index.js

@@ -1,11 +1,11 @@
 import { createFileToolHandlers } from './files/index.js';
-import { createSearchToolHandlers } from './search/index.js';
 import { createPropertyToolHandlers } from './properties/index.js';
+import { createSearchToolHandlers } from './search/index.js';
 // Export the base handler and all submodules
 export * from './base.js';
 export * from './files/index.js';
-export * from './search/index.js';
 export * from './properties/index.js';
+export * from './search/index.js';
 /**
  * Create all tool handlers
  * @param client The ObsidianClient instance

package/build/tools/properties/index.js

@@ -1,9 +1,9 @@
 /**
  * Properties module exports
  */
-export * from './types.js';
 export * from './manager.js';
 export * from './tools.js';
+export * from './types.js';
 import { GetPropertiesToolHandler, UpdatePropertiesToolHandler } from './tools.js';
 /**
  * Create all property-related tool handlers