searchWithJsonLogic
Search Obsidian notes using JsonLogic queries to filter metadata and content with structured logical conditions in JSON format.
Instructions
Search Obsidian notes using JsonLogic format queries. Using logical conditions expressed in JSON, you can flexibly filter note metadata and content. Suitable for programmatically generated searches, allowing complex conditions to be expressed in a structured way.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| query | Yes | JsonLogic query object. Express logical conditions in JSON format for advanced note searching. Basic Concept: JsonLogic is a specification for expressing logical conditions in JSON format. Each condition is expressed in the form {"operator": [arg1, arg2, ...]}. In Obsidian search, you can specify conditions for note metadata fields. Main Operators: 1. Common comparison operators: - "==", "===": Equality (e.g., {"==": [{"var": "rating"}, 5]}) - "!=", "!==": Inequality - ">", ">=", "<", "<=": Magnitude comparison 2. Logical operators: - "and": All conditions are true (e.g., {"and": [condition1, condition2]}) - "or": At least one condition is true - "!": Negation of a condition 3. Obsidian-specific operators: - "glob": Glob pattern matching (e.g., {"glob": [{"var": "file.path"}, "*.md"]}) - "regexp": Regular expression matching (e.g., {"regexp": ["^task.*", {"var": "file.name"}]}) 4. Data access: - "var": Get the value of a field (e.g., {"var": "frontmatter.tags"}) Basic Structure: { "operator": [ {"var": "field name"}, comparison value ] } Or compound conditions: { "and/or": [ {condition1}, {condition2}, ... ] } Usage Examples: 1. Search for notes with a specific tag: { "in": ["project", {"var": "tags"}] } 2. Search for notes where a specific frontmatter field equals a specific value: { "==": [{"var": "frontmatter.status"}, "in progress"] } 3. Search for notes with a specific URL pattern: { "glob": [{"var": "frontmatter.url"}, "https://example.com/*"] } 4. Combination of multiple conditions - notes with a specific tag and due date before today: { "and": [ {"in": ["task", {"var": "tags"}]}, {"<=": [{"var": "frontmatter.due"}, "2023-12-31"]} ] } 5. Complex example - notes in a specific folder and having a specific status or matching a specific URL pattern: { "and": [ {"glob": [{"var": "file.path"}, "projects/*"]}, {"or": [ {"==": [{"var": "frontmatter.status"}, "important"]}, {"glob": [{"var": "frontmatter.url"}, "https://github.com/*"]} ]} ] } Notes: - Field names specified with "var" must match the actual metadata structure of notes - If a field doesn't exist, the condition is not ignored but evaluated as false - Date comparisons are treated as strings, so using ISO format (YYYY-MM-DD) is safest - File properties include file.path, file.name, file.size, file.ctime, file.mtime, etc. - Frontmatter fields can be accessed with frontmatter.fieldname - The "in" operator is useful for array-type fields (such as tags) |
Implementation Reference
- src/server.ts:78-84 (registration)Registers the searchWithJsonLogic tool with the MCP server, providing the tool definition and handler function.
// 5. searchWithJsonLogic - Search with WithJsonLogic this.server.tool( advancedSearchJsonLogicDefinition.name, advancedSearchJsonLogicDefinition.description, advancedSearchJsonLogicDefinition.schema, createAdvancedSearchJsonLogicTool(this.api) ); - src/tools/advanced-search.ts:169-175 (schema)Tool definition object for 'searchWithJsonLogic' including the input schema (AdvancedSearchJsonLogicSchema), description, and name.
export const advancedSearchJsonLogicDefinition: ToolDefinition = { name: "searchWithJsonLogic", description: `Search Obsidian notes using JsonLogic format queries. Using logical conditions expressed in JSON, you can flexibly filter note metadata and content. Suitable for programmatically generated searches, allowing complex conditions to be expressed in a structured way.`, schema: AdvancedSearchJsonLogicSchema, }; - src/tools/advanced-search.ts:201-215 (handler)Handler factory that creates the execution function for the searchWithJsonLogic tool, which calls the ObsidianAPI and formats the response.
export function createAdvancedSearchJsonLogicTool( api: ObsidianAPI ): ToolHandler { return async (params: { query: object }): Promise<ToolResponse> => { try { const { query } = params; const results = await api.searchWithJsonLogic(query); return formatSuccessResponse({ results }); } catch (error) { return formatErrorResponse( `Error searching with JsonLogic: ${(error as Error).message}` ); } }; } - src/api/obsidian-api.ts:165-181 (helper)Core API client method that performs the HTTP POST request to the Obsidian search endpoint using JsonLogic content type header.
async searchWithJsonLogic(query: object): Promise<AdvancedSearchResult[]> { try { const response = await this.client.post( "/search/", JSON.stringify(query), { headers: { ...this.defaultHeaders, "Content-Type": "application/vnd.olrapi.jsonlogic+json", }, } ); return response.data as AdvancedSearchResult[]; } catch (error: any) { throw error; } }