@sunub/obsidian-mcp-server 0.3.1 → 0.3.2

package/build/tools/organize_attachments/utils.js

@@ -0,0 +1,66 @@
+import { existsSync } from "node:fs";
+import { mkdir, readFile, rename, writeFile } from "node:fs/promises";
+import { basename, dirname, join } from "node:path";
+export function genreateOrganizationTasks(documents, vaultDirPath) {
+    return documents.map((doc) => async () => {
+        const docTitle = doc.frontmatter?.title || basename(doc.filePath, ".md");
+        const sanitizedTitle = docTitle.replace(/[\\?%*:|"<>]/g, "-");
+        const imageLinks = doc.imageLinks || [];
+        if (imageLinks.length === 0) {
+            return {
+                document: doc.filePath,
+                status: "skipped",
+                message: "No image links found.",
+                movedFiles: [],
+            };
+        }
+        const destinationFolder = "images";
+        const targetDir = join(destinationFolder, sanitizedTitle);
+        const targetDirFullPath = join(vaultDirPath, targetDir);
+        await mkdir(targetDirFullPath, { recursive: true });
+        const docDir = dirname(doc.filePath);
+        const movePromises = imageLinks.map(async (imageName) => {
+            const originalImagePath = join(vaultDirPath, imageName);
+            const originalImagePathInDocDir = join(docDir, imageName);
+            let sourcePath;
+            if (existsSync(originalImagePath)) {
+                sourcePath = originalImagePath;
+            }
+            else if (existsSync(originalImagePathInDocDir)) {
+                sourcePath = originalImagePathInDocDir;
+            }
+            else {
+                return { imageName, status: "error", reason: "File not found" };
+            }
+            const newImageName = basename(imageName);
+            const newImagePath = join(targetDirFullPath, newImageName);
+            const newLinkPath = join(targetDir, newImageName).replace(/\\/g, "/");
+            try {
+                await rename(sourcePath, newImagePath);
+                return {
+                    originalLink: `![[${imageName}]]`,
+                    newLink: `![[${newLinkPath}]]`,
+                    status: "moved",
+                };
+            }
+            catch (e) {
+                return { imageName, status: "error", reason: e.message };
+            }
+        });
+        const moveResults = await Promise.all(movePromises);
+        let content = await readFile(doc.filePath, "utf-8");
+        const successfullyMoved = moveResults.filter((result) => result.status === "moved");
+        for (const result of successfullyMoved) {
+            content = content.replace(result.originalLink, result.newLink);
+        }
+        await writeFile(doc.filePath, content, "utf-8");
+        return {
+            document: doc.filePath,
+            status: "success",
+            targetDirectory: targetDir,
+            movedFiles: successfullyMoved.length,
+            errors: moveResults.filter((r) => r.status === "error"),
+        };
+    });
+}
+//# sourceMappingURL=utils.js.map

package/build/tools/organize_attachments/utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.js","sourceRoot":"","sources":["../../../src/tools/organize_attachments/utils.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,SAAS,CAAC;AACrC,OAAO,EAAE,KAAK,EAAE,QAAQ,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAC;AACtE,OAAO,EAAE,QAAQ,EAAE,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AAkBpD,MAAM,UAAU,yBAAyB,CACxC,SAA0B,EAC1B,YAAoB;IAEpB,OAAO,SAAS,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,KAAK,IAAI,EAAE;QACxC,MAAM,QAAQ,GAAG,GAAG,CAAC,WAAW,EAAE,KAAK,IAAI,QAAQ,CAAC,GAAG,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAC;QACzE,MAAM,cAAc,GAAG,QAAQ,CAAC,OAAO,CAAC,eAAe,EAAE,GAAG,CAAC,CAAC;QAC9D,MAAM,UAAU,GAAG,GAAG,CAAC,UAAU,IAAI,EAAE,CAAC;QAExC,IAAI,UAAU,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YAC7B,OAAO;gBACN,QAAQ,EAAE,GAAG,CAAC,QAAQ;gBACtB,MAAM,EAAE,SAAS;gBACjB,OAAO,EAAE,uBAAuB;gBAChC,UAAU,EAAE,EAAE;aACd,CAAC;QACH,CAAC;QAED,MAAM,iBAAiB,GAAG,QAAQ,CAAC;QACnC,MAAM,SAAS,GAAG,IAAI,CAAC,iBAAiB,EAAE,cAAc,CAAC,CAAC;QAC1D,MAAM,iBAAiB,GAAG,IAAI,CAAC,YAAY,EAAE,SAAS,CAAC,CAAC;QAExD,MAAM,KAAK,CAAC,iBAAiB,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;QAEpD,MAAM,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;QAErC,MAAM,YAAY,GAAG,UAAU,CAAC,GAAG,CAClC,KAAK,EAAE,SAAS,EAAuB,EAAE;YACxC,MAAM,iBAAiB,GAAG,IAAI,CAAC,YAAY,EAAE,SAAS,CAAC,CAAC;YACxD,MAAM,yBAAyB,GAAG,IAAI,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC;YAE1D,IAAI,UAAkB,CAAC;YACvB,IAAI,UAAU,CAAC,iBAAiB,CAAC,EAAE,CAAC;gBACnC,UAAU,GAAG,iBAAiB,CAAC;YAChC,CAAC;iBAAM,IAAI,UAAU,CAAC,yBAAyB,CAAC,EAAE,CAAC;gBAClD,UAAU,GAAG,yBAAyB,CAAC;YACxC,CAAC;iBAAM,CAAC;gBACP,OAAO,EAAE,SAAS,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,gBAAgB,EAAE,CAAC;YACjE,CAAC;YAED,MAAM,YAAY,GAAG,QAAQ,CAAC,SAAS,CAAC,CAAC;YACzC,MAAM,YAAY,GAAG,IAAI,CAAC,iBAAiB,EAAE,YAAY,CAAC,CAAC;YAC3D,MAAM,WAAW,GAAG,IAAI,CAAC,SAAS,EAAE,YAAY,CAAC,CAAC,OAAO,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC;YAEtE,IAAI,CAAC;gBACJ,MAAM,MAAM,CAAC,UAAU,EAAE,YAAY,CAAC,CAAC;gBACvC,OAAO;oBACN,YAAY,EAAE,MAAM,SAAS,IAAI;oBACjC,OAAO,EAAE,MAAM,WAAW,IAAI;oBAC9B,MAAM,EAAE,OAAO;iBACf,CAAC;YACH,CAAC;YAAC,OAAO,CAAC,EAAE,CAAC;gBACZ,OAAO,EAAE,SAAS,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAG,CAAW,CAAC,OAAO,EAAE,CAAC;YACrE,CAAC;QACF,CAAC,CACD,CAAC;QAEF,MAAM,WAAW,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC;QAEpD,IAAI,OAAO,GAAG,MAAM,QAAQ,CAAC,GAAG,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;QACpD,MAAM,iBAAiB,GAAG,WAAW,CAAC,MAAM,CAC3C,CAAC,MAAM,EAAyB,EAAE,CAAC,MAAM,CAAC,MAAM,KAAK,OAAO,CAC5D,CAAC;QAEF,KAAK,MAAM,MAAM,IAAI,iBAAiB,EAAE,CAAC;YACxC,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC,MAAM,CAAC,YAAY,EAAE,MAAM,CAAC,OAAO,CAAC,CAAC;QAChE,CAAC;QAED,MAAM,SAAS,CAAC,GAAG,CAAC,QAAQ,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;QAEhD,OAAO;YACN,QAAQ,EAAE,GAAG,CAAC,QAAQ;YACtB,MAAM,EAAE,SAAS;YACjB,eAAe,EAAE,SAAS;YAC1B,UAAU,EAAE,iBAAiB,CAAC,MAAM;YACpC,MAAM,EAAE,WAAW,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,MAAM,KAAK,OAAO,CAAC;SACvD,CAAC;IACH,CAAC,CAAC,CAAC;AACJ,CAAC"}

package/build/tools/vault/index.d.ts

@@ -0,0 +1,50 @@
+import type { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js";
+import type { CallToolResult, ToolAnnotations } from "@modelcontextprotocol/sdk/types.js";
+import { type ObsidianContentQueryParams } from "./params.js";
+export declare const name = "vault";
+export declare const annotations: ToolAnnotations;
+export declare const description = "\n  Retrieves and searches the content of Markdown (.md, .mdx) documents stored in an Obsidian vault. Use this tool to find notes related to a specific topic or keyword and understand their core content.\n\n  When to use:\n  - When you need to find a specific note by its title or a keyword to check its content.\n  - When you want to synthesize and summarize information scattered across multiple notes.\n  - When looking for answers to questions based on your saved records, such as \"What was the project deadline?\"\n  - To discover connections by finding all notes that link to a specific note.\n  - When you need to retrieve a list of unfinished tasks (- [ ]) from daily notes or meeting minutes.\n  - Use \"search_vault_by_semantic\" for natural language queries that require understanding of the meaning rather than exact keyword matches.\n  - Use \"index_vault_to_vectordb\" to manually trigger a full re-indexing of the vault for the vector database.\n\n  Returns the content of the most relevant document(s) in text format. It can also include metadata such as the document's title, tags, and creation date.\n\n  Requirements: The user's Obsidian Vault path must be correctly configured in an environment variable or a similar setting. For searches, use the exact filename or include core keywords for content-based queries.\n";
+export declare const register: (mcpServer: McpServer) => void;
+export declare const execute: (params: ObsidianContentQueryParams) => Promise<CallToolResult>;
+export declare const shorthandDescription: {
+    ko: string;
+    en: string;
+};
+declare const _default: {
+    name: string;
+    description: string;
+    annotations: {
+        title?: string | undefined;
+        readOnlyHint?: boolean | undefined;
+        destructiveHint?: boolean | undefined;
+        idempotentHint?: boolean | undefined;
+        openWorldHint?: boolean | undefined;
+    };
+    inputSchema: {
+        action: import("zod").ZodEnum<["search", "read", "list_all", "stats", "collect_context", "load_memory", "search_vault_by_semantic", "index_vault_to_vectordb"]>;
+        keyword: import("zod").ZodOptional<import("zod").ZodString>;
+        query: import("zod").ZodOptional<import("zod").ZodString>;
+        filename: import("zod").ZodOptional<import("zod").ZodString>;
+        limit: import("zod").ZodOptional<import("zod").ZodNumber>;
+        includeContent: import("zod").ZodOptional<import("zod").ZodDefault<import("zod").ZodBoolean>>;
+        includeFrontmatter: import("zod").ZodOptional<import("zod").ZodDefault<import("zod").ZodBoolean>>;
+        excerptLength: import("zod").ZodOptional<import("zod").ZodDefault<import("zod").ZodNumber>>;
+        topic: import("zod").ZodOptional<import("zod").ZodString>;
+        scope: import("zod").ZodOptional<import("zod").ZodDefault<import("zod").ZodEnum<["topic", "all"]>>>;
+        maxDocs: import("zod").ZodOptional<import("zod").ZodDefault<import("zod").ZodNumber>>;
+        maxCharsPerDoc: import("zod").ZodOptional<import("zod").ZodDefault<import("zod").ZodNumber>>;
+        memoryMode: import("zod").ZodOptional<import("zod").ZodDefault<import("zod").ZodEnum<["response_only", "vault_note", "both"]>>>;
+        continuationToken: import("zod").ZodOptional<import("zod").ZodString>;
+        memoryPath: import("zod").ZodOptional<import("zod").ZodString>;
+        compressionMode: import("zod").ZodOptional<import("zod").ZodDefault<import("zod").ZodEnum<["aggressive", "balanced", "none"]>>>;
+        maxOutputChars: import("zod").ZodOptional<import("zod").ZodNumber>;
+        quiet: import("zod").ZodOptional<import("zod").ZodDefault<import("zod").ZodBoolean>>;
+    };
+    execute: (params: ObsidianContentQueryParams) => Promise<CallToolResult>;
+    register: (mcpServer: McpServer) => void;
+    shorthandDescription: {
+        ko: string;
+        en: string;
+    };
+};
+export default _default;

package/build/tools/vault/index.js

@@ -1,4 +1,4 @@
-import state from "@/config.js";
+import state from "../../config.js";
 import { createToolError } from "../../utils/createToolError.js";
 import { getGlobalVaultManager } from "../../utils/getVaultManager.js";
 import { recordVaultResponseMetric } from "./metrics.js";

package/build/tools/vault/metrics.d.ts

@@ -0,0 +1,25 @@
+import type { CallToolResult } from "@modelcontextprotocol/sdk/types.js";
+type VaultAction = "search" | "read" | "list_all" | "stats" | "collect_context" | "load_memory" | "search_vault_by_semantic" | "index_vault_to_vectordb";
+type CompressionSummary = {
+    mode: "aggressive" | "balanced" | "none";
+    estimated_tokens: number;
+    truncated: boolean;
+    output_chars: number;
+    source_chars: number;
+    max_output_chars: number | null;
+};
+export type VaultResponseMetric = {
+    timestamp: string;
+    action: VaultAction;
+    mode: CompressionSummary["mode"];
+    estimated_tokens: number;
+    truncated: boolean;
+    doc_count: number;
+    output_chars: number;
+    source_chars: number;
+    max_output_chars: number | null;
+    cache_hit?: boolean;
+};
+export declare function buildVaultResponseMetric(action: VaultAction, result: CallToolResult): VaultResponseMetric | null;
+export declare function recordVaultResponseMetric(action: VaultAction, result: CallToolResult): Promise<void>;
+export {};

package/build/tools/vault/metrics.js

@@ -0,0 +1,130 @@
+import { appendFile, mkdir } from "node:fs/promises";
+import { dirname } from "node:path";
+function isJsonObject(value) {
+    return !!value && typeof value === "object" && !Array.isArray(value);
+}
+function parseFirstTextPayload(result) {
+    if (!Array.isArray(result.content)) {
+        return null;
+    }
+    let textPayload = null;
+    for (const chunk of result.content) {
+        if (chunk.type !== "text") {
+            continue;
+        }
+        if (!("text" in chunk) || typeof chunk.text !== "string") {
+            continue;
+        }
+        textPayload = chunk.text;
+        break;
+    }
+    if (!textPayload)
+        return null;
+    try {
+        const parsed = JSON.parse(textPayload);
+        return isJsonObject(parsed) ? parsed : null;
+    }
+    catch {
+        return null;
+    }
+}
+function parseCompression(compression) {
+    if (!isJsonObject(compression)) {
+        return null;
+    }
+    const mode = compression["mode"];
+    const estimatedTokens = compression["estimated_tokens"];
+    const truncated = compression["truncated"];
+    const outputChars = compression["output_chars"];
+    const sourceChars = compression["source_chars"];
+    const maxOutputChars = compression["max_output_chars"];
+    if ((mode !== "aggressive" && mode !== "balanced" && mode !== "none") ||
+        typeof estimatedTokens !== "number" ||
+        typeof truncated !== "boolean" ||
+        typeof outputChars !== "number" ||
+        typeof sourceChars !== "number" ||
+        (maxOutputChars !== null && typeof maxOutputChars !== "number")) {
+        return null;
+    }
+    return {
+        mode: mode,
+        estimated_tokens: Math.max(0, Math.floor(estimatedTokens)),
+        truncated: truncated,
+        output_chars: Math.max(0, Math.floor(outputChars)),
+        source_chars: Math.max(0, Math.floor(sourceChars)),
+        max_output_chars: maxOutputChars === null
+            ? null
+            : Math.max(0, Math.floor(maxOutputChars)),
+    };
+}
+function inferDocCount(action, payload) {
+    if (Array.isArray(payload["documents"])) {
+        return payload["documents"].length;
+    }
+    if (typeof payload["documents_count"] === "number") {
+        return Math.max(0, Math.floor(payload["documents_count"]));
+    }
+    if (action === "search" && typeof payload["found"] === "number") {
+        return Math.max(0, Math.floor(payload["found"]));
+    }
+    if (action === "read" &&
+        (typeof payload["filename"] === "string" ||
+            typeof payload["fullPath"] === "string" ||
+            typeof payload["filePath"] === "string")) {
+        return 1;
+    }
+    return 0;
+}
+function parseCacheHit(payload) {
+    const cache = payload["cache"];
+    if (!isJsonObject(cache)) {
+        return undefined;
+    }
+    if (typeof cache["hit"] !== "boolean") {
+        return undefined;
+    }
+    return cache["hit"];
+}
+export function buildVaultResponseMetric(action, result) {
+    if (result.isError) {
+        return null;
+    }
+    const payload = parseFirstTextPayload(result);
+    if (!payload) {
+        return null;
+    }
+    const compression = parseCompression(payload["compression"]);
+    if (!compression) {
+        return null;
+    }
+    return {
+        timestamp: new Date().toISOString(),
+        action,
+        mode: compression.mode,
+        estimated_tokens: compression.estimated_tokens,
+        truncated: compression.truncated,
+        doc_count: inferDocCount(action, payload),
+        output_chars: compression.output_chars,
+        source_chars: compression.source_chars,
+        max_output_chars: compression.max_output_chars,
+        cache_hit: parseCacheHit(payload),
+    };
+}
+export async function recordVaultResponseMetric(action, result) {
+    const logPath = process.env["VAULT_METRICS_LOG_PATH"]?.trim();
+    if (!logPath) {
+        return;
+    }
+    const metric = buildVaultResponseMetric(action, result);
+    if (!metric) {
+        return;
+    }
+    try {
+        await mkdir(dirname(logPath), { recursive: true });
+        await appendFile(logPath, `${JSON.stringify(metric)}\n`, "utf8");
+    }
+    catch {
+        // Metrics logging should never fail tool execution.
+    }
+}
+//# sourceMappingURL=metrics.js.map

package/build/tools/vault/metrics.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"metrics.js","sourceRoot":"","sources":["../../../src/tools/vault/metrics.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,KAAK,EAAE,MAAM,kBAAkB,CAAC;AACrD,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAqCpC,SAAS,YAAY,CAAC,KAAc;IACnC,OAAO,CAAC,CAAC,KAAK,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;AACtE,CAAC;AAED,SAAS,qBAAqB,CAAC,MAAsB;IACpD,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,OAAO,CAAC,EAAE,CAAC;QACpC,OAAO,IAAI,CAAC;IACb,CAAC;IAED,IAAI,WAAW,GAAkB,IAAI,CAAC;IACtC,KAAK,MAAM,KAAK,IAAI,MAAM,CAAC,OAAO,EAAE,CAAC;QACpC,IAAI,KAAK,CAAC,IAAI,KAAK,MAAM,EAAE,CAAC;YAC3B,SAAS;QACV,CAAC;QACD,IAAI,CAAC,CAAC,MAAM,IAAI,KAAK,CAAC,IAAI,OAAO,KAAK,CAAC,IAAI,KAAK,QAAQ,EAAE,CAAC;YAC1D,SAAS;QACV,CAAC;QACD,WAAW,GAAG,KAAK,CAAC,IAAI,CAAC;QACzB,MAAM;IACP,CAAC;IACD,IAAI,CAAC,WAAW;QAAE,OAAO,IAAI,CAAC;IAE9B,IAAI,CAAC;QACJ,MAAM,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC;QACvC,OAAO,YAAY,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC;IAC7C,CAAC;IAAC,MAAM,CAAC;QACR,OAAO,IAAI,CAAC;IACb,CAAC;AACF,CAAC;AAED,SAAS,gBAAgB,CAAC,WAAoB;IAC7C,IAAI,CAAC,YAAY,CAAC,WAAW,CAAC,EAAE,CAAC;QAChC,OAAO,IAAI,CAAC;IACb,CAAC;IAED,MAAM,IAAI,GAAG,WAAW,CAAC,MAAM,CAAC,CAAC;IACjC,MAAM,eAAe,GAAG,WAAW,CAAC,kBAAkB,CAAC,CAAC;IACxD,MAAM,SAAS,GAAG,WAAW,CAAC,WAAW,CAAC,CAAC;IAC3C,MAAM,WAAW,GAAG,WAAW,CAAC,cAAc,CAAC,CAAC;IAChD,MAAM,WAAW,GAAG,WAAW,CAAC,cAAc,CAAC,CAAC;IAChD,MAAM,cAAc,GAAG,WAAW,CAAC,kBAAkB,CAAC,CAAC;IAEvD,IACC,CAAC,IAAI,KAAK,YAAY,IAAI,IAAI,KAAK,UAAU,IAAI,IAAI,KAAK,MAAM,CAAC;QACjE,OAAO,eAAe,KAAK,QAAQ;QACnC,OAAO,SAAS,KAAK,SAAS;QAC9B,OAAO,WAAW,KAAK,QAAQ;QAC/B,OAAO,WAAW,KAAK,QAAQ;QAC/B,CAAC,cAAc,KAAK,IAAI,IAAI,OAAO,cAAc,KAAK,QAAQ,CAAC,EAC9D,CAAC;QACF,OAAO,IAAI,CAAC;IACb,CAAC;IAED,OAAO;QACN,IAAI,EAAE,IAA0C;QAChD,gBAAgB,EAAE,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,CAAC,KAAK,CAAC,eAAyB,CAAC,CAAC;QACpE,SAAS,EAAE,SAAoB;QAC/B,YAAY,EAAE,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,CAAC,KAAK,CAAC,WAAqB,CAAC,CAAC;QAC5D,YAAY,EAAE,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,CAAC,KAAK,CAAC,WAAqB,CAAC,CAAC;QAC5D,gBAAgB,EACf,cAAc,KAAK,IAAI;YACtB,CAAC,CAAC,IAAI;YACN,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,CAAC,KAAK,CAAC,cAAwB,CAAC,CAAC;KACrD,CAAC;AACH,CAAC;AAED,SAAS,aAAa,CAAC,MAAmB,EAAE,OAAmB;IAC9D,IAAI,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC,EAAE,CAAC;QACzC,OAAQ,OAAO,CAAC,WAAW,CAAe,CAAC,MAAM,CAAC;IACnD,CAAC;IAED,IAAI,OAAO,OAAO,CAAC,iBAAiB,CAAC,KAAK,QAAQ,EAAE,CAAC;QACpD,OAAO,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,iBAAiB,CAAW,CAAC,CAAC,CAAC;IACtE,CAAC;IAED,IAAI,MAAM,KAAK,QAAQ,IAAI,OAAO,OAAO,CAAC,OAAO,CAAC,KAAK,QAAQ,EAAE,CAAC;QACjE,OAAO,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,OAAO,CAAW,CAAC,CAAC,CAAC;IAC5D,CAAC;IAED,IACC,MAAM,KAAK,MAAM;QACjB,CAAC,OAAO,OAAO,CAAC,UAAU,CAAC,KAAK,QAAQ;YACvC,OAAO,OAAO,CAAC,UAAU,CAAC,KAAK,QAAQ;YACvC,OAAO,OAAO,CAAC,UAAU,CAAC,KAAK,QAAQ,CAAC,EACxC,CAAC;QACF,OAAO,CAAC,CAAC;IACV,CAAC;IAED,OAAO,CAAC,CAAC;AACV,CAAC;AAED,SAAS,aAAa,CAAC,OAAmB;IACzC,MAAM,KAAK,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;IAC/B,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC,EAAE,CAAC;QAC1B,OAAO,SAAS,CAAC;IAClB,CAAC;IACD,IAAI,OAAO,KAAK,CAAC,KAAK,CAAC,KAAK,SAAS,EAAE,CAAC;QACvC,OAAO,SAAS,CAAC;IAClB,CAAC;IACD,OAAO,KAAK,CAAC,KAAK,CAAY,CAAC;AAChC,CAAC;AAED,MAAM,UAAU,wBAAwB,CACvC,MAAmB,EACnB,MAAsB;IAEtB,IAAI,MAAM,CAAC,OAAO,EAAE,CAAC;QACpB,OAAO,IAAI,CAAC;IACb,CAAC;IAED,MAAM,OAAO,GAAG,qBAAqB,CAAC,MAAM,CAAC,CAAC;IAC9C,IAAI,CAAC,OAAO,EAAE,CAAC;QACd,OAAO,IAAI,CAAC;IACb,CAAC;IAED,MAAM,WAAW,GAAG,gBAAgB,CAAC,OAAO,CAAC,aAAa,CAAC,CAAC,CAAC;IAC7D,IAAI,CAAC,WAAW,EAAE,CAAC;QAClB,OAAO,IAAI,CAAC;IACb,CAAC;IAED,OAAO;QACN,SAAS,EAAE,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE;QACnC,MAAM;QACN,IAAI,EAAE,WAAW,CAAC,IAAI;QACtB,gBAAgB,EAAE,WAAW,CAAC,gBAAgB;QAC9C,SAAS,EAAE,WAAW,CAAC,SAAS;QAChC,SAAS,EAAE,aAAa,CAAC,MAAM,EAAE,OAAO,CAAC;QACzC,YAAY,EAAE,WAAW,CAAC,YAAY;QACtC,YAAY,EAAE,WAAW,CAAC,YAAY;QACtC,gBAAgB,EAAE,WAAW,CAAC,gBAAgB;QAC9C,SAAS,EAAE,aAAa,CAAC,OAAO,CAAC;KACjC,CAAC;AACH,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,yBAAyB,CAC9C,MAAmB,EACnB,MAAsB;IAEtB,MAAM,OAAO,GAAG,OAAO,CAAC,GAAG,CAAC,wBAAwB,CAAC,EAAE,IAAI,EAAE,CAAC;IAC9D,IAAI,CAAC,OAAO,EAAE,CAAC;QACd,OAAO;IACR,CAAC;IAED,MAAM,MAAM,GAAG,wBAAwB,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACxD,IAAI,CAAC,MAAM,EAAE,CAAC;QACb,OAAO;IACR,CAAC;IAED,IAAI,CAAC;QACJ,MAAM,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;QACnD,MAAM,UAAU,CAAC,OAAO,EAAE,GAAG,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;IAClE,CAAC;IAAC,MAAM,CAAC;QACR,oDAAoD;IACrD,CAAC;AACF,CAAC"}

package/build/tools/vault/params.d.ts

@@ -36,39 +36,39 @@ export declare const obsidianContentQueryParamsZod: z.ZodObject<{
     maxOutputChars: z.ZodOptional<z.ZodNumber>;
     quiet: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
 }, "strip", z.ZodTypeAny, {
-    action: "search" | "collect_context" | "stats" | "read" | "list_all" | "load_memory" | "search_vault_by_semantic" | "index_vault_to_vectordb";
+    action: "search" | "read" | "list_all" | "stats" | "collect_context" | "load_memory" | "search_vault_by_semantic" | "index_vault_to_vectordb";
     quiet?: boolean | undefined;
     filename?: string | undefined;
     keyword?: string | undefined;
     topic?: string | undefined;
-    scope?: "topic" | "all" | undefined;
-    maxDocs?: number | undefined;
-    maxCharsPerDoc?: number | undefined;
-    memoryMode?: "response_only" | "vault_note" | "both" | undefined;
     query?: string | undefined;
     limit?: number | undefined;
     includeContent?: boolean | undefined;
     includeFrontmatter?: boolean | undefined;
     excerptLength?: number | undefined;
+    scope?: "topic" | "all" | undefined;
+    maxDocs?: number | undefined;
+    maxCharsPerDoc?: number | undefined;
+    memoryMode?: "response_only" | "vault_note" | "both" | undefined;
     continuationToken?: string | undefined;
     memoryPath?: string | undefined;
     compressionMode?: "aggressive" | "balanced" | "none" | undefined;
     maxOutputChars?: number | undefined;
 }, {
-    action: "search" | "collect_context" | "stats" | "read" | "list_all" | "load_memory" | "search_vault_by_semantic" | "index_vault_to_vectordb";
+    action: "search" | "read" | "list_all" | "stats" | "collect_context" | "load_memory" | "search_vault_by_semantic" | "index_vault_to_vectordb";
     quiet?: boolean | undefined;
     filename?: string | undefined;
     keyword?: string | undefined;
     topic?: string | undefined;
-    scope?: "topic" | "all" | undefined;
-    maxDocs?: number | undefined;
-    maxCharsPerDoc?: number | undefined;
-    memoryMode?: "response_only" | "vault_note" | "both" | undefined;
     query?: string | undefined;
     limit?: number | undefined;
     includeContent?: boolean | undefined;
     includeFrontmatter?: boolean | undefined;
     excerptLength?: number | undefined;
+    scope?: "topic" | "all" | undefined;
+    maxDocs?: number | undefined;
+    maxCharsPerDoc?: number | undefined;
+    memoryMode?: "response_only" | "vault_note" | "both" | undefined;
     continuationToken?: string | undefined;
     memoryPath?: string | undefined;
     compressionMode?: "aggressive" | "balanced" | "none" | undefined;
@@ -80,12 +80,12 @@ export declare const aiInstructionsSchema: z.ZodObject<{
     usage: z.ZodString;
     content_type: z.ZodString;
 }, "strip", z.ZodTypeAny, {
-    usage: string;
     purpose: string;
+    usage: string;
     content_type: string;
 }, {
-    usage: string;
     purpose: string;
+    usage: string;
     content_type: string;
 }>;
 export declare const metadataSchema: z.ZodObject<{

package/build/tools/vault/params.js

@@ -0,0 +1,148 @@
+import { z } from "zod";
+export const responseTypeSchema = z
+    .enum(["text", "audio", "image", "resource", "resource_link"])
+    .describe("The type of content being returned");
+export const compressionModeSchema = z
+    .enum(["aggressive", "balanced", "none"])
+    .default("balanced")
+    .describe("Compression strategy for tool output. aggressive: smallest output, balanced: default, none: keep as much original content as possible.");
+const maxOutputCharsSchema = z
+    .number()
+    .min(500)
+    .max(12000)
+    .describe("Optional hard cap for output size in characters. Helps control token cost in long responses.");
+const quietMode = z
+    .boolean()
+    .default(true)
+    .describe("If true, suppresses non-error output messages. Default is false.");
+// input properties schema
+export const obsidianContentActions = z
+    .enum([
+    "search",
+    "read",
+    "list_all",
+    "stats",
+    "collect_context",
+    "load_memory",
+    "search_vault_by_semantic",
+    "index_vault_to_vectordb",
+])
+    .describe("The action to perform: search documents, read specific file, list all content, get stats, collect contextual memory packets, load stored memory, semantic search, or trigger indexing");
+export const obsidianContentKeyword = z
+    .string()
+    .describe("Keyword to search for in documents (required for search action)");
+export const obsidianContentQuery = z
+    .string()
+    .describe("Natural language query for semantic search (required for search_vault_by_semantic action)");
+export const obsidianContentFilename = z
+    .string()
+    .describe("Specific filename to read (required for read action)");
+export const obsidianContentLimit = z
+    .number()
+    .min(1)
+    .max(100)
+    .describe("Maximum number of results to return (default: 10 for search, unlimited for others)");
+export const obsidianContentIncludeContent = z
+    .boolean()
+    .default(true)
+    .describe("Whether to include document content in search results (default: true)");
+export const obsidianContentIncludeFrontmatter = z
+    .boolean()
+    .default(false)
+    .describe("Whether to include frontmatter metadata in results (default: false)");
+export const obsidianContentExcerptLength = z
+    .number()
+    .min(100)
+    .max(2000)
+    .default(500)
+    .describe("Length of content excerpt to include in search results (default: 500)");
+export const obsidianContentTopic = z
+    .string()
+    .min(1)
+    .describe("Topic to collect contextual memory for (collect_context action)");
+export const obsidianContentScope = z
+    .enum(["topic", "all"])
+    .default("topic")
+    .describe("Scope for collect_context. topic: collect docs relevant to topic, all: collect from the entire vault.");
+export const obsidianContentMaxDocs = z
+    .number()
+    .int()
+    .min(1)
+    .max(100)
+    .default(20)
+    .describe("Maximum number of documents to process for collect_context");
+export const obsidianContentMaxCharsPerDoc = z
+    .number()
+    .int()
+    .min(200)
+    .max(8000)
+    .default(1800)
+    .describe("Maximum number of characters extracted per document for collect_context");
+export const obsidianContentMemoryMode = z
+    .enum(["response_only", "vault_note", "both"])
+    .default("response_only")
+    .describe("Memory output mode for collect_context. response_only: return packet only, vault_note: save to vault note only, both: return and save.");
+export const obsidianContentContinuationToken = z
+    .string()
+    .min(1)
+    .describe("Continuation token to resume a previous collect_context batch operation");
+export const obsidianContentMemoryPath = z
+    .string()
+    .describe("Path to a stored memory note for load_memory (default: memory/context_memory_snapshot.v1.md)");
+// input schema
+export const obsidianContentQueryParamsZod = z.object({
+    action: obsidianContentActions,
+    keyword: obsidianContentKeyword.optional(),
+    query: obsidianContentQuery.optional(),
+    filename: obsidianContentFilename.optional(),
+    limit: obsidianContentLimit.optional(),
+    includeContent: obsidianContentIncludeContent.optional(),
+    includeFrontmatter: obsidianContentIncludeFrontmatter.optional(),
+    excerptLength: obsidianContentExcerptLength.optional(),
+    topic: obsidianContentTopic.optional(),
+    scope: obsidianContentScope.optional(),
+    maxDocs: obsidianContentMaxDocs.optional(),
+    maxCharsPerDoc: obsidianContentMaxCharsPerDoc.optional(),
+    memoryMode: obsidianContentMemoryMode.optional(),
+    continuationToken: obsidianContentContinuationToken.optional(),
+    memoryPath: obsidianContentMemoryPath.optional(),
+    compressionMode: compressionModeSchema.optional(),
+    maxOutputChars: maxOutputCharsSchema.optional(),
+    quiet: quietMode.optional(),
+});
+export const aiInstructionsSchema = z
+    .object({
+    purpose: z
+        .string()
+        .describe("The purpose of providing this content to the AI"),
+    usage: z.string().describe("How the AI should use this content"),
+    content_type: z
+        .string()
+        .describe("The format of the content, e.g., markdown"),
+})
+    .describe("Instructions for AI on how to process the document content");
+export const metadataSchema = z
+    .object({
+    fullPath: z.string().describe("The full path to the file in the vault"),
+    title: z
+        .string()
+        .nullable()
+        .describe("The title of the document, if available"),
+    tags: z
+        .array(z.string())
+        .describe("List of tags associated with the document"),
+    category: z.string().describe("Category of the document, if available"),
+    date: z
+        .string()
+        .nullable()
+        .describe("Creation date of the document in ISO 8601 format, if available"),
+    summary: z
+        .string()
+        .nullable()
+        .describe("Brief summary or abstract of the document, if available"),
+    completed: z
+        .boolean()
+        .describe("Indicates whether a task or item is completed"),
+})
+    .describe("Metadata extracted from the document frontmatter, if available");
+//# sourceMappingURL=params.js.map

package/build/tools/vault/params.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"params.js","sourceRoot":"","sources":["../../../src/tools/vault/params.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,MAAM,CAAC,MAAM,kBAAkB,GAAG,CAAC;KACjC,IAAI,CAAC,CAAC,MAAM,EAAE,OAAO,EAAE,OAAO,EAAE,UAAU,EAAE,eAAe,CAAC,CAAC;KAC7D,QAAQ,CAAC,oCAAoC,CAAC,CAAC;AAEjD,MAAM,CAAC,MAAM,qBAAqB,GAAG,CAAC;KACpC,IAAI,CAAC,CAAC,YAAY,EAAE,UAAU,EAAE,MAAM,CAAC,CAAC;KACxC,OAAO,CAAC,UAAU,CAAC;KACnB,QAAQ,CACR,wIAAwI,CACxI,CAAC;AAEH,MAAM,oBAAoB,GAAG,CAAC;KAC5B,MAAM,EAAE;KACR,GAAG,CAAC,GAAG,CAAC;KACR,GAAG,CAAC,KAAK,CAAC;KACV,QAAQ,CACR,8FAA8F,CAC9F,CAAC;AAEH,MAAM,SAAS,GAAG,CAAC;KACjB,OAAO,EAAE;KACT,OAAO,CAAC,IAAI,CAAC;KACb,QAAQ,CAAC,kEAAkE,CAAC,CAAC;AAE/E,0BAA0B;AAC1B,MAAM,CAAC,MAAM,sBAAsB,GAAG,CAAC;KACrC,IAAI,CAAC;IACL,QAAQ;IACR,MAAM;IACN,UAAU;IACV,OAAO;IACP,iBAAiB;IACjB,aAAa;IACb,0BAA0B;IAC1B,yBAAyB;CACzB,CAAC;KACD,QAAQ,CACR,uLAAuL,CACvL,CAAC;AACH,MAAM,CAAC,MAAM,sBAAsB,GAAG,CAAC;KACrC,MAAM,EAAE;KACR,QAAQ,CAAC,iEAAiE,CAAC,CAAC;AAC9E,MAAM,CAAC,MAAM,oBAAoB,GAAG,CAAC;KACnC,MAAM,EAAE;KACR,QAAQ,CACR,2FAA2F,CAC3F,CAAC;AACH,MAAM,CAAC,MAAM,uBAAuB,GAAG,CAAC;KACtC,MAAM,EAAE;KACR,QAAQ,CAAC,sDAAsD,CAAC,CAAC;AACnE,MAAM,CAAC,MAAM,oBAAoB,GAAG,CAAC;KACnC,MAAM,EAAE;KACR,GAAG,CAAC,CAAC,CAAC;KACN,GAAG,CAAC,GAAG,CAAC;KACR,QAAQ,CACR,oFAAoF,CACpF,CAAC;AACH,MAAM,CAAC,MAAM,6BAA6B,GAAG,CAAC;KAC5C,OAAO,EAAE;KACT,OAAO,CAAC,IAAI,CAAC;KACb,QAAQ,CACR,uEAAuE,CACvE,CAAC;AACH,MAAM,CAAC,MAAM,iCAAiC,GAAG,CAAC;KAChD,OAAO,EAAE;KACT,OAAO,CAAC,KAAK,CAAC;KACd,QAAQ,CACR,qEAAqE,CACrE,CAAC;AACH,MAAM,CAAC,MAAM,4BAA4B,GAAG,CAAC;KAC3C,MAAM,EAAE;KACR,GAAG,CAAC,GAAG,CAAC;KACR,GAAG,CAAC,IAAI,CAAC;KACT,OAAO,CAAC,GAAG,CAAC;KACZ,QAAQ,CACR,uEAAuE,CACvE,CAAC;AACH,MAAM,CAAC,MAAM,oBAAoB,GAAG,CAAC;KACnC,MAAM,EAAE;KACR,GAAG,CAAC,CAAC,CAAC;KACN,QAAQ,CAAC,iEAAiE,CAAC,CAAC;AAC9E,MAAM,CAAC,MAAM,oBAAoB,GAAG,CAAC;KACnC,IAAI,CAAC,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;KACtB,OAAO,CAAC,OAAO,CAAC;KAChB,QAAQ,CACR,uGAAuG,CACvG,CAAC;AACH,MAAM,CAAC,MAAM,sBAAsB,GAAG,CAAC;KACrC,MAAM,EAAE;KACR,GAAG,EAAE;KACL,GAAG,CAAC,CAAC,CAAC;KACN,GAAG,CAAC,GAAG,CAAC;KACR,OAAO,CAAC,EAAE,CAAC;KACX,QAAQ,CAAC,4DAA4D,CAAC,CAAC;AACzE,MAAM,CAAC,MAAM,6BAA6B,GAAG,CAAC;KAC5C,MAAM,EAAE;KACR,GAAG,EAAE;KACL,GAAG,CAAC,GAAG,CAAC;KACR,GAAG,CAAC,IAAI,CAAC;KACT,OAAO,CAAC,IAAI,CAAC;KACb,QAAQ,CACR,yEAAyE,CACzE,CAAC;AACH,MAAM,CAAC,MAAM,yBAAyB,GAAG,CAAC;KACxC,IAAI,CAAC,CAAC,eAAe,EAAE,YAAY,EAAE,MAAM,CAAC,CAAC;KAC7C,OAAO,CAAC,eAAe,CAAC;KACxB,QAAQ,CACR,wIAAwI,CACxI,CAAC;AACH,MAAM,CAAC,MAAM,gCAAgC,GAAG,CAAC;KAC/C,MAAM,EAAE;KACR,GAAG,CAAC,CAAC,CAAC;KACN,QAAQ,CACR,yEAAyE,CACzE,CAAC;AACH,MAAM,CAAC,MAAM,yBAAyB,GAAG,CAAC;KACxC,MAAM,EAAE;KACR,QAAQ,CACR,8FAA8F,CAC9F,CAAC;AAEH,eAAe;AACf,MAAM,CAAC,MAAM,6BAA6B,GAAG,CAAC,CAAC,MAAM,CAAC;IACrD,MAAM,EAAE,sBAAsB;IAC9B,OAAO,EAAE,sBAAsB,CAAC,QAAQ,EAAE;IAC1C,KAAK,EAAE,oBAAoB,CAAC,QAAQ,EAAE;IACtC,QAAQ,EAAE,uBAAuB,CAAC,QAAQ,EAAE;IAC5C,KAAK,EAAE,oBAAoB,CAAC,QAAQ,EAAE;IACtC,cAAc,EAAE,6BAA6B,CAAC,QAAQ,EAAE;IACxD,kBAAkB,EAAE,iCAAiC,CAAC,QAAQ,EAAE;IAChE,aAAa,EAAE,4BAA4B,CAAC,QAAQ,EAAE;IACtD,KAAK,EAAE,oBAAoB,CAAC,QAAQ,EAAE;IACtC,KAAK,EAAE,oBAAoB,CAAC,QAAQ,EAAE;IACtC,OAAO,EAAE,sBAAsB,CAAC,QAAQ,EAAE;IAC1C,cAAc,EAAE,6BAA6B,CAAC,QAAQ,EAAE;IACxD,UAAU,EAAE,yBAAyB,CAAC,QAAQ,EAAE;IAChD,iBAAiB,EAAE,gCAAgC,CAAC,QAAQ,EAAE;IAC9D,UAAU,EAAE,yBAAyB,CAAC,QAAQ,EAAE;IAChD,eAAe,EAAE,qBAAqB,CAAC,QAAQ,EAAE;IACjD,cAAc,EAAE,oBAAoB,CAAC,QAAQ,EAAE;IAC/C,KAAK,EAAE,SAAS,CAAC,QAAQ,EAAE;CAC3B,CAAC,CAAC;AAMH,MAAM,CAAC,MAAM,oBAAoB,GAAG,CAAC;KACnC,MAAM,CAAC;IACP,OAAO,EAAE,CAAC;SACR,MAAM,EAAE;SACR,QAAQ,CAAC,iDAAiD,CAAC;IAC7D,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,oCAAoC,CAAC;IAChE,YAAY,EAAE,CAAC;SACb,MAAM,EAAE;SACR,QAAQ,CAAC,2CAA2C,CAAC;CACvD,CAAC;KACD,QAAQ,CAAC,4DAA4D,CAAC,CAAC;AAEzE,MAAM,CAAC,MAAM,cAAc,GAAG,CAAC;KAC7B,MAAM,CAAC;IACP,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,wCAAwC,CAAC;IACvE,KAAK,EAAE,CAAC;SACN,MAAM,EAAE;SACR,QAAQ,EAAE;SACV,QAAQ,CAAC,yCAAyC,CAAC;IACrD,IAAI,EAAE,CAAC;SACL,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;SACjB,QAAQ,CAAC,2CAA2C,CAAC;IACvD,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,wCAAwC,CAAC;IACvE,IAAI,EAAE,CAAC;SACL,MAAM,EAAE;SACR,QAAQ,EAAE;SACV,QAAQ,CACR,gEAAgE,CAChE;IACF,OAAO,EAAE,CAAC;SACR,MAAM,EAAE;SACR,QAAQ,EAAE;SACV,QAAQ,CAAC,yDAAyD,CAAC;IACrE,SAAS,EAAE,CAAC;SACV,OAAO,EAAE;SACT,QAAQ,CAAC,+CAA+C,CAAC;CAC3D,CAAC;KACD,QAAQ,CAAC,gEAAgE,CAAC,CAAC"}