mcp-obsidian-cli 1.1.0 → 1.2.0

package/lib/helpers.js

@@ -0,0 +1,62 @@
+/**
+ * Pure helper functions extracted from server.js for testability.
+ */
+
+import { readFileSync, existsSync } from "node:fs";
+import { load as yamlLoad } from "js-yaml";
+
+/**
+ * Load config from YAML file with env var overrides.
+ * @param {string} configFile - Path to the YAML config file.
+ * @returns {{ vault: string, cliPath: string, timeoutMs: number }}
+ */
+export function loadConfig(configFile) {
+  const defaults = { vault: "", cliPath: "obsidian", timeoutMs: 15000 };
+  let config = { ...defaults };
+
+  if (existsSync(configFile)) {
+    try {
+      const content = readFileSync(configFile, "utf8");
+      const fileConfig = yamlLoad(content);
+      if (fileConfig) {
+        if (fileConfig.vault) config.vault = fileConfig.vault;
+        if (fileConfig.cliPath) config.cliPath = fileConfig.cliPath;
+        if (fileConfig.timeoutMs) config.timeoutMs = fileConfig.timeoutMs;
+      }
+    } catch (err) {
+      console.error("Warning: failed to load config file:", err.message);
+    }
+  }
+
+  if (process.env.OBSIDIAN_VAULT) config.vault = process.env.OBSIDIAN_VAULT;
+  if (process.env.OBSIDIAN_CLI_PATH) config.cliPath = process.env.OBSIDIAN_CLI_PATH;
+  if (process.env.OBSIDIAN_TIMEOUT_MS) config.timeoutMs = parseInt(process.env.OBSIDIAN_TIMEOUT_MS, 10);
+
+  return config;
+}
+
+/**
+ * Minimal arg parser: splits on whitespace but respects key="value with spaces".
+ */
+export function parseArgs(str) {
+  const args = [];
+  const re = /(?:[^\s"]+|"[^"]*")+/g;
+  let m;
+  while ((m = re.exec(str)) !== null) {
+    args.push(m[0].replace(/"([^"]*)"/g, "$1"));
+  }
+  return args;
+}
+
+/** Standard MCP text result. */
+export function text(content) {
+  return { content: [{ type: "text", text: content }] };
+}
+
+/** Standard MCP error result. */
+export function errorResult(content, code = "EXECUTION_ERROR") {
+  return {
+    content: [{ type: "text", text: content }],
+    isError: true,
+  };
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "mcp-obsidian-cli",
-  "version": "1.1.0",
+  "version": "1.2.0",
   "type": "module",
   "description": "MCP server wrapping the Obsidian CLI — full native API access over Model Context Protocol",
   "main": "server.js",
@@ -9,11 +9,12 @@
   },
   "files": [
     "server.js",
+    "lib/",
     "prompts/"
   ],
   "scripts": {
     "start": "node server.js",
-    "test": "node --test test/run.test.js"
+    "test": "node --test test/*.test.js"
   },
   "engines": {
     "node": ">=18"

package/server.js

@@ -22,12 +22,12 @@ import { StdioServerTransport } from "@modelcontextprotocol/sdk/server/stdio.js"
 import { z } from "zod";
 import { execFile } from "node:child_process";
 import { promisify } from "node:util";
-import { readFileSync, mkdirSync, existsSync } from "node:fs";
-import { load as yamlLoad } from "js-yaml";
+import { readFileSync, existsSync } from "node:fs";
 import { homedir } from "node:os";
 import { join, dirname } from "node:path";
 import { fileURLToPath } from "node:url";
 import { exec } from "node:child_process";
+import { loadConfig, parseArgs, text, errorResult } from "./lib/helpers.js";
 
 const execFileAsync = promisify(execFile);
 const execAsync = promisify(exec);
@@ -46,30 +46,6 @@ const configBase = process.env.XDG_CONFIG_HOME || join(homedir(), ".config");
 const CONFIG_DIR = join(configBase, "mcp-obsidian-cli");
 const CONFIG_FILE = join(CONFIG_DIR, "config.yaml");
 
-function loadConfig() {
-  const defaults = { vault: "", cliPath: "obsidian", timeoutMs: 15000 };
-  let config = { ...defaults };
-
-  if (existsSync(CONFIG_FILE)) {
-    try {
-      const content = readFileSync(CONFIG_FILE, "utf8");
-      const fileConfig = yamlLoad(content);
-      if (fileConfig) {
-        if (fileConfig.vault) config.vault = fileConfig.vault;
-        if (fileConfig.cliPath) config.cliPath = fileConfig.cliPath;
-        if (fileConfig.timeoutMs) config.timeoutMs = fileConfig.timeoutMs;
-      }
-    } catch (err) {
-      console.error("Warning: failed to load config file:", err.message);
-    }
-  }
-
-  if (process.env.OBSIDIAN_VAULT) config.vault = process.env.OBSIDIAN_VAULT;
-  if (process.env.OBSIDIAN_CLI_PATH) config.cliPath = process.env.OBSIDIAN_CLI_PATH;
-  if (process.env.OBSIDIAN_TIMEOUT_MS) config.timeoutMs = parseInt(process.env.OBSIDIAN_TIMEOUT_MS, 10);
-
-  return config;
-}
 
 const KNOWN_CLI_PATHS = [
   "/Applications/Obsidian.app/Contents/MacOS/obsidian",
@@ -100,35 +76,20 @@ async function resolveCliPath(configured) {
   return configured;
 }
 
-const config = loadConfig();
+const config = loadConfig(CONFIG_FILE);
 const CLI = await resolveCliPath(config.cliPath);
 const VAULT = config.vault;
 const TIMEOUT_MS = config.timeoutMs;
 
 async function checkObsidianRunning() {
   try {
-    const { stdout: psOut } = await execAsync("ps aux | grep -i obsidian | grep -v grep | grep -v Helper", { timeout: 2000 });
-    const obsidianRunning = psOut.includes("/Applications/Obsidian.app");
-    if (!obsidianRunning) {
-      return { running: false, version: null };
-    }
-    const { stdout } = await execFileAsync(CLI, ["version"], { timeout: 2000 });
-    const hasStartupMsg = stdout.includes("Loaded updated app package") || 
-                          stdout.includes("Checking for update") ||
-                          stdout.includes("App is up to date") ||
-                          stdout.includes("Latest version is");
-    if (hasStartupMsg) {
-      return { running: false, version: null };
-    }
-    if (stdout.includes("(installer")) {
-      const match = stdout.match(/(\d+\.\d+\.\d+)/);
-      if (match) {
-        return { running: true, version: match[1] };
-      }
-    }
-    return { running: false, version: null };
-  } catch (err) {
-    return { running: false, version: null };
+    const { stdout } = await execAsync(
+      "ps aux | grep -i obsidian | grep -v grep | grep -v Helper",
+      { timeout: 2000 }
+    );
+    return stdout.includes("/Applications/Obsidian.app");
+  } catch {
+    return false;
   }
 }
 
@@ -140,8 +101,8 @@ async function checkObsidianRunning() {
  * Run the Obsidian CLI with the given argument string.
  * Returns { stdout, stderr } or throws on non-zero exit / timeout.
  */
-async function run(argString) {
-  const args = parseArgs(argString);
+async function run(input) {
+  const args = Array.isArray(input) ? [...input] : parseArgs(input);
   if (VAULT) args.push(`vault=${VAULT}`);
 
   try {
@@ -177,35 +138,10 @@ async function run(argString) {
   }
 }
 
-/**
- * Minimal arg parser: splits on whitespace but respects key="value with spaces".
- */
-function parseArgs(str) {
-  const args = [];
-  const re = /(?:[^\s"]+|"[^"]*")+/g;
-  let m;
-  while ((m = re.exec(str)) !== null) {
-    args.push(m[0]);
-  }
-  return args;
-}
-
-/** Standard MCP text result. */
-function text(content) {
-  return { content: [{ type: "text", text: content }] };
-}
-
-/** Standard MCP error result. */
-function errorResult(content, code = "EXECUTION_ERROR") {
-  return {
-    content: [{ type: "text", text: content }],
-    isError: true,
-  };
-}
 
-/** Run CLI, return MCP result. */
-async function runTool(argString) {
-  const { stdout, stderr, error } = await run(argString);
+/** Run CLI, return MCP result. Accepts a command string or an args array. */
+async function runTool(input) {
+  const { stdout, stderr, error } = await run(input);
   if (error) {
     return errorResult(error.message, error.type);
   }
@@ -221,7 +157,7 @@ async function runTool(argString) {
 
 const server = new McpServer({
   name: "obsidian-mcp",
-  version: "1.1.0",
+  version: "1.2.0",
   capabilities: { tools: {} },
 });
 
@@ -263,7 +199,7 @@ server.tool(
   "obsidian_daily_append",
   "Append content to today's daily note.\n\nParameters:\n  content (required) — markdown text to append at the end of today's daily note\n\nExamples:\n  obsidian_daily_append({ content: \"- Meeting with team at 3pm\" })\n  obsidian_daily_append({ content: \"> [!tip] Remember\\n> Review PR before EOD\" })",
   { content: z.string().describe("Content to append") },
-  async ({ content }) => runTool(`daily:append content="${content.replace(/"/g, '\\"')}"`),
+  async ({ content }) => runTool(["daily:append", `content=${content}`]),
 );
 
 server.tool(
@@ -275,8 +211,10 @@ server.tool(
   },
   async ({ file, path }) => {
     if (!file && !path) return text("Error: provide file= or path=");
-    const arg = file ? `file="${file}"` : `path="${path}"`;
-    return runTool(`read ${arg}`);
+    const args = ["read"];
+    if (file) args.push(`file=${file}`);
+    if (path) args.push(`path=${path}`);
+    return runTool(args);
   },
 );
 
@@ -289,10 +227,10 @@ server.tool(
     limit: z.number().optional().describe("Max files to return"),
   },
   async ({ query, path, limit }) => {
-    let cmd = `search:context query="${query.replace(/"/g, '\\"')}"`;
-    if (path) cmd += ` path="${path}"`;
-    if (limit) cmd += ` limit=${limit}`;
-    return runTool(cmd);
+    const args = ["search:context", `query=${query}`];
+    if (path) args.push(`path=${path}`);
+    if (limit) args.push(`limit=${limit}`);
+    return runTool(args);
   },
 );
 
@@ -303,9 +241,9 @@ server.tool(
     sort: z.enum(["name", "count"]).optional().describe("Sort order"),
   },
   async ({ sort }) => {
-    let cmd = "tags counts";
-    if (sort) cmd += ` sort=${sort}`;
-    return runTool(cmd);
+    const args = ["tags", "counts"];
+    if (sort) args.push(`sort=${sort}`);
+    return runTool(args);
   },
 );
 
@@ -319,12 +257,12 @@ server.tool(
     path: z.string().optional().describe("Filter by file path"),
   },
   async ({ daily, todo, done, path }) => {
-    let cmd = "tasks";
-    if (daily) cmd += " daily";
-    if (todo) cmd += " todo";
-    if (done) cmd += " done";
-    if (path) cmd += ` path="${path}"`;
-    return runTool(cmd);
+    const args = ["tasks"];
+    if (daily) args.push("daily");
+    if (todo) args.push("todo");
+    if (done) args.push("done");
+    if (path) args.push(`path=${path}`);
+    return runTool(args);
   },
 );
 
@@ -338,15 +276,16 @@ server.tool(
   },
   async ({ file, path, name }) => {
     if (name && (file || path)) {
-      // Read a specific property from a specific file
-      const target = file ? `file="${file}"` : `path="${path}"`;
-      return runTool(`property:read name="${name}" ${target}`);
+      const args = ["property:read", `name=${name}`];
+      if (file) args.push(`file=${file}`);
+      if (path) args.push(`path=${path}`);
+      return runTool(args);
     }
-    let cmd = "properties";
-    if (file) cmd += ` file="${file}"`;
-    if (path) cmd += ` path="${path}"`;
-    cmd += " counts";
-    return runTool(cmd);
+    const args = ["properties"];
+    if (file) args.push(`file=${file}`);
+    if (path) args.push(`path=${path}`);
+    args.push("counts");
+    return runTool(args);
   },
 );
 
@@ -360,12 +299,12 @@ server.tool(
     template: z.string().optional().describe("Template to use"),
   },
   async ({ name, path, content, template }) => {
-    let cmd = "create";
-    if (name) cmd += ` name="${name}"`;
-    if (path) cmd += ` path="${path}"`;
-    if (template) cmd += ` template="${template}"`;
-    if (content) cmd += ` content="${content.replace(/"/g, '\\"')}"`;
-    return runTool(cmd);
+    const args = ["create"];
+    if (name) args.push(`name=${name}`);
+    if (path) args.push(`path=${path}`);
+    if (template) args.push(`template=${template}`);
+    if (content) args.push(`content=${content}`);
+    return runTool(args);
   },
 );
 
@@ -379,9 +318,11 @@ server.tool(
     path: z.string().optional().describe("File path"),
   },
   async ({ name, value, file, path: filePath }) => {
-    const target = file ? `file="${file}"` : filePath ? `path="${filePath}"` : "";
-    if (!target) return text("Error: provide file= or path=");
-    return runTool(`property:set name="${name}" value="${value.replace(/"/g, '\\"')}" ${target}`);
+    if (!file && !filePath) return text("Error: provide file= or path=");
+    const args = ["property:set", `name=${name}`, `value=${value}`];
+    if (file) args.push(`file=${file}`);
+    if (filePath) args.push(`path=${filePath}`);
+    return runTool(args);
   },
 );
 
@@ -393,8 +334,11 @@ server.tool(
     path: z.string().optional().describe("File path"),
   },
   async ({ file, path }) => {
-    const target = file ? `file="${file}"` : path ? `path="${path}"` : "";
-    return runTool(`backlinks ${target} counts`);
+    const args = ["backlinks"];
+    if (file) args.push(`file=${file}`);
+    if (path) args.push(`path=${path}`);
+    args.push("counts");
+    return runTool(args);
   },
 );
 
@@ -406,10 +350,10 @@ server.tool(
     ext: z.string().optional().describe("Filter by extension"),
   },
   async ({ folder, ext }) => {
-    let cmd = "files";
-    if (folder) cmd += ` folder="${folder}"`;
-    if (ext) cmd += ` ext=${ext}`;
-    return runTool(cmd);
+    const args = ["files"];
+    if (folder) args.push(`folder=${folder}`);
+    if (ext) args.push(`ext=${ext}`);
+    return runTool(args);
   },
 );
 
@@ -464,13 +408,13 @@ for (const [name, content] of Object.entries(promptContent)) {
 // ---- Start ---------------------------------------------------------------
 
 async function main() {
-  const { running, version } = await checkObsidianRunning();
+  const running = await checkObsidianRunning();
   if (!running) {
     console.error("Error: Obsidian is not running. Please open Obsidian and try again.");
     process.exit(1);
   }
   const transport = new StdioServerTransport();
-  console.error(`obsidian-mcp server running on stdio (Obsidian ${version})`);
+  console.error("obsidian-mcp server running on stdio");
   await server.connect(transport);
 }