obsidian-mcp-server
Version:
Obsidian Knowledge-Management MCP (Model Context Protocol) server that enables AI agents and development tools to interact with an Obsidian vault. It provides a comprehensive suite of tools for reading, writing, searching, and managing notes, tags, and fr
26 lines (25 loc) • 1.38 kB
TypeScript
/**
* @module SearchMethods
* @description
* Methods for performing searches via the Obsidian REST API.
*/
import { RequestContext } from "../../../utils/index.js";
import { SimpleSearchResult, ComplexSearchResult, RequestFunction } from "../types.js";
/**
* Performs a simple text search across the vault.
* @param _request - The internal request function from the service instance.
* @param query - The text query string.
* @param contextLength - Number of characters surrounding each match (default 100).
* @param context - Request context.
* @returns An array of search results.
*/
export declare function searchSimple(_request: RequestFunction, query: string, contextLength: number | undefined, context: RequestContext): Promise<SimpleSearchResult[]>;
/**
* Performs a complex search using Dataview DQL or JsonLogic.
* @param _request - The internal request function from the service instance.
* @param query - The query string (DQL) or JSON object (JsonLogic).
* @param contentType - The content type header indicating the query format.
* @param context - Request context.
* @returns An array of search results.
*/
export declare function searchComplex(_request: RequestFunction, query: string | object, contentType: "application/vnd.olrapi.dataview.dql+txt" | "application/vnd.olrapi.jsonlogic+json", context: RequestContext): Promise<ComplexSearchResult[]>;