triliumnext-mcp 0.3.10-beta.1 → 0.3.10

package/README.md

@@ -1,150 +1,188 @@
-# TriliumNext Notes' MCP Server
-
-⚠️ **DISCLAIMER: This is a prototype for https://github.com/TriliumNext/Notes/issues/705. Suggested only for developer use. Please backup your Trilium notes before using this tool.** ⚠️
-
-A model context protocol server for TriliumNext Notes. This server provides tools to interact with your Trilium Notes instance through MCP.
-
-## Quick Start
-
-Make sure to set up your environment variables first:
-- `TRILIUM_API_URL` (default: http://localhost:8080/etapi)
-- `TRILIUM_API_TOKEN` (required, get this from your Trilium Notes settings)
-- `PERMISSIONS` (optional, default='READ;WRITE', where READ grants access to `search_notes`, `get_note`, `resolve_note_id`, and `read_attributes`, and WRITE grants access to `create_note`, `update_note`, `delete_note`, and `manage_attributes`)
-- `VERBOSE` (optional, default='false', which if true will print verbose debugging logs)
-
-## Installation
-
-### 1. Using with Claude Desktop
-
-Add the server config to your Claude Desktop configuration file:
-
-#### For Local Installation (on Windows)
-
-```json
-"triliumnext-mcp": {
-  "command": "cmd",
-  "args": [
-        "/k",
-        "npx",
-        "-y",
-        "triliumnext-mcp"
-      ],
-   "env": {
-    "TRILIUM_API_URL": "http://localhost:8080/etapi",
-    "TRILIUM_API_TOKEN": "<YOUR_TRILIUM_API_TOKEN>",
-    "PERMISSIONS": "READ;WRITE"
-  }
-}
-```
-
-#### For Local installation (on Linux)
-
-```json
-"triliumnext-mcp": {
-  "command": "npx",
-  "args": [
-        "-y",
-        "triliumnext-mcp"
-      ],
-   "env": {
-    "TRILIUM_API_URL": "http://localhost:8080/etapi",
-    "TRILIUM_API_TOKEN": "<YOUR_TRILIUM_API_TOKEN>",
-    "PERMISSIONS": "READ;WRITE"
-  }
-}
-```
-
-#### For Development (on Windows / Linux)
-
-```bash
-cd /path/to/triliumnext-mcp
-npm run build
-```
-
-```json
-"triliumnext-mcp": {
-  "command": "node",
-  "args": [
-        "/path/to/triliumnext-mcp/build/index.js"
-  ],
-  "env": {
-    "TRILIUM_API_URL": "http://localhost:8080/etapi",
-    "TRILIUM_API_TOKEN": "<YOUR_TRILIUM_API_TOKEN>",
-    "PERMISSIONS": "READ;WRITE",
-    "VERBOSE": "true"
-  }
-}
-```
-
-Location of the configuration file:
-- Windows: `%APPDATA%/Claude/claude_desktop_config.json`
-- MacOS: `~/Library/Application Support/Claude/claude_desktop_config.json`
-
-**Feedback**: Please report issues and test results at [GitHub Issues](https://github.com/TriliumNext/Notes/issues)
-
-## Available Tools
-
-The server provides the following tools for note management:
-
-### Search & Discovery Tools
-
-- `search_notes` - Unified search with comprehensive filtering capabilities including keyword search, date ranges, field-specific searches, attribute searches, note properties, template-based searches, note type filtering, MIME type filtering, and hierarchy navigation.
-- `resolve_note_id` - Find a note's ID by its title. Essential for getting a note's ID to use with other tools.
-
-### Note Management Tools
-
-- `get_note` - Retrieve a note and its content by ID. Can also be used with regex to extract specific patterns from the content.
-- `create_note` - Create a new note. Supports 9 note types and allows creating attributes (labels and relations) in the same step.
-- `update_note` - Updates a note's title or content. Requires a `mode` (`'overwrite'` or `'append'`) to specify the update type and an `expectedHash` to prevent conflicts.
-- `delete_note` - Permanently delete a note (⚠️ cannot be undone).
-
-### Attribute Management Tools
-
-- `read_attributes` - Read all attributes (labels and relations) for a given note.
-- `manage_attributes` - Create, update, or delete attributes on a note. Supports batch creation.
-
-> 📖 **Detailed Usage**: See [Note Management Guide](docs/manage-notes-examples/index.md) for revision control strategy and best practices.
-
-## Example Queries
-
-### Search & Discovery
-- "Find my most recent 10 notes about 'n8n' since the beginning of 2024"
-- "Show me notes I've edited in the last 7 days"
-- "List all notes under 'n8n Template' folder, including subfolders"
-
-### Content Management
-- "Add today's update to my work log" (uses `update_note` with `mode: 'append'`)
-- "Replace this draft with the final version" (uses `update_note` with `mode: 'overwrite'`)
-- "Create a new note called 'Weekly Review' in my journal folder"
-
-> 📖 **More Examples**: See [User Query Examples](docs/user-query-examples.md) for comprehensive usage scenarios.
-
-## Documentation
-
-- [Note Management Guide](docs/manage-notes-examples/index.md) - Safe content editing with revision control
-- [User Query Examples](docs/user-query-examples.md) - Natural language query examples
-- [Search Query Examples](docs/search-examples/) - Advanced search syntax and filters
-
-## Development
-
-If you want to contribute or modify the server:
-
-```bash
-# Clone the repository
-git clone https://github.com/tan-yong-sheng/triliumnext-mcp.git
-
-# Install dependencies
-npm install
-
-# Build the server
-npm run build
-
-# For development with auto-rebuild
-npm run watch
-```
-
-## Contributing
-
-Contributions are welcome! If you are looking to improve the server, please familiarize yourself with the official [Trilium Search DSL documentation](https://triliumnext.github.io/Docs/Wiki/search.html) and our internal [Search Query Examples](docs/search-examples/) to understand how search queries are constructed.
-
-Please feel free to open an issue or submit a pull request.
+# TriliumNext Notes' MCP Server
+
+⚠️ **DISCLAIMER: This is a prototype for https://github.com/TriliumNext/Notes/issues/705. Suggested only for developer use. Please backup your Trilium notes before using this tool.** ⚠️
+
+A model context protocol server for TriliumNext Notes. This server provides tools to interact with your Trilium Notes instance through MCP.
+
+## Quick Start
+
+Make sure to set up your environment variables first:
+- `TRILIUM_API_URL` (default: http://localhost:8080/etapi)
+- `TRILIUM_API_TOKEN` (required, get this from your Trilium Notes settings)
+- `PERMISSIONS` (optional, default='READ;WRITE', where READ let this MCP has permissions to perform `search_notes` and `get_note` operation and WRITE let this MCP has permissions to perform `create_note`, `update_note` and `delete_note` operations) 
+- `VERBOSE` (optional, default='false', where if true it will print out some logging response and pass the logs into LLM (such as API call) which is useful for developers to debug this MCP)
+
+## Installation
+
+### 1. Using with Claude Desktop 
+
+Add the server config to your Claude Desktop configuration file:
+
+Add the following configuration to the `mcpServers` object in your Claude configuration file:
+
+
+#### For Local Installation (on Windows)
+
+```json
+"triliumnext-mcp": {
+  "command": "cmd",
+  "args": [
+        "/k",
+        "npx",
+        "-y",
+        "triliumnext-mcp"
+      ],
+   "env": {
+    "TRILIUM_API_URL": "http://localhost:8080/etapi",
+    "TRILIUM_API_TOKEN": "<YOUR_TRILIUM_API_TOKEN>",
+    "PERMISSIONS": "READ;WRITE"
+  }
+}
+```
+
+#### For Local installation (on Linux)
+
+```json
+"triliumnext-mcp": {
+  "command": "npx",
+  "args": [
+        "-y",
+        "triliumnext-mcp"
+      ],
+   "env": {
+    "TRILIUM_API_URL": "http://localhost:8080/etapi",
+    "TRILIUM_API_TOKEN": "<YOUR_TRILIUM_API_TOKEN>",
+    "PERMISSIONS": "READ;WRITE"
+  }
+}
+```
+
+#### For Development (on Windows / Linux)
+
+```bash
+cd /path/to/triliumnext-mcp
+npm run build
+```
+
+```json
+"triliumnext-mcp": {
+  "command": "node",
+  "args": [
+        "/path/to/triliumnext-mcp/build/index.js"
+  ],
+  "env": {
+    "TRILIUM_API_URL": "http://localhost:8080/etapi",
+    "TRILIUM_API_TOKEN": "<YOUR_TRILIUM_API_TOKEN>",
+    "PERMISSIONS": "READ;WRITE",
+    "VERBOSE": "true"
+  }
+}
+```
+
+
+Location of the configuration file:
+- Windows: `%APPDATA%/Claude/claude_desktop_config.json`
+- MacOS: `~/Library/Application Support/Claude/claude_desktop_config.json`
+
+
+**Feedback**: Please report issues and test results at [GitHub Issues](https://github.com/TriliumNext/Notes/issues)
+
+
+## Available Tools
+
+The server provides the following tools for note management:
+
+### Search Tools
+
+- `search_notes` - Unified search with comprehensive filtering capabilities
+  - **Unified Architecture**: Uses `searchCriteria` parameter for complete boolean logic expressiveness
+  - **Cross-type OR logic**: Combine labels, relations, note properties, and hierarchy navigation with OR/AND logic
+  - **Parameters**: `text` (keyword search), `searchCriteria` (unified array structure), `limit`
+  - **Smart optimization**: Automatically uses fastSearch when only text parameter is provided
+  - **Complete filtering**: Supports labels (#book), relations (~author.title), note properties (title, content, dateCreated), hierarchy navigation (parents.*, children.*, ancestors.*)
+  - **Navigation support**: Use hierarchy properties like `parents.noteId` for direct children, `ancestors.noteId` for all descendants
+
+- `resolve_note_id` - Find note ID by name/title for LLM-friendly workflows
+  - **Simple title-based search**: Uses fuzzy search to find notes by title/name
+  - **Smart prioritization**: Exact matches → folder-type notes → most recent
+  - **User choice workflow**: When multiple matches found, presents options for user selection
+  - **Configurable results**: `maxResults` parameter (default: 3, range: 1-10)
+  - **JSON response format**: Returns structured data with selectedNote, totalMatches, and nextSteps guidance
+  - **Essential workflow**: resolve name → get ID → use with other tools
+
+### Note Discovery Tools
+
+- `search_notes` - Advanced search with unified filtering capabilities including hierarchy navigation
+  - **Complex queries**: Use for sophisticated filtering with multiple criteria
+  - **Boolean logic**: Cross-type OR/AND operations between all search criteria types
+  - **Unified structure**: Single `searchCriteria` parameter handles labels, relations, properties, and hierarchy
+  - **Navigation support**: Use hierarchy properties like `parents.noteId` for direct children, `ancestors.noteId` for all descendants
+  - **Performance optimized**: Automatic fastSearch when appropriate
+
+### Note Management Tools
+
+- `get_note` - Retrieve a note content by ID
+- `create_note` - Create a new note (supports various types: text, code, file, image, etc.)
+- `update_note` - Replace entire note content (⚠️ creates backup by default)  
+- `append_note` - Add content while preserving existing content (📝 optimized for logs/journals)
+- `delete_note` - Permanently delete a note (⚠️ cannot be undone)
+
+> 📖 **Detailed Usage**: See [Content Modification Guide](docs/content-modification-guide.md) for revision control strategy and best practices.
+
+## Example Queries
+
+### Search & Discovery
+- "Find my most recent 10 notes about 'n8n' since the beginning of 2020" → Uses `search_notes` with unified searchCriteria
+- "Show me notes I've edited in the last 7 days" → Uses `search_notes` with date properties
+- "Find notes with 'machine learning' in the title created this year" → Uses `search_notes` with cross-type criteria
+- "Search for 'kubernetes' in notes created between January and June" → Uses `search_notes` with boolean logic
+
+### Navigation & Browsing
+- "List all notes including subfolders" → Uses `search_notes` with `ancestors.noteId` hierarchy property
+- "Show me everything I have" → Uses `search_notes` with `ancestors.noteId` for complete inventory
+- "List all notes" → Uses `search_notes` with `parents.noteId` hierarchy property
+- "List all notes under 'n8n Template' folder" → Uses `search_notes` with `parents.noteId` hierarchy property
+- "List all notes under 'n8n Template' folder, including subfolders" → Uses `search_notes` with `ancestors.noteId` hierarchy property
+- "Find notes by author Tolkien OR created this week" → Uses `search_notes` with unified `searchCriteria` for cross-type OR logic
+
+### Content Management
+- "Add today's update to my work log" (uses `append_note`)
+- "Replace this draft with the final version" (uses `update_note`)
+- "Create a new note called 'Weekly Review' in my journal folder"
+
+> 📖 **More Examples**: See [User Query Examples](docs/user-query-examples.md) for comprehensive usage scenarios.
+
+## Documentation
+
+- [Content Modification Guide](docs/content-modification-guide.md) - Safe content editing with revision control
+- [User Query Examples](docs/user-query-examples.md) - Natural language query examples
+- [Search Query Examples](docs/search-examples/) - Advanced search syntax and filters
+
+## Development
+
+If you want to contribute or modify the server:
+
+```bash
+# Clone the repository
+git clone https://github.com/tan-yong-sheng/triliumnext-mcp.git
+
+# Install dependencies
+npm install
+
+# Build the server
+npm run build
+
+# For development with auto-rebuild
+npm run watch
+```
+
+## Contributing
+
+Contributions are welcome! If you are looking to improve the server, especially the search functionality, please familiarize yourself with the following resources:
+
+- **Trilium Search DSL**: The [official documentation](https://triliumnext.github.io/Docs/Wiki/search.html) provides the foundation for all search queries.
+- **Internal Search Implementation**: Our [Search Query Examples](docs/search-examples/) document details how `search_notes` parameters are translated into Trilium search strings. This is crucial for understanding and extending the current implementation.
+
+Please feel free to open an issue or submit a pull request.
+
+

package/build/index.js

@@ -5,7 +5,7 @@ import { CallToolRequestSchema, ErrorCode, ListToolsRequestSchema, McpError, } f
 import axios from "axios";
 // Import modular components
 import { generateTools } from "./modules/toolDefinitions.js";
-import { handleCreateNoteRequest, handleUpdateNoteRequest, handleDeleteNoteRequest, handleGetNoteRequest, handleSearchReplaceNoteRequest } from "./modules/noteHandler.js";
+import { handleCreateNoteRequest, handleUpdateNoteRequest, handleDeleteNoteRequest, handleGetNoteRequest } from "./modules/noteHandler.js";
 import { handleSearchNotesRequest } from "./modules/searchHandler.js";
 import { handleResolveNoteRequest } from "./modules/resolveHandler.js";
 import { handleManageAttributes, handleReadAttributes } from "./modules/attributeHandler.js";
@@ -23,7 +23,7 @@ class TriliumServer {
         this.allowedPermissions = PERMISSIONS.split(';');
         this.server = new Server({
             name: "triliumnext-mcp",
-            version: "0.3.10",
+            version: "0.1.0",
         }, {
             capabilities: {
                 tools: {},
@@ -66,8 +66,6 @@ class TriliumServer {
                         return await handleDeleteNoteRequest(request.params.arguments, this.axiosInstance, this);
                     case "get_note":
                         return await handleGetNoteRequest(request.params.arguments, this.axiosInstance, this);
-                    case "search_and_replace_note":
-                        return await handleSearchReplaceNoteRequest(request.params.arguments, this.axiosInstance, this);
                     // Search and listing operations
                     case "search_notes":
                         return await handleSearchNotesRequest(request.params.arguments, this.axiosInstance, this);

package/build/modules/noteHandler.js

@@ -3,7 +3,7 @@
  * Centralized request handling for note operations
  */
 import { McpError, ErrorCode } from "@modelcontextprotocol/sdk/types.js";
-import { handleCreateNote, handleUpdateNote, handleDeleteNote, handleGetNote, handleSearchReplaceNote } from "./noteManager.js";
+import { handleCreateNote, handleUpdateNote, handleDeleteNote, handleGetNote } from "./noteManager.js";
 /**
  * Handle create_note tool requests
  */
@@ -117,22 +117,21 @@ export async function handleGetNoteRequest(args, axiosInstance, permissionChecke
         const noteOperation = {
             noteId: args.noteId,
             includeContent: args.includeContent !== false,
-            searchPattern: args.searchPattern,
-            useRegex: args.useRegex !== false, // Default to true
-            searchFlags: args.searchFlags || 'g'
+            regexPattern: args.regexPattern,
+            regexFlags: args.regexFlags || 'g'
         };
         const result = await handleGetNote(noteOperation, axiosInstance);
-        // Build response data based on whether search was performed
+        // Build response data based on whether regex search was performed
         let responseData = {
             ...result.note,
             contentHash: result.contentHash
         };
-        if (result.search) {
-            // Search was performed, include search object but not content
-            responseData.search = result.search;
+        if (result.regexSearch) {
+            // Regex search was performed, include regexSearch object but not content
+            responseData.regexSearch = result.regexSearch;
         }
         else if (result.content) {
-            // Standard response, include content but not search
+            // Standard response, include content but not regexSearch
             responseData.content = result.content;
         }
         return {
@@ -149,46 +148,3 @@ export async function handleGetNoteRequest(args, axiosInstance, permissionChecke
         throw new McpError(ErrorCode.InvalidParams, error instanceof Error ? error.message : String(error));
     }
 }
-/**
- * Handle search_and_replace_note tool requests
- */
-export async function handleSearchReplaceNoteRequest(args, axiosInstance, permissionChecker) {
-    if (!permissionChecker.hasPermission("WRITE")) {
-        throw new McpError(ErrorCode.InvalidRequest, "Permission denied: Not authorized to modify notes.");
-    }
-    // Validate that expectedHash is provided (required for data integrity)
-    if (!args.expectedHash) {
-        throw new McpError(ErrorCode.InvalidParams, "Missing required parameter 'expectedHash'. You must call get_note first to retrieve the current blobId (content hash) before performing search and replace. This ensures data integrity by preventing overwriting changes made by other users.");
-    }
-    // Validate required parameters
-    if (!args.searchPattern) {
-        throw new McpError(ErrorCode.InvalidParams, "Missing required parameter 'searchPattern'. The pattern to search for is required.");
-    }
-    if (!args.replacePattern) {
-        throw new McpError(ErrorCode.InvalidParams, "Missing required parameter 'replacePattern'. The replacement pattern is required.");
-    }
-    try {
-        const noteOperation = {
-            noteId: args.noteId,
-            searchPattern: args.searchPattern,
-            replacePattern: args.replacePattern,
-            useRegex: args.useRegex !== false, // Default to true
-            searchFlags: args.searchFlags || 'g',
-            revision: args.revision !== false, // Default to true for safety
-            expectedHash: args.expectedHash
-        };
-        const result = await handleSearchReplaceNote(noteOperation, axiosInstance);
-        return {
-            content: [{
-                    type: "text",
-                    text: result.message
-                }]
-        };
-    }
-    catch (error) {
-        if (error instanceof McpError) {
-            throw error;
-        }
-        throw new McpError(ErrorCode.InvalidParams, error instanceof Error ? error.message : String(error));
-    }
-}