@sunub/obsidian-mcp-server 0.2.0 → 0.3.1

package/build/tools/vault/index.js

@@ -1,9 +1,9 @@
-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";
 import { obsidianContentQueryParamsZod, } from "./params.js";
-import { collectContext, listAllDocuments, loadMemory, readSpecificFile, searchDocuments, statsAllDocuments, } from "./utils.js";
+import { collectContext, listAllDocuments, loadMemory, readSpecificFile, searchDocuments, searchSemantic, statsAllDocuments, triggerIndexing, } from "./utils.js";
 export const name = "vault";
 export const annotations = {
     title: "Obsidian Content Getter",
@@ -18,6 +18,8 @@ export const description = `
   - When looking for answers to questions based on your saved records, such as "What was the project deadline?"
   - To discover connections by finding all notes that link to a specific note.
   - When you need to retrieve a list of unfinished tasks (- [ ]) from daily notes or meeting minutes.
+  - Use "search_vault_by_semantic" for natural language queries that require understanding of the meaning rather than exact keyword matches.
+  - Use "index_vault_to_vectordb" to manually trigger a full re-indexing of the vault for the vector database.
 
   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.
 
@@ -71,8 +73,14 @@ export const execute = async (params) => {
             case "load_memory":
                 result = await loadMemory(vaultManager, params);
                 break;
+            case "search_vault_by_semantic":
+                result = await searchSemantic(params);
+                break;
+            case "index_vault_to_vectordb":
+                result = await triggerIndexing();
+                break;
             default:
-                return createToolError(`Unknown action: ${params.action}`, "Valid actions are: search, read, list_all, stats, collect_context, load_memory");
+                return createToolError(`Unknown action: ${params.action}`, "Valid actions are: search, read, list_all, stats, collect_context, load_memory, search_vault_by_semantic, index_vault_to_vectordb");
         }
         await recordVaultResponseMetric(params.action, result);
         return result;
@@ -81,6 +89,10 @@ export const execute = async (params) => {
         return createToolError(`Execution failed: ${error instanceof Error ? error.message : String(error)}`);
     }
 };
+export const shorthandDescription = {
+    ko: "키워드나 제목을 기반으로 설정된 Obsidian Vault 내의 Markdown 문서(.md, .mdx)를 검색하고 조회합니다. 특정 노트 확인, 정보 요약, 백링크 탐색, 미완료 할 일 추출에 사용되며 문서의 본문과 메타데이터를 반환합니다.",
+    en: "Retrieves Obsidian vault Markdown files by keyword or title to extract content, metadata, links, and unfinished tasks.",
+};
 export default {
     name,
     description,
@@ -88,4 +100,6 @@ export default {
     inputSchema: obsidianContentQueryParamsZod.shape,
     execute,
     register,
+    shorthandDescription,
 };
+//# sourceMappingURL=index.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/tools/vault/index.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,MAAM,aAAa,CAAC;AAChC,OAAO,EAAE,eAAe,EAAE,MAAM,4BAA4B,CAAC;AAC7D,OAAO,EAAE,qBAAqB,EAAE,MAAM,4BAA4B,CAAC;AACnE,OAAO,EAAE,yBAAyB,EAAE,MAAM,cAAc,CAAC;AACzD,OAAO,EAEN,6BAA6B,GAC7B,MAAM,aAAa,CAAC;AACrB,OAAO,EACN,cAAc,EACd,gBAAgB,EAChB,UAAU,EACV,gBAAgB,EAChB,eAAe,EACf,cAAc,EACd,iBAAiB,EACjB,eAAe,GACf,MAAM,YAAY,CAAC;AAEpB,MAAM,CAAC,MAAM,IAAI,GAAG,OAAO,CAAC;AAE5B,MAAM,CAAC,MAAM,WAAW,GAAoB;IAC3C,KAAK,EAAE,yBAAyB;IAChC,aAAa,EAAE,IAAI;CACnB,CAAC;AAEF,MAAM,CAAC,MAAM,WAAW,GAAG;;;;;;;;;;;;;;;CAe1B,CAAC;AAEF,MAAM,CAAC,MAAM,QAAQ,GAAG,CAAC,SAAoB,EAAE,EAAE;IAChD,SAAS,CAAC,YAAY,CACrB,IAAI,EACJ;QACC,KAAK,EAAE,WAAW,CAAC,KAAK,IAAI,IAAI;QAChC,WAAW,EAAE,WAAW;QACxB,WAAW,EAAE,6BAA6B,CAAC,KAAK;QAChD,WAAW,EAAE,WAAW;KACxB,EACD,OAAO,CACP,CAAC;AACH,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,OAAO,GAAG,KAAK,EAC3B,MAAkC,EACR,EAAE;IAC5B,MAAM,YAAY,GAAG,KAAK,CAAC,SAAS,CAAC;IAErC,cAAc;IACd,IAAI,CAAC,YAAY,EAAE,CAAC;QACnB,OAAO,eAAe,CACrB,gDAAgD,EAChD,qDAAqD,CACrD,CAAC;IACH,CAAC;IAED,IAAI,YAAY,GAAG,IAAI,CAAC;IACxB,IAAI,CAAC;QACJ,YAAY,GAAG,qBAAqB,EAAE,CAAC;IACxC,CAAC;IAAC,OAAO,CAAC,EAAE,CAAC;QACZ,OAAO,eAAe,CAAE,CAAW,CAAC,OAAO,CAAC,CAAC;IAC9C,CAAC;IAED,IAAI,CAAC;QACJ,IAAI,MAAsB,CAAC;QAC3B,QAAQ,MAAM,CAAC,MAAM,EAAE,CAAC;YACvB,KAAK,QAAQ;gBACZ,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,IAAI,EAAE,EAAE,CAAC;oBAC7B,OAAO,eAAe,CACrB,iDAAiD,EACjD,kEAAkE,CAClE,CAAC;gBACH,CAAC;gBACD,MAAM,GAAG,MAAM,eAAe,CAAC,YAAY,EAAE,MAAM,CAAC,CAAC;gBACrD,MAAM;YAEP,KAAK,MAAM;gBACV,IAAI,CAAC,MAAM,CAAC,QAAQ,EAAE,IAAI,EAAE,EAAE,CAAC;oBAC9B,OAAO,eAAe,CACrB,gDAAgD,EAChD,2EAA2E,CAC3E,CAAC;gBACH,CAAC;gBACD,MAAM,GAAG,MAAM,gBAAgB,CAAC,YAAY,EAAE,MAAM,CAAC,CAAC;gBACtD,MAAM;YAEP,KAAK,UAAU;gBACd,MAAM,GAAG,MAAM,gBAAgB,CAAC,YAAY,EAAE,MAAM,CAAC,CAAC;gBACtD,MAAM;YAEP,KAAK,OAAO;gBACX,MAAM,GAAG,MAAM,iBAAiB,CAAC,YAAY,CAAC,CAAC;gBAC/C,MAAM;YAEP,KAAK,iBAAiB;gBACrB,MAAM,GAAG,MAAM,cAAc,CAAC,YAAY,EAAE,MAAM,CAAC,CAAC;gBACpD,MAAM;YAEP,KAAK,aAAa;gBACjB,MAAM,GAAG,MAAM,UAAU,CAAC,YAAY,EAAE,MAAM,CAAC,CAAC;gBAChD,MAAM;YAEP,KAAK,0BAA0B;gBAC9B,MAAM,GAAG,MAAM,cAAc,CAAC,MAAM,CAAC,CAAC;gBACtC,MAAM;YAEP,KAAK,yBAAyB;gBAC7B,MAAM,GAAG,MAAM,eAAe,EAAE,CAAC;gBACjC,MAAM;YAEP;gBACC,OAAO,eAAe,CACrB,mBAAmB,MAAM,CAAC,MAAM,EAAE,EAClC,mIAAmI,CACnI,CAAC;QACJ,CAAC;QAED,MAAM,yBAAyB,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;QACvD,OAAO,MAAM,CAAC;IACf,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QAChB,OAAO,eAAe,CACrB,qBAAqB,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CAC7E,CAAC;IACH,CAAC;AACF,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,oBAAoB,GAAG;IACnC,EAAE,EAAE,yIAAyI;IAC7I,EAAE,EAAE,wHAAwH;CAC5H,CAAC;AAEF,eAAe;IACd,IAAI;IACJ,WAAW;IACX,WAAW;IACX,WAAW,EAAE,6BAA6B,CAAC,KAAK;IAChD,OAAO;IACP,QAAQ;IACR,oBAAoB;CACpB,CAAC"}

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

@@ -0,0 +1,115 @@
+import { z } from "zod";
+export declare const responseTypeSchema: z.ZodEnum<["text", "audio", "image", "resource", "resource_link"]>;
+export declare const compressionModeSchema: z.ZodDefault<z.ZodEnum<["aggressive", "balanced", "none"]>>;
+export declare const obsidianContentActions: z.ZodEnum<["search", "read", "list_all", "stats", "collect_context", "load_memory", "search_vault_by_semantic", "index_vault_to_vectordb"]>;
+export declare const obsidianContentKeyword: z.ZodString;
+export declare const obsidianContentQuery: z.ZodString;
+export declare const obsidianContentFilename: z.ZodString;
+export declare const obsidianContentLimit: z.ZodNumber;
+export declare const obsidianContentIncludeContent: z.ZodDefault<z.ZodBoolean>;
+export declare const obsidianContentIncludeFrontmatter: z.ZodDefault<z.ZodBoolean>;
+export declare const obsidianContentExcerptLength: z.ZodDefault<z.ZodNumber>;
+export declare const obsidianContentTopic: z.ZodString;
+export declare const obsidianContentScope: z.ZodDefault<z.ZodEnum<["topic", "all"]>>;
+export declare const obsidianContentMaxDocs: z.ZodDefault<z.ZodNumber>;
+export declare const obsidianContentMaxCharsPerDoc: z.ZodDefault<z.ZodNumber>;
+export declare const obsidianContentMemoryMode: z.ZodDefault<z.ZodEnum<["response_only", "vault_note", "both"]>>;
+export declare const obsidianContentContinuationToken: z.ZodString;
+export declare const obsidianContentMemoryPath: z.ZodString;
+export declare const obsidianContentQueryParamsZod: z.ZodObject<{
+    action: z.ZodEnum<["search", "read", "list_all", "stats", "collect_context", "load_memory", "search_vault_by_semantic", "index_vault_to_vectordb"]>;
+    keyword: z.ZodOptional<z.ZodString>;
+    query: z.ZodOptional<z.ZodString>;
+    filename: z.ZodOptional<z.ZodString>;
+    limit: z.ZodOptional<z.ZodNumber>;
+    includeContent: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
+    includeFrontmatter: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
+    excerptLength: z.ZodOptional<z.ZodDefault<z.ZodNumber>>;
+    topic: z.ZodOptional<z.ZodString>;
+    scope: z.ZodOptional<z.ZodDefault<z.ZodEnum<["topic", "all"]>>>;
+    maxDocs: z.ZodOptional<z.ZodDefault<z.ZodNumber>>;
+    maxCharsPerDoc: z.ZodOptional<z.ZodDefault<z.ZodNumber>>;
+    memoryMode: z.ZodOptional<z.ZodDefault<z.ZodEnum<["response_only", "vault_note", "both"]>>>;
+    continuationToken: z.ZodOptional<z.ZodString>;
+    memoryPath: z.ZodOptional<z.ZodString>;
+    compressionMode: z.ZodOptional<z.ZodDefault<z.ZodEnum<["aggressive", "balanced", "none"]>>>;
+    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";
+    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;
+    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";
+    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;
+    continuationToken?: string | undefined;
+    memoryPath?: string | undefined;
+    compressionMode?: "aggressive" | "balanced" | "none" | undefined;
+    maxOutputChars?: number | undefined;
+}>;
+export type ObsidianContentQueryParams = z.infer<typeof obsidianContentQueryParamsZod>;
+export declare const aiInstructionsSchema: z.ZodObject<{
+    purpose: z.ZodString;
+    usage: z.ZodString;
+    content_type: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    usage: string;
+    purpose: string;
+    content_type: string;
+}, {
+    usage: string;
+    purpose: string;
+    content_type: string;
+}>;
+export declare const metadataSchema: z.ZodObject<{
+    fullPath: z.ZodString;
+    title: z.ZodNullable<z.ZodString>;
+    tags: z.ZodArray<z.ZodString, "many">;
+    category: z.ZodString;
+    date: z.ZodNullable<z.ZodString>;
+    summary: z.ZodNullable<z.ZodString>;
+    completed: z.ZodBoolean;
+}, "strip", z.ZodTypeAny, {
+    date: string | null;
+    title: string | null;
+    tags: string[];
+    summary: string | null;
+    category: string;
+    completed: boolean;
+    fullPath: string;
+}, {
+    date: string | null;
+    title: string | null;
+    tags: string[];
+    summary: string | null;
+    category: string;
+    completed: boolean;
+    fullPath: string;
+}>;