joplin-mcp-server 1.0.0

package/dist/tests/manual/delete-folder.test.js

@@ -0,0 +1,118 @@
+import dotenv from "dotenv";
+import JoplinAPIClient from "../../lib/joplin-api-client.js";
+import { DeleteFolder, ListNotebooks, ReadNotebook } from "../../lib/tools/index.js";
+// Load environment variables
+dotenv.config();
+// Check for required environment variables
+const requiredEnvVars = ["JOPLIN_PORT", "JOPLIN_TOKEN"];
+for (const envVar of requiredEnvVars) {
+    if (!process.env[envVar]) {
+        console.error(`Error: ${envVar} environment variable is required`);
+        process.exit(1);
+    }
+}
+// Create the Joplin API client
+const apiClient = new JoplinAPIClient({
+    port: parseInt(process.env.JOPLIN_PORT),
+    token: process.env.JOPLIN_TOKEN,
+});
+// Create the tools
+const deleteFolder = new DeleteFolder(apiClient);
+const listNotebooks = new ListNotebooks(apiClient);
+const readNotebook = new ReadNotebook(apiClient);
+// Test the delete folder functionality
+async function testDeleteFolder() {
+    try {
+        // Check if Joplin is available
+        const available = await apiClient.serviceAvailable();
+        if (!available) {
+            console.error("Error: Joplin service is not available");
+            process.exit(1);
+        }
+        // Parse command line arguments
+        const args = process.argv.slice(2);
+        const folderId = args[0];
+        const confirmFlag = args[1];
+        const forceFlag = args[2];
+        if (!folderId) {
+            console.log("No folder ID provided. Listing available notebooks:");
+            const notebooks = await listNotebooks.call();
+            console.log(notebooks);
+            console.log("\n⚠️  DANGER ZONE - DELETE OPERATIONS");
+            console.log("Please run again with a folder ID from the list above.");
+            console.log("Usage: tsx tests/manual/delete-folder.test.ts <folder_id> [confirm] [force]");
+            console.log("\nExamples:");
+            console.log("  tsx tests/manual/delete-folder.test.ts abc123                    # Show deletion preview");
+            console.log("  tsx tests/manual/delete-folder.test.ts abc123 confirm            # Delete if empty");
+            console.log("  tsx tests/manual/delete-folder.test.ts abc123 confirm force      # Force delete with contents");
+            console.log("\n⚠️  DELETION IS PERMANENT AND CANNOT BE UNDONE!");
+            process.exit(0);
+        }
+        console.log("📁 Notebook to be deleted:");
+        const currentNotebook = await readNotebook.call(folderId);
+        console.log(currentNotebook);
+        console.log("\n" + "=".repeat(80) + "\n");
+        const deleteOptions = { folder_id: folderId };
+        // Check if user wants to actually confirm deletion
+        if (confirmFlag === "confirm") {
+            deleteOptions.confirm = true;
+            if (forceFlag === "force") {
+                deleteOptions.force = true;
+                console.log("🗑️  PROCEEDING WITH FORCE DELETION (INCLUDING ALL CONTENTS)...");
+            }
+            else {
+                console.log("🗑️  PROCEEDING WITH DELETION...");
+            }
+        }
+        else {
+            console.log("🔍 DELETION PREVIEW (not actually deleting):");
+        }
+        console.log("");
+        const result = await deleteFolder.call(deleteOptions);
+        console.log(result);
+        if (!confirmFlag || confirmFlag !== "confirm") {
+            console.log("\n💡 To actually delete this notebook:");
+            console.log(`  Empty folder: tsx tests/manual/delete-folder.test.ts ${folderId} confirm`);
+            console.log(`  With contents: tsx tests/manual/delete-folder.test.ts ${folderId} confirm force`);
+            console.log("\n⚠️  WARNING: This will permanently delete the notebook and all its contents!");
+        }
+        else {
+            console.log("\n📋 Updated notebook hierarchy:");
+            const updatedNotebooks = await listNotebooks.call();
+            console.log(updatedNotebooks);
+        }
+    }
+    catch (error) {
+        console.error("Error testing delete folder:", error);
+    }
+}
+// Show usage if help requested
+if (process.argv.includes("--help") || process.argv.includes("-h")) {
+    console.log(`
+⚠️  DANGER: DELETE FOLDER TOOL
+
+Usage: tsx tests/manual/delete-folder.test.ts <folder_id> [confirm] [force]
+
+Arguments:
+  folder_id - ID of the folder/notebook to delete (required)
+  confirm   - Actually perform the deletion (optional)
+  force     - Force delete even if folder contains items (optional)
+
+Examples:
+  tsx tests/manual/delete-folder.test.ts abc123                    # Preview deletion
+  tsx tests/manual/delete-folder.test.ts abc123 confirm            # Delete if empty
+  tsx tests/manual/delete-folder.test.ts abc123 confirm force      # Force delete with all contents
+
+⚠️  WARNING: 
+- Deletion is permanent and cannot be undone!
+- Force deletion will destroy ALL notes and subfolders inside!
+
+First list notebooks to get their IDs:
+  npm run test:manual:list-notebooks
+`);
+    process.exit(0);
+}
+// Run if called directly
+if (import.meta.url === `file://${process.argv[1]}`) {
+    testDeleteFolder();
+}

package/dist/tests/manual/delete-note.test.d.ts

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

package/dist/tests/manual/delete-note.test.js

@@ -0,0 +1,101 @@
+import dotenv from "dotenv";
+import JoplinAPIClient from "../../lib/joplin-api-client.js";
+import { DeleteNote, SearchNotes, ReadNote } from "../../lib/tools/index.js";
+// Load environment variables
+dotenv.config();
+// Check for required environment variables
+const requiredEnvVars = ["JOPLIN_PORT", "JOPLIN_TOKEN"];
+for (const envVar of requiredEnvVars) {
+    if (!process.env[envVar]) {
+        console.error(`Error: ${envVar} environment variable is required`);
+        process.exit(1);
+    }
+}
+// Create the Joplin API client
+const apiClient = new JoplinAPIClient({
+    port: parseInt(process.env.JOPLIN_PORT),
+    token: process.env.JOPLIN_TOKEN,
+});
+// Create the tools
+const deleteNote = new DeleteNote(apiClient);
+const searchNotes = new SearchNotes(apiClient);
+const readNote = new ReadNote(apiClient);
+// Test the delete note functionality
+async function testDeleteNote() {
+    try {
+        // Check if Joplin is available
+        const available = await apiClient.serviceAvailable();
+        if (!available) {
+            console.error("Error: Joplin service is not available");
+            process.exit(1);
+        }
+        // Parse command line arguments
+        const args = process.argv.slice(2);
+        const noteId = args[0];
+        const confirmFlag = args[1];
+        if (!noteId) {
+            console.log("No note ID provided. Searching for notes to delete:");
+            const searchQuery = args[1] || "test";
+            const searchResults = await searchNotes.call(searchQuery);
+            console.log(searchResults);
+            console.log("\n⚠️  DANGER ZONE - DELETE OPERATIONS");
+            console.log("Please run again with a note ID from the search results above.");
+            console.log("Usage: tsx tests/manual/delete-note.test.ts <note_id> [confirm]");
+            console.log("\nExamples:");
+            console.log("  tsx tests/manual/delete-note.test.ts abc123           # Show deletion preview");
+            console.log("  tsx tests/manual/delete-note.test.ts abc123 confirm   # Actually delete");
+            console.log("\n⚠️  DELETION IS PERMANENT AND CANNOT BE UNDONE!");
+            process.exit(0);
+        }
+        console.log("📝 Note to be deleted:");
+        const currentNote = await readNote.call(noteId);
+        console.log(currentNote);
+        console.log("\n" + "=".repeat(80) + "\n");
+        const deleteOptions = { note_id: noteId };
+        // Check if user wants to actually confirm deletion
+        if (confirmFlag === "confirm") {
+            deleteOptions.confirm = true;
+            console.log("🗑️  PROCEEDING WITH DELETION...");
+        }
+        else {
+            console.log("🔍 DELETION PREVIEW (not actually deleting):");
+        }
+        console.log("");
+        const result = await deleteNote.call(deleteOptions);
+        console.log(result);
+        if (!confirmFlag || confirmFlag !== "confirm") {
+            console.log("\n💡 To actually delete this note, run:");
+            console.log(`tsx tests/manual/delete-note.test.ts ${noteId} confirm`);
+            console.log("\n⚠️  WARNING: This will permanently delete the note!");
+        }
+    }
+    catch (error) {
+        console.error("Error testing delete note:", error);
+    }
+}
+// Show usage if help requested
+if (process.argv.includes("--help") || process.argv.includes("-h")) {
+    console.log(`
+⚠️  DANGER: DELETE NOTE TOOL
+
+Usage: tsx tests/manual/delete-note.test.ts <note_id> [confirm]
+
+Arguments:
+  note_id - ID of the note to delete (required)
+  confirm - Actually perform the deletion (optional)
+
+Examples:
+  tsx tests/manual/delete-note.test.ts abc123           # Preview deletion
+  tsx tests/manual/delete-note.test.ts abc123 confirm   # Actually delete
+
+⚠️  WARNING: Deletion is permanent and cannot be undone!
+
+First search for notes to get their IDs:
+  tsx tests/manual/search-notes.test.ts "search term"
+`);
+    process.exit(0);
+}
+// Run if called directly
+if (import.meta.url === `file://${process.argv[1]}`) {
+    testDeleteNote();
+}

package/dist/tests/manual/edit-folder.test.d.ts

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

package/dist/tests/manual/edit-folder.test.js

@@ -0,0 +1,104 @@
+import dotenv from "dotenv";
+import JoplinAPIClient from "../../lib/joplin-api-client.js";
+import { EditFolder, ListNotebooks, ReadNotebook } from "../../lib/tools/index.js";
+// Load environment variables
+dotenv.config();
+// Check for required environment variables
+const requiredEnvVars = ["JOPLIN_PORT", "JOPLIN_TOKEN"];
+for (const envVar of requiredEnvVars) {
+    if (!process.env[envVar]) {
+        console.error(`Error: ${envVar} environment variable is required`);
+        process.exit(1);
+    }
+}
+// Create the Joplin API client
+const apiClient = new JoplinAPIClient({
+    port: parseInt(process.env.JOPLIN_PORT),
+    token: process.env.JOPLIN_TOKEN,
+});
+// Create the tools
+const editFolder = new EditFolder(apiClient);
+const listNotebooks = new ListNotebooks(apiClient);
+const readNotebook = new ReadNotebook(apiClient);
+// Test the edit folder functionality
+async function testEditFolder() {
+    try {
+        // Check if Joplin is available
+        const available = await apiClient.serviceAvailable();
+        if (!available) {
+            console.error("Error: Joplin service is not available");
+            process.exit(1);
+        }
+        // Parse command line arguments
+        const args = process.argv.slice(2);
+        const folderId = args[0];
+        if (!folderId) {
+            console.log("No folder ID provided. Listing available notebooks:");
+            const notebooks = await listNotebooks.call();
+            console.log(notebooks);
+            console.log("\nPlease run again with a folder ID from the list above.");
+            console.log("Usage: tsx tests/manual/edit-folder.test.ts <folder_id> [field=value] [field=value]...");
+            console.log("\nExamples:");
+            console.log('  tsx tests/manual/edit-folder.test.ts abc123 title="New Name"');
+            console.log('  tsx tests/manual/edit-folder.test.ts abc123 title="Subfolder" parent_id="def456"');
+            process.exit(0);
+        }
+        // Parse edit parameters from remaining arguments
+        const editOptions = { folder_id: folderId };
+        for (let i = 1; i < args.length; i++) {
+            const arg = args[i];
+            const [key, value] = arg.split("=", 2);
+            if (!value) {
+                console.error(`Invalid argument: ${arg}. Use format key=value`);
+                continue;
+            }
+            // Remove quotes if present
+            editOptions[key] = value.replace(/^["']|["']$/g, "");
+        }
+        console.log("📁 Current notebook:");
+        const currentNotebook = await readNotebook.call(folderId);
+        console.log(currentNotebook);
+        console.log("\n" + "=".repeat(80) + "\n");
+        console.log("🔄 Editing notebook with:");
+        Object.entries(editOptions).forEach(([key, value]) => {
+            if (key !== "folder_id") {
+                console.log(`  ${key}: ${JSON.stringify(value)}`);
+            }
+        });
+        console.log("");
+        const result = await editFolder.call(editOptions);
+        console.log(result);
+        console.log("\n📋 Updated notebook hierarchy:");
+        const updatedNotebooks = await listNotebooks.call();
+        console.log(updatedNotebooks);
+    }
+    catch (error) {
+        console.error("Error testing edit folder:", error);
+    }
+}
+// Show usage if help requested
+if (process.argv.includes("--help") || process.argv.includes("-h")) {
+    console.log(`
+Usage: tsx tests/manual/edit-folder.test.ts <folder_id> [field=value] [field=value]...
+
+Arguments:
+  folder_id - ID of the folder/notebook to edit (required)
+  
+Available fields:
+  title="New Name"           - Update folder title
+  parent_id="parent_id"      - Move to different parent folder
+
+Examples:
+  tsx tests/manual/edit-folder.test.ts abc123 title="New Name"
+  tsx tests/manual/edit-folder.test.ts abc123 title="Subfolder" parent_id="def456"
+  tsx tests/manual/edit-folder.test.ts abc123 parent_id=""  # Move to top level
+
+First list notebooks to get their IDs:
+  npm run test:manual:list-notebooks
+`);
+    process.exit(0);
+}
+// Run if called directly
+if (import.meta.url === `file://${process.argv[1]}`) {
+    testEditFolder();
+}

package/dist/tests/manual/edit-note.test.d.ts

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

package/dist/tests/manual/edit-note.test.js

@@ -0,0 +1,118 @@
+import dotenv from "dotenv";
+import JoplinAPIClient from "../../lib/joplin-api-client.js";
+import { EditNote, SearchNotes, ReadNote } from "../../lib/tools/index.js";
+// Load environment variables
+dotenv.config();
+// Check for required environment variables
+const requiredEnvVars = ["JOPLIN_PORT", "JOPLIN_TOKEN"];
+for (const envVar of requiredEnvVars) {
+    if (!process.env[envVar]) {
+        console.error(`Error: ${envVar} environment variable is required`);
+        process.exit(1);
+    }
+}
+// Create the Joplin API client
+const apiClient = new JoplinAPIClient({
+    port: parseInt(process.env.JOPLIN_PORT),
+    token: process.env.JOPLIN_TOKEN,
+});
+// Create the tools
+const editNote = new EditNote(apiClient);
+const searchNotes = new SearchNotes(apiClient);
+const readNote = new ReadNote(apiClient);
+// Test the edit note functionality
+async function testEditNote() {
+    try {
+        // Check if Joplin is available
+        const available = await apiClient.serviceAvailable();
+        if (!available) {
+            console.error("Error: Joplin service is not available");
+            process.exit(1);
+        }
+        // Parse command line arguments
+        const args = process.argv.slice(2);
+        const noteId = args[0];
+        if (!noteId) {
+            console.log("No note ID provided. Searching for notes to edit:");
+            const searchQuery = args[1] || "test";
+            const searchResults = await searchNotes.call(searchQuery);
+            console.log(searchResults);
+            console.log("\nPlease run again with a note ID from the search results above.");
+            console.log("Usage: tsx tests/manual/edit-note.test.ts <note_id> [field=value] [field=value]...");
+            console.log("\nExamples:");
+            console.log('  tsx tests/manual/edit-note.test.ts abc123 title="Updated Title"');
+            console.log('  tsx tests/manual/edit-note.test.ts abc123 body="New content" is_todo=true');
+            console.log("  tsx tests/manual/edit-note.test.ts abc123 todo_completed=true");
+            process.exit(0);
+        }
+        // Parse edit parameters from remaining arguments
+        const editOptions = { note_id: noteId };
+        for (let i = 1; i < args.length; i++) {
+            const arg = args[i];
+            const [key, value] = arg.split("=", 2);
+            if (!value) {
+                console.error(`Invalid argument: ${arg}. Use format key=value`);
+                continue;
+            }
+            // Parse different types of values
+            if (key === "is_todo" || key === "todo_completed") {
+                editOptions[key] = value.toLowerCase() === "true";
+            }
+            else if (key === "todo_due") {
+                editOptions[key] = parseInt(value);
+            }
+            else {
+                // Remove quotes if present
+                editOptions[key] = value.replace(/^["']|["']$/g, "");
+            }
+        }
+        console.log("📝 Current note:");
+        const currentNote = await readNote.call(noteId);
+        console.log(currentNote);
+        console.log("\n" + "=".repeat(80) + "\n");
+        console.log("🔄 Editing note with:");
+        Object.entries(editOptions).forEach(([key, value]) => {
+            if (key !== "note_id") {
+                console.log(`  ${key}: ${JSON.stringify(value)}`);
+            }
+        });
+        console.log("");
+        const result = await editNote.call(editOptions);
+        console.log(result);
+    }
+    catch (error) {
+        console.error("Error testing edit note:", error);
+    }
+}
+// Show usage if help requested
+if (process.argv.includes("--help") || process.argv.includes("-h")) {
+    console.log(`
+Usage: tsx tests/manual/edit-note.test.ts <note_id> [field=value] [field=value]...
+
+Arguments:
+  note_id - ID of the note to edit (required)
+  
+Available fields:
+  title="New Title"           - Update note title
+  body="New content"          - Update note body (Markdown)
+  body_html="<p>HTML</p>"     - Update note body (HTML)
+  parent_id="notebook_id"     - Move to different notebook
+  is_todo=true/false          - Convert to/from todo
+  todo_completed=true/false   - Mark todo as completed/incomplete
+  todo_due=1234567890000      - Set due date (timestamp)
+
+Examples:
+  tsx tests/manual/edit-note.test.ts abc123 title="Updated Title"
+  tsx tests/manual/edit-note.test.ts abc123 body="New content" is_todo=true
+  tsx tests/manual/edit-note.test.ts abc123 todo_completed=true
+  tsx tests/manual/edit-note.test.ts abc123 parent_id="def456"
+
+First search for notes to get their IDs:
+  tsx tests/manual/search-notes.test.ts "search term"
+`);
+    process.exit(0);
+}
+// Run if called directly
+if (import.meta.url === `file://${process.argv[1]}`) {
+    testEditNote();
+}

package/dist/tests/manual/list-notebooks.test.d.ts

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

package/dist/tests/manual/list-notebooks.test.js

@@ -0,0 +1,42 @@
+import dotenv from "dotenv";
+import JoplinAPIClient from "../../lib/joplin-api-client.js";
+import { ListNotebooks } from "../../lib/tools/index.js";
+// Load environment variables
+dotenv.config();
+// Check for required environment variables
+const requiredEnvVars = ["JOPLIN_PORT", "JOPLIN_TOKEN"];
+for (const envVar of requiredEnvVars) {
+    if (!process.env[envVar]) {
+        console.error(`Error: ${envVar} environment variable is required`);
+        process.exit(1);
+    }
+}
+// Create the Joplin API client
+const apiClient = new JoplinAPIClient({
+    port: parseInt(process.env.JOPLIN_PORT),
+    token: process.env.JOPLIN_TOKEN,
+});
+// Create the tool
+const listNotebooks = new ListNotebooks(apiClient);
+// Test the list notebooks functionality
+async function testListNotebooks() {
+    try {
+        // Check if Joplin is available
+        const available = await apiClient.serviceAvailable();
+        if (!available) {
+            console.error("Error: Joplin service is not available");
+            process.exit(1);
+        }
+        console.log("📋 Listing all notebooks:");
+        console.log("");
+        const result = await listNotebooks.call();
+        console.log(result);
+    }
+    catch (error) {
+        console.error("Error testing list notebooks:", error);
+    }
+}
+// Run if called directly
+if (import.meta.url === `file://${process.argv[1]}`) {
+    testListNotebooks();
+}

package/dist/tests/manual/read-note.test.d.ts

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

package/dist/tests/manual/read-note.test.js

@@ -0,0 +1,54 @@
+import dotenv from "dotenv";
+import JoplinAPIClient from "../../lib/joplin-api-client.js";
+import { SearchNotes, ReadNote } from "../../lib/tools/index.js";
+// Load environment variables
+dotenv.config();
+// Check for required environment variables
+const requiredEnvVars = ["JOPLIN_PORT", "JOPLIN_TOKEN"];
+for (const envVar of requiredEnvVars) {
+    if (!process.env[envVar]) {
+        console.error(`Error: ${envVar} environment variable is required`);
+        process.exit(1);
+    }
+}
+// Create the Joplin API client
+const apiClient = new JoplinAPIClient({
+    port: parseInt(process.env.JOPLIN_PORT),
+    token: process.env.JOPLIN_TOKEN,
+});
+// Create the tools
+const searchNotes = new SearchNotes(apiClient);
+const readNote = new ReadNote(apiClient);
+// Test the read note functionality
+async function testReadNote() {
+    try {
+        // Check if Joplin is available
+        const available = await apiClient.serviceAvailable();
+        if (!available) {
+            console.error("Error: Joplin service is not available");
+            process.exit(1);
+        }
+        // If no note ID is provided, search for notes first
+        const noteId = process.argv[2];
+        if (!noteId) {
+            console.log("No note ID provided. Searching for a sample note:");
+            const searchQuery = process.argv[3] || "todo"; // Default search term if none provided
+            const searchResults = await searchNotes.call(searchQuery);
+            console.log(searchResults);
+            console.log("\nPlease run again with a note ID from the search results above.");
+            console.log("Example: tsx tests/manual/read-note.test.ts your-note-id");
+            process.exit(0);
+        }
+        // Read the specified note
+        console.log(`Reading note with ID: "${noteId}"`);
+        const result = await readNote.call(noteId);
+        console.log(result);
+    }
+    catch (error) {
+        console.error("Error testing read note:", error);
+    }
+}
+// Run if called directly
+if (import.meta.url === `file://${process.argv[1]}`) {
+    testReadNote();
+}

package/dist/tests/manual/search-notes.test.d.ts

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

package/dist/tests/manual/search-notes.test.js

@@ -0,0 +1,43 @@
+import dotenv from "dotenv";
+import JoplinAPIClient from "../../lib/joplin-api-client.js";
+import { SearchNotes } from "../../lib/tools/index.js";
+// Load environment variables
+dotenv.config();
+// Check for required environment variables
+const requiredEnvVars = ["JOPLIN_PORT", "JOPLIN_TOKEN"];
+for (const envVar of requiredEnvVars) {
+    if (!process.env[envVar]) {
+        console.error(`Error: ${envVar} environment variable is required`);
+        process.exit(1);
+    }
+}
+// Create the Joplin API client
+const apiClient = new JoplinAPIClient({
+    port: parseInt(process.env.JOPLIN_PORT),
+    token: process.env.JOPLIN_TOKEN,
+});
+// Create the search tool
+const searchNotes = new SearchNotes(apiClient);
+// Test the search functionality
+async function testSearch() {
+    try {
+        // Check if Joplin is available
+        const available = await apiClient.serviceAvailable();
+        if (!available) {
+            console.error("Error: Joplin service is not available");
+            process.exit(1);
+        }
+        // Perform a search
+        const query = process.argv[2] || "test";
+        console.log(`Searching for: "${query}"`);
+        const result = await searchNotes.call(query);
+        console.log(result);
+    }
+    catch (error) {
+        console.error("Error testing search:", error);
+    }
+}
+// Run if called directly
+if (import.meta.url === `file://${process.argv[1]}`) {
+    testSearch();
+}

package/dist/tests/unit/create-tools.test.d.ts

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