@oomkapwn/enquire-mcp 3.7.12 → 3.7.13
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +57 -0
- package/README.md +5 -5
- package/dist/http-transport.d.ts +11 -0
- package/dist/http-transport.d.ts.map +1 -1
- package/dist/http-transport.js +34 -0
- package/dist/http-transport.js.map +1 -1
- package/dist/index.d.ts +1 -1
- package/dist/index.js +1 -1
- package/dist/pdf.d.ts +22 -1
- package/dist/pdf.d.ts.map +1 -1
- package/dist/pdf.js +9 -2
- package/dist/pdf.js.map +1 -1
- package/dist/tool-registry.d.ts.map +1 -1
- package/dist/tool-registry.js +26 -1
- package/dist/tool-registry.js.map +1 -1
- package/dist/tools/media.d.ts.map +1 -1
- package/dist/tools/media.js +15 -6
- package/dist/tools/media.js.map +1 -1
- package/dist/tools/write.d.ts.map +1 -1
- package/dist/tools/write.js +46 -10
- package/dist/tools/write.js.map +1 -1
- package/dist/vault.d.ts.map +1 -1
- package/dist/vault.js +38 -14
- package/dist/vault.js.map +1 -1
- package/docs/COMPARISON.md +1 -1
- package/docs/QUICKSTART.md +2 -2
- package/docs/api-reference/functions/index.buildEmbedText.html +1 -1
- package/docs/api-reference/functions/index.buildMcpServer.html +1 -1
- package/docs/api-reference/functions/index.formatReadyBanner.html +1 -1
- package/docs/api-reference/functions/index.main.html +1 -1
- package/docs/api-reference/functions/index.parsePositiveInt.html +1 -1
- package/docs/api-reference/functions/index.parseQuantizationMode.html +1 -1
- package/docs/api-reference/functions/index.prepareServerDeps.html +1 -1
- package/docs/api-reference/functions/index.startServer.html +1 -1
- package/docs/api-reference/functions/tools.appendToNote.html +1 -1
- package/docs/api-reference/functions/tools.archiveNote.html +1 -1
- package/docs/api-reference/functions/tools.assertHnswModelMatchesEmbedder.html +1 -1
- package/docs/api-reference/functions/tools.chatThreadAppend.html +1 -1
- package/docs/api-reference/functions/tools.chatThreadRead.html +1 -1
- package/docs/api-reference/functions/tools.contextPack.html +1 -1
- package/docs/api-reference/functions/tools.createNote.html +1 -1
- package/docs/api-reference/functions/tools.dataviewQuery.html +1 -1
- package/docs/api-reference/functions/tools.embeddingsSearch.html +1 -1
- package/docs/api-reference/functions/tools.findPath.html +1 -1
- package/docs/api-reference/functions/tools.findSimilar.html +1 -1
- package/docs/api-reference/functions/tools.frontmatterGet.html +1 -1
- package/docs/api-reference/functions/tools.frontmatterSearch.html +1 -1
- package/docs/api-reference/functions/tools.frontmatterSet.html +1 -1
- package/docs/api-reference/functions/tools.getBacklinks.html +1 -1
- package/docs/api-reference/functions/tools.getNoteNeighbors.html +1 -1
- package/docs/api-reference/functions/tools.getOpenQuestions.html +1 -1
- package/docs/api-reference/functions/tools.getOutboundLinks.html +1 -1
- package/docs/api-reference/functions/tools.getRecentEdits.html +1 -1
- package/docs/api-reference/functions/tools.getUnresolvedWikilinks.html +1 -1
- package/docs/api-reference/functions/tools.getVaultStats.html +1 -1
- package/docs/api-reference/functions/tools.lintWiki.html +1 -1
- package/docs/api-reference/functions/tools.listCanvases.html +1 -1
- package/docs/api-reference/functions/tools.listNotes.html +1 -1
- package/docs/api-reference/functions/tools.listPdfs.html +1 -1
- package/docs/api-reference/functions/tools.listTags.html +1 -1
- package/docs/api-reference/functions/tools.ocrPdf.html +1 -1
- package/docs/api-reference/functions/tools.openInUi.html +1 -1
- package/docs/api-reference/functions/tools.paperAudit.html +1 -1
- package/docs/api-reference/functions/tools.pickEmbedTextForHyde.html +1 -1
- package/docs/api-reference/functions/tools.readCanvas.html +1 -1
- package/docs/api-reference/functions/tools.readNote.html +1 -1
- package/docs/api-reference/functions/tools.readPdf.html +1 -1
- package/docs/api-reference/functions/tools.renameNote.html +1 -1
- package/docs/api-reference/functions/tools.replaceInNotes.html +1 -1
- package/docs/api-reference/functions/tools.resolveTarget.html +1 -1
- package/docs/api-reference/functions/tools.resolveWikilink.html +1 -1
- package/docs/api-reference/functions/tools.searchHybrid.html +1 -1
- package/docs/api-reference/functions/tools.searchText.html +1 -1
- package/docs/api-reference/functions/tools.semanticSearch.html +1 -1
- package/docs/api-reference/functions/tools.validateNoteProposal.html +1 -1
- package/docs/api-reference/interfaces/index.ServeOptions.html +25 -25
- package/docs/api-reference/interfaces/index.ServerDeps.html +3 -3
- package/docs/api-reference/interfaces/tool-manifest.ToolManifestEntry.html +5 -5
- package/docs/api-reference/interfaces/tools.ArchiveNoteArgs.html +5 -5
- package/docs/api-reference/interfaces/tools.BacklinkHit.html +6 -6
- package/docs/api-reference/interfaces/tools.CanvasEdge.html +8 -8
- package/docs/api-reference/interfaces/tools.CanvasSummary.html +7 -7
- package/docs/api-reference/interfaces/tools.ChatThreadAppendArgs.html +5 -5
- package/docs/api-reference/interfaces/tools.ChatThreadMessage.html +6 -6
- package/docs/api-reference/interfaces/tools.ChatThreadReadResult.html +5 -5
- package/docs/api-reference/interfaces/tools.ContextPackArgs.html +6 -6
- package/docs/api-reference/interfaces/tools.ContextPackResult.html +7 -7
- package/docs/api-reference/interfaces/tools.EmbedHit.html +9 -9
- package/docs/api-reference/interfaces/tools.EmbedSearchResponse.html +2 -2
- package/docs/api-reference/interfaces/tools.FindPathResult.html +7 -7
- package/docs/api-reference/interfaces/tools.FrontmatterSearchArgs.html +7 -7
- package/docs/api-reference/interfaces/tools.FrontmatterSetArgs.html +5 -5
- package/docs/api-reference/interfaces/tools.HnswSearchContext.html +3 -3
- package/docs/api-reference/interfaces/tools.LintWikiArgs.html +6 -6
- package/docs/api-reference/interfaces/tools.LintWikiFinding.html +6 -6
- package/docs/api-reference/interfaces/tools.LintWikiResult.html +2 -2
- package/docs/api-reference/interfaces/tools.NoteNeighbors.html +5 -5
- package/docs/api-reference/interfaces/tools.NoteReadFull.html +9 -9
- package/docs/api-reference/interfaces/tools.NoteReadMap.html +11 -11
- package/docs/api-reference/interfaces/tools.NoteSummary.html +6 -6
- package/docs/api-reference/interfaces/tools.OcrPdfArgs.html +5 -5
- package/docs/api-reference/interfaces/tools.OcrPdfPage.html +6 -6
- package/docs/api-reference/interfaces/tools.OcrPdfResult.html +4 -4
- package/docs/api-reference/interfaces/tools.OpenInUiResult.html +5 -5
- package/docs/api-reference/interfaces/tools.OpenQuestion.html +8 -8
- package/docs/api-reference/interfaces/tools.OutboundLink.html +9 -9
- package/docs/api-reference/interfaces/tools.PaperAuditFinding.html +7 -7
- package/docs/api-reference/interfaces/tools.PathStep.html +4 -4
- package/docs/api-reference/interfaces/tools.PdfSummary.html +5 -5
- package/docs/api-reference/interfaces/tools.ReadCanvasResult.html +3 -3
- package/docs/api-reference/interfaces/tools.ReadPdfArgs.html +4 -4
- package/docs/api-reference/interfaces/tools.ReadPdfPage.html +5 -5
- package/docs/api-reference/interfaces/tools.ReadPdfResult.html +3 -3
- package/docs/api-reference/interfaces/tools.RenameNoteResult.html +6 -6
- package/docs/api-reference/interfaces/tools.RenameProposal.html +5 -5
- package/docs/api-reference/interfaces/tools.ReplaceInNotesArgs.html +6 -6
- package/docs/api-reference/interfaces/tools.ReplaceInNotesFileResult.html +3 -3
- package/docs/api-reference/interfaces/tools.ReplaceInNotesResult.html +4 -4
- package/docs/api-reference/interfaces/tools.SearchHit.html +6 -6
- package/docs/api-reference/interfaces/tools.SearchHybridHit.html +9 -9
- package/docs/api-reference/interfaces/tools.SearchHybridResponse.html +6 -6
- package/docs/api-reference/interfaces/tools.SearchResponse.html +5 -5
- package/docs/api-reference/interfaces/tools.SemanticHit.html +7 -7
- package/docs/api-reference/interfaces/tools.SimilarNote.html +7 -7
- package/docs/api-reference/interfaces/tools.TagSummary.html +5 -5
- package/docs/api-reference/interfaces/tools.UnresolvedWikilink.html +10 -10
- package/docs/api-reference/interfaces/tools.ValidateProposalArgs.html +4 -4
- package/docs/api-reference/interfaces/tools.ValidateProposalResult.html +2 -2
- package/docs/api-reference/interfaces/tools.VaultStats.html +11 -11
- package/docs/api-reference/types/tools.CanvasNode.html +1 -1
- package/docs/api-reference/types/tools.SearchMode.html +1 -1
- package/docs/api-reference/variables/index.VERSION.html +1 -1
- package/docs/api-reference/variables/tool-manifest.TOOL_MANIFEST.html +1 -1
- package/docs/api.md +1 -1
- package/docs/benchmarks.md +16 -9
- package/package.json +9 -4
- package/docs/audits/findings/L1-code-quality.md +0 -213
- package/docs/audits/findings/L2-architecture.md +0 -245
- package/docs/audits/findings/L3-tests.md +0 -339
- package/docs/audits/findings/L4-cicd.md +0 -290
- package/docs/audits/findings/L5-security.md +0 -350
- package/docs/audits/findings/L6-documentation.md +0 -347
- package/docs/audits/findings/L7-operational.md +0 -50
- package/docs/audits/findings/L8-reproducibility.md +0 -64
- package/docs/audits/findings/L9-process.md +0 -84
- package/docs/audits/findings/baseline.json +0 -19
- package/docs/audits/v3.6.0-external-anonymous-audit.md +0 -163
- package/docs/audits/v3.6.0-final-audit.md +0 -171
- package/docs/audits/v3.6.0-rc.4-rootcause.md +0 -134
- package/docs/audits/v3.6.0-system-audit-plan.md +0 -199
|
@@ -21,4 +21,4 @@ hints in the message).</p>
|
|
|
21
21
|
</div><div class="tsd-tag-example"><h4 class="tsd-anchor-link" id="example">Example<a href="#example" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-5">// By path</span><br/><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-4">e1</span><span class="hl-1"> </span><span class="hl-0">=</span><span class="hl-1"> </span><span class="hl-0">await</span><span class="hl-1"> </span><span class="hl-2">resolveTarget</span><span class="hl-1">(vault, { path: </span><span class="hl-3">"Posts/Article.md"</span><span class="hl-1"> });</span><br/><br/><span class="hl-5">// By title (basename match)</span><br/><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-4">e2</span><span class="hl-1"> </span><span class="hl-0">=</span><span class="hl-1"> </span><span class="hl-0">await</span><span class="hl-1"> </span><span class="hl-2">resolveTarget</span><span class="hl-1">(vault, { title: </span><span class="hl-3">"Article"</span><span class="hl-1"> });</span><br/><br/><span class="hl-5">// By periodic alias — respects user's Daily-Notes config</span><br/><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-4">e3</span><span class="hl-1"> </span><span class="hl-0">=</span><span class="hl-1"> </span><span class="hl-0">await</span><span class="hl-1"> </span><span class="hl-2">resolveTarget</span><span class="hl-1">(vault, { title: </span><span class="hl-3">"today"</span><span class="hl-1"> });</span>
|
|
22
22
|
</code><button type="button">Copy</button></pre>
|
|
23
23
|
|
|
24
|
-
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/oomkapwn/enquire-mcp/blob/
|
|
24
|
+
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/oomkapwn/enquire-mcp/blob/1c21b3947f7b17ade859756cea350afa1104c8a3/src/tools/write.ts#L1041">tools/write.ts:1041</a></li></ul></aside></div></li></ul></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html">enquire-mcp API reference - v3.7.12</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
|
|
@@ -17,4 +17,4 @@ are still parsed (so the agent can report "broken link to
|
|
|
17
17
|
<div class="tsd-comment tsd-typography"><div class="tsd-tag-example"><h4 class="tsd-anchor-link" id="example">Example<a href="#example" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-4">r</span><span class="hl-1"> </span><span class="hl-0">=</span><span class="hl-1"> </span><span class="hl-0">await</span><span class="hl-1"> </span><span class="hl-2">resolveWikilink</span><span class="hl-1">(vault, {</span><br/><span class="hl-1"> wikilink: </span><span class="hl-3">"[[Hybrid Retrieval#BM25|the BM25 part]]"</span><span class="hl-1">,</span><br/><span class="hl-1"> from_note: </span><span class="hl-3">"Posts/2026/Article.md"</span><br/><span class="hl-1">});</span><br/><span class="hl-0">if</span><span class="hl-1"> (r.found) console.</span><span class="hl-2">log</span><span class="hl-1">(r.path, r.section, r.alias);</span>
|
|
18
18
|
</code><button type="button">Copy</button></pre>
|
|
19
19
|
|
|
20
|
-
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/oomkapwn/enquire-mcp/blob/
|
|
20
|
+
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/oomkapwn/enquire-mcp/blob/1c21b3947f7b17ade859756cea350afa1104c8a3/src/tools/read.ts#L260">tools/read.ts:260</a></li></ul></aside></div></li></ul></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html">enquire-mcp API reference - v3.7.12</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
|
|
@@ -59,4 +59,4 @@ in <code>signals_used</code> / <code>signal_errors</code>, and per-hit <code>per
|
|
|
59
59
|
</div><div class="tsd-tag-example"><h4 class="tsd-anchor-link" id="example">Example<a href="#example" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-4">result</span><span class="hl-1"> </span><span class="hl-0">=</span><span class="hl-1"> </span><span class="hl-0">await</span><span class="hl-1"> </span><span class="hl-2">searchHybrid</span><span class="hl-1">(</span><br/><span class="hl-1"> vault,</span><br/><span class="hl-1"> { query: </span><span class="hl-3">"RAG hybrid retrieval"</span><span class="hl-1">, limit: </span><span class="hl-4">10</span><span class="hl-1">, folder: </span><span class="hl-3">"Reference"</span><span class="hl-1"> },</span><br/><span class="hl-1"> { ftsIndex, embedFile: </span><span class="hl-3">"/path/to/vault.embed.db"</span><span class="hl-1"> }</span><br/><span class="hl-1">);</span><br/><span class="hl-0">for</span><span class="hl-1"> (</span><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-4">hit</span><span class="hl-1"> </span><span class="hl-0">of</span><span class="hl-1"> result.matches) {</span><br/><span class="hl-1"> console.</span><span class="hl-2">log</span><span class="hl-1">(hit.path, hit.score, hit.per_signal);</span><br/><span class="hl-1">}</span><br/><span class="hl-1">console.</span><span class="hl-2">log</span><span class="hl-1">(</span><span class="hl-3">"Rankers fired:"</span><span class="hl-1">, result.signals_used);</span>
|
|
60
60
|
</code><button type="button">Copy</button></pre>
|
|
61
61
|
|
|
62
|
-
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/oomkapwn/enquire-mcp/blob/
|
|
62
|
+
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/oomkapwn/enquire-mcp/blob/1c21b3947f7b17ade859756cea350afa1104c8a3/src/tools/search.ts#L1165">tools/search.ts:1165</a></li></ul></aside></div></li></ul></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html">enquire-mcp API reference - v3.7.12</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
|
|
@@ -16,4 +16,4 @@ vaults. Tokenization is whitespace-split + lowercased; case-insensitive.</p>
|
|
|
16
16
|
</div><div class="tsd-tag-example"><h4 class="tsd-anchor-link" id="example">Example<a href="#example" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-4">result</span><span class="hl-1"> </span><span class="hl-0">=</span><span class="hl-1"> </span><span class="hl-0">await</span><span class="hl-1"> </span><span class="hl-2">searchText</span><span class="hl-1">(vault, {</span><br/><span class="hl-1"> query: </span><span class="hl-3">"RAG retrieval"</span><span class="hl-1">,</span><br/><span class="hl-1"> folder: </span><span class="hl-3">"Reference"</span><span class="hl-1">,</span><br/><span class="hl-1"> mode: </span><span class="hl-3">"all"</span><span class="hl-1">,</span><br/><span class="hl-1"> limit: </span><span class="hl-4">10</span><br/><span class="hl-1">});</span><br/><span class="hl-0">for</span><span class="hl-1"> (</span><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-4">hit</span><span class="hl-1"> </span><span class="hl-0">of</span><span class="hl-1"> result.matches) {</span><br/><span class="hl-1"> console.</span><span class="hl-2">log</span><span class="hl-1">(</span><span class="hl-3">`${</span><span class="hl-1">hit</span><span class="hl-3">.</span><span class="hl-1">path</span><span class="hl-3">}:${</span><span class="hl-1">hit</span><span class="hl-3">.</span><span class="hl-1">line</span><span class="hl-3">} — ${</span><span class="hl-1">hit</span><span class="hl-3">.</span><span class="hl-1">snippet</span><span class="hl-3">}`</span><span class="hl-1">);</span><br/><span class="hl-1">}</span>
|
|
17
17
|
</code><button type="button">Copy</button></pre>
|
|
18
18
|
|
|
19
|
-
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/oomkapwn/enquire-mcp/blob/
|
|
19
|
+
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/oomkapwn/enquire-mcp/blob/1c21b3947f7b17ade859756cea350afa1104c8a3/src/tools/search.ts#L86">tools/search.ts:86</a></li></ul></aside></div></li></ul></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html">enquire-mcp API reference - v3.7.12</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
|
|
@@ -16,4 +16,4 @@ subdirectory.</p>
|
|
|
16
16
|
</div><div class="tsd-tag-example"><h4 class="tsd-anchor-link" id="example">Example<a href="#example" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-4">result</span><span class="hl-1"> </span><span class="hl-0">=</span><span class="hl-1"> </span><span class="hl-0">await</span><span class="hl-1"> </span><span class="hl-2">semanticSearch</span><span class="hl-1">(vault, {</span><br/><span class="hl-1"> query: </span><span class="hl-3">"vector retrieval cosine"</span><span class="hl-1">,</span><br/><span class="hl-1"> limit: </span><span class="hl-4">5</span><br/><span class="hl-1">});</span><br/><span class="hl-0">for</span><span class="hl-1"> (</span><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-4">hit</span><span class="hl-1"> </span><span class="hl-0">of</span><span class="hl-1"> result.matches) {</span><br/><span class="hl-1"> console.</span><span class="hl-2">log</span><span class="hl-1">(hit.path, hit.score, hit.matched_terms);</span><br/><span class="hl-1">}</span>
|
|
17
17
|
</code><button type="button">Copy</button></pre>
|
|
18
18
|
|
|
19
|
-
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/oomkapwn/enquire-mcp/blob/
|
|
19
|
+
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/oomkapwn/enquire-mcp/blob/1c21b3947f7b17ade859756cea350afa1104c8a3/src/tools/search.ts#L592">tools/search.ts:592</a></li></ul></aside></div></li></ul></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html">enquire-mcp API reference - v3.7.12</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
|
|
@@ -16,4 +16,4 @@ collision detection.</p>
|
|
|
16
16
|
<div class="tsd-comment tsd-typography"><div class="tsd-tag-example"><h4 class="tsd-anchor-link" id="example">Example<a href="#example" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-4">v</span><span class="hl-1"> </span><span class="hl-0">=</span><span class="hl-1"> </span><span class="hl-0">await</span><span class="hl-1"> </span><span class="hl-2">validateNoteProposal</span><span class="hl-1">(vault, {</span><br/><span class="hl-1"> path: </span><span class="hl-3">"Inbox/draft.md"</span><span class="hl-1">,</span><br/><span class="hl-1"> content: </span><span class="hl-3">"---</span><span class="hl-4">\n</span><span class="hl-3">status: draft</span><span class="hl-4">\n</span><span class="hl-3">---</span><span class="hl-4">\n</span><span class="hl-3"># Title</span><span class="hl-4">\n\n</span><span class="hl-3">[[Bar]] is broken."</span><span class="hl-1">,</span><br/><span class="hl-1"> mode: </span><span class="hl-3">"create"</span><br/><span class="hl-1">});</span><br/><span class="hl-0">if</span><span class="hl-1"> (</span><span class="hl-0">!</span><span class="hl-1">v.ok) {</span><br/><span class="hl-1"> </span><span class="hl-0">for</span><span class="hl-1"> (</span><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-4">e</span><span class="hl-1"> </span><span class="hl-0">of</span><span class="hl-1"> v.errors) console.</span><span class="hl-2">error</span><span class="hl-1">(e.kind, e.message);</span><br/><span class="hl-1">}</span>
|
|
17
17
|
</code><button type="button">Copy</button></pre>
|
|
18
18
|
|
|
19
|
-
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/oomkapwn/enquire-mcp/blob/
|
|
19
|
+
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/oomkapwn/enquire-mcp/blob/1c21b3947f7b17ade859756cea350afa1104c8a3/src/tools/meta.ts#L97">tools/meta.ts:97</a></li></ul></aside></div></li></ul></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html">enquire-mcp API reference - v3.7.12</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
|
|
@@ -5,7 +5,7 @@ the same entry points programmatically.</p>
|
|
|
5
5
|
<p>Strings on numeric fields (e.g. <code>maxFileBytes</code>, <code>cacheSize</code>) reflect the
|
|
6
6
|
fact that callers usually pass CLI args verbatim — parsing happens
|
|
7
7
|
inside <code>prepareServerDeps</code> via <a href="../functions/index.parsePositiveInt.html" class="tsd-kind-function">parsePositiveInt</a>.</p>
|
|
8
|
-
</div></section><div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">ServeOptions</span> <span class="tsd-signature-symbol">{</span><br/> <a class="tsd-kind-property" href="#cachefile">cacheFile</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#cachesize">cacheSize</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#diagnosticsearchtools">diagnosticSearchTools</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#disabledtools">disabledTools</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#enabledtools">enabledTools</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#enablereranker">enableReranker</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#enablewrite">enableWrite</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#excludeglob">excludeGlob</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#hnswef">hnswEf</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#hnswpersist">hnswPersist</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#includepdfs">includePdfs</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#indexfile">indexFile</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#latechunkcontext">lateChunkContext</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#maxfilebytes">maxFileBytes</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#persistentcache">persistentCache</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#persistentindex">persistentIndex</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#quantizeembeddings">quantizeEmbeddings</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">"f32"</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"int8"</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#readpaths">readPaths</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#rerankermodel">rerankerModel</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#rerankertopn">rerankerTopN</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#tokenize">tokenize</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">"unicode61"</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"trigram"</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#usehnsw">useHnsw</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#vault">vault</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#watch">watch</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/oomkapwn/enquire-mcp/blob/
|
|
8
|
+
</div></section><div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">ServeOptions</span> <span class="tsd-signature-symbol">{</span><br/> <a class="tsd-kind-property" href="#cachefile">cacheFile</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#cachesize">cacheSize</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#diagnosticsearchtools">diagnosticSearchTools</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#disabledtools">disabledTools</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#enabledtools">enabledTools</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#enablereranker">enableReranker</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#enablewrite">enableWrite</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#excludeglob">excludeGlob</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#hnswef">hnswEf</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#hnswpersist">hnswPersist</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#includepdfs">includePdfs</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#indexfile">indexFile</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#latechunkcontext">lateChunkContext</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#maxfilebytes">maxFileBytes</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#persistentcache">persistentCache</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#persistentindex">persistentIndex</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#quantizeembeddings">quantizeEmbeddings</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">"f32"</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"int8"</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#readpaths">readPaths</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#rerankermodel">rerankerModel</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#rerankertopn">rerankerTopN</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#tokenize">tokenize</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">"unicode61"</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"trigram"</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#usehnsw">useHnsw</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#vault">vault</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#watch">watch</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/oomkapwn/enquire-mcp/blob/1c21b3947f7b17ade859756cea350afa1104c8a3/src/server.ts#L31">server.ts:31</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h5 class="tsd-index-heading uppercase">Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="#cachefile" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>cache<wbr/>File?</span></a>
|
|
9
9
|
<a href="#cachesize" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>cache<wbr/>Size?</span></a>
|
|
10
10
|
<a href="#diagnosticsearchtools" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>diagnostic<wbr/>Search<wbr/>Tools?</span></a>
|
|
11
11
|
<a href="#disabledtools" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>disabled<wbr/>Tools?</span></a>
|
|
@@ -30,28 +30,28 @@ inside <code>prepareServerDeps</code> via <a href="../functions/index.parsePosit
|
|
|
30
30
|
<a href="#vault" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>vault</span></a>
|
|
31
31
|
<a href="#watch" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>watch?</span></a>
|
|
32
32
|
</div></section></div></details></section></section><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h2>Properties</h2></summary><section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="cachefile"><code class="tsd-tag">Optional</code><span>cache<wbr/>File</span><a href="#cachefile" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">cacheFile</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>Override the persistent cache file location.</p>
|
|
33
|
-
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/oomkapwn/enquire-mcp/blob/
|
|
34
|
-
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/oomkapwn/enquire-mcp/blob/
|
|
35
|
-
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/oomkapwn/enquire-mcp/blob/
|
|
36
|
-
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/oomkapwn/enquire-mcp/blob/
|
|
37
|
-
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/oomkapwn/enquire-mcp/blob/
|
|
33
|
+
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/oomkapwn/enquire-mcp/blob/1c21b3947f7b17ade859756cea350afa1104c8a3/src/server.ts#L44">server.ts:44</a></li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="cachesize"><code class="tsd-tag">Optional</code><span>cache<wbr/>Size</span><a href="#cachesize" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">cacheSize</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>In-memory parsed-note cache capacity.</p>
|
|
34
|
+
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/oomkapwn/enquire-mcp/blob/1c21b3947f7b17ade859756cea350afa1104c8a3/src/server.ts#L40">server.ts:40</a></li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="diagnosticsearchtools"><code class="tsd-tag">Optional</code><span>diagnostic<wbr/>Search<wbr/>Tools</span><a href="#diagnosticsearchtools" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">diagnosticSearchTools</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>Expose diagnostic / debug tools (<code>obsidian_full_text_search</code> etc.).</p>
|
|
35
|
+
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/oomkapwn/enquire-mcp/blob/1c21b3947f7b17ade859756cea350afa1104c8a3/src/server.ts#L62">server.ts:62</a></li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="disabledtools"><code class="tsd-tag">Optional</code><span>disabled<wbr/>Tools</span><a href="#disabledtools" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">disabledTools</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div><div class="tsd-comment tsd-typography"><p>Per-tool gating: deny list. Tools named here won't register.</p>
|
|
36
|
+
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/oomkapwn/enquire-mcp/blob/1c21b3947f7b17ade859756cea350afa1104c8a3/src/server.ts#L58">server.ts:58</a></li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="enabledtools"><code class="tsd-tag">Optional</code><span>enabled<wbr/>Tools</span><a href="#enabledtools" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">enabledTools</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div><div class="tsd-comment tsd-typography"><p>Per-tool gating: allow list. Only listed tools register (deny still applies).</p>
|
|
37
|
+
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/oomkapwn/enquire-mcp/blob/1c21b3947f7b17ade859756cea350afa1104c8a3/src/server.ts#L60">server.ts:60</a></li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="enablereranker"><code class="tsd-tag">Optional</code><span>enable<wbr/>Reranker</span><a href="#enablereranker" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">enableReranker</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>v2.9.0 — enable BGE cross-encoder reranking on top of RRF in
|
|
38
38
|
obsidian_search. Off by default; adds ~30-50ms per query at top-50.</p>
|
|
39
|
-
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/oomkapwn/enquire-mcp/blob/
|
|
39
|
+
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/oomkapwn/enquire-mcp/blob/1c21b3947f7b17ade859756cea350afa1104c8a3/src/server.ts#L69">server.ts:69</a></li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="enablewrite"><code class="tsd-tag">Optional</code><span>enable<wbr/>Write</span><a href="#enablewrite" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">enableWrite</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>Allow write tools (<code>obsidian_create_note</code>, <code>obsidian_append_note</code>,
|
|
40
40
|
<code>obsidian_rename_file</code>). Default false (read-only).</p>
|
|
41
|
-
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/oomkapwn/enquire-mcp/blob/
|
|
42
|
-
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/oomkapwn/enquire-mcp/blob/
|
|
43
|
-
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/oomkapwn/enquire-mcp/blob/
|
|
41
|
+
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/oomkapwn/enquire-mcp/blob/1c21b3947f7b17ade859756cea350afa1104c8a3/src/server.ts#L36">server.ts:36</a></li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="excludeglob"><code class="tsd-tag">Optional</code><span>exclude<wbr/>Glob</span><a href="#excludeglob" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">excludeGlob</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div><div class="tsd-comment tsd-typography"><p>Privacy: glob patterns to exclude from the vault.</p>
|
|
42
|
+
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/oomkapwn/enquire-mcp/blob/1c21b3947f7b17ade859756cea350afa1104c8a3/src/server.ts#L52">server.ts:52</a></li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="hnswef"><code class="tsd-tag">Optional</code><span>hnsw<wbr/>Ef</span><a href="#hnswef" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">hnswEf</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>v2.13.0 — HNSW search-time beam width (default 100; ≥k).</p>
|
|
43
|
+
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/oomkapwn/enquire-mcp/blob/1c21b3947f7b17ade859756cea350afa1104c8a3/src/server.ts#L80">server.ts:80</a></li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="hnswpersist"><code class="tsd-tag">Optional</code><span>hnsw<wbr/>Persist</span><a href="#hnswpersist" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">hnswPersist</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>v2.16.0 — persist HNSW index to disk for fast reload on next serve.
|
|
44
44
|
Default true (the persistence is a pure optimization; corrupt files
|
|
45
45
|
fall back to rebuild gracefully). Pass <code>--no-hnsw-persist</code> to opt out.</p>
|
|
46
|
-
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/oomkapwn/enquire-mcp/blob/
|
|
46
|
+
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/oomkapwn/enquire-mcp/blob/1c21b3947f7b17ade859756cea350afa1104c8a3/src/server.ts#L86">server.ts:86</a></li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="includepdfs"><code class="tsd-tag">Optional</code><span>include<wbr/>Pdfs</span><a href="#includepdfs" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">includePdfs</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>v2.8.0 — also index PDFs into FTS5 (and embeddings, if a build-embeddings
|
|
47
47
|
with --include-pdfs ran). Off by default; opt-in because PDF extraction
|
|
48
48
|
is slower than markdown.</p>
|
|
49
|
-
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/oomkapwn/enquire-mcp/blob/
|
|
50
|
-
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/oomkapwn/enquire-mcp/blob/
|
|
51
|
-
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/oomkapwn/enquire-mcp/blob/
|
|
52
|
-
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/oomkapwn/enquire-mcp/blob/
|
|
53
|
-
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/oomkapwn/enquire-mcp/blob/
|
|
54
|
-
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/oomkapwn/enquire-mcp/blob/
|
|
49
|
+
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/oomkapwn/enquire-mcp/blob/1c21b3947f7b17ade859756cea350afa1104c8a3/src/server.ts#L66">server.ts:66</a></li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="indexfile"><code class="tsd-tag">Optional</code><span>index<wbr/>File</span><a href="#indexfile" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">indexFile</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>Override the FTS5 index file location.</p>
|
|
50
|
+
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/oomkapwn/enquire-mcp/blob/1c21b3947f7b17ade859756cea350afa1104c8a3/src/server.ts#L48">server.ts:48</a></li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="latechunkcontext"><code class="tsd-tag">Optional</code><span>late<wbr/>Chunk<wbr/>Context</span><a href="#latechunkcontext" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">lateChunkContext</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>v2.15.0 — late-chunking context windowing for embeddings (default 0 chars).</p>
|
|
51
|
+
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/oomkapwn/enquire-mcp/blob/1c21b3947f7b17ade859756cea350afa1104c8a3/src/server.ts#L82">server.ts:82</a></li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="maxfilebytes"><code class="tsd-tag">Optional</code><span>max<wbr/>File<wbr/>Bytes</span><a href="#maxfilebytes" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">maxFileBytes</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>Per-file size cap (parsed via <a href="../functions/index.parsePositiveInt.html" class="tsd-kind-function">parsePositiveInt</a>).</p>
|
|
52
|
+
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/oomkapwn/enquire-mcp/blob/1c21b3947f7b17ade859756cea350afa1104c8a3/src/server.ts#L38">server.ts:38</a></li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="persistentcache"><code class="tsd-tag">Optional</code><span>persistent<wbr/>Cache</span><a href="#persistentcache" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">persistentCache</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>Persist the parse cache across server restarts.</p>
|
|
53
|
+
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/oomkapwn/enquire-mcp/blob/1c21b3947f7b17ade859756cea350afa1104c8a3/src/server.ts#L42">server.ts:42</a></li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="persistentindex"><code class="tsd-tag">Optional</code><span>persistent<wbr/>Index</span><a href="#persistentindex" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">persistentIndex</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>Enable the persistent FTS5 index (requires <code>better-sqlite3</code>).</p>
|
|
54
|
+
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/oomkapwn/enquire-mcp/blob/1c21b3947f7b17ade859756cea350afa1104c8a3/src/server.ts#L46">server.ts:46</a></li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="quantizeembeddings"><code class="tsd-tag">Optional</code><span>quantize<wbr/>Embeddings</span><a href="#quantizeembeddings" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">quantizeEmbeddings</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">"f32"</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"int8"</span></div><div class="tsd-comment tsd-typography"><p>v2.17.0 — vector storage encoding for the persistent embed db.</p>
|
|
55
55
|
<ul>
|
|
56
56
|
<li><code>"f32"</code> (default) — Float32 BLOB, identical to v2.16- behavior.</li>
|
|
57
57
|
<li><code>"int8"</code> — int8-quantized BLOB + per-vector (vMin, scale) Float32
|
|
@@ -61,14 +61,14 @@ Mode is per-database; switching modes triggers a full rebuild
|
|
|
61
61
|
Must match the mode used at build-embeddings time — serving with a
|
|
62
62
|
different mode would auto-rebuild the index.</li>
|
|
63
63
|
</ul>
|
|
64
|
-
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/oomkapwn/enquire-mcp/blob/
|
|
65
|
-
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/oomkapwn/enquire-mcp/blob/
|
|
66
|
-
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/oomkapwn/enquire-mcp/blob/
|
|
67
|
-
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/oomkapwn/enquire-mcp/blob/
|
|
68
|
-
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/oomkapwn/enquire-mcp/blob/
|
|
64
|
+
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/oomkapwn/enquire-mcp/blob/1c21b3947f7b17ade859756cea350afa1104c8a3/src/server.ts#L95">server.ts:95</a></li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="readpaths"><code class="tsd-tag">Optional</code><span>read<wbr/>Paths</span><a href="#readpaths" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">readPaths</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div><div class="tsd-comment tsd-typography"><p>Privacy: glob patterns that form a strict allowlist.</p>
|
|
65
|
+
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/oomkapwn/enquire-mcp/blob/1c21b3947f7b17ade859756cea350afa1104c8a3/src/server.ts#L54">server.ts:54</a></li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="rerankermodel"><code class="tsd-tag">Optional</code><span>reranker<wbr/>Model</span><a href="#rerankermodel" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">rerankerModel</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>v2.9.0 — reranker model alias (default "rerank-multilingual").</p>
|
|
66
|
+
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/oomkapwn/enquire-mcp/blob/1c21b3947f7b17ade859756cea350afa1104c8a3/src/server.ts#L71">server.ts:71</a></li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="rerankertopn"><code class="tsd-tag">Optional</code><span>reranker<wbr/>Top<wbr/>N</span><a href="#rerankertopn" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">rerankerTopN</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>v2.9.0 — how many top fused candidates to rerank (default 50).</p>
|
|
67
|
+
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/oomkapwn/enquire-mcp/blob/1c21b3947f7b17ade859756cea350afa1104c8a3/src/server.ts#L73">server.ts:73</a></li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="tokenize"><code class="tsd-tag">Optional</code><span>tokenize</span><a href="#tokenize" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">tokenize</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">"unicode61"</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"trigram"</span></div><div class="tsd-comment tsd-typography"><p>FTS5 tokenizer mode.</p>
|
|
68
|
+
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/oomkapwn/enquire-mcp/blob/1c21b3947f7b17ade859756cea350afa1104c8a3/src/server.ts#L50">server.ts:50</a></li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="usehnsw"><code class="tsd-tag">Optional</code><span>use<wbr/>Hnsw</span><a href="#usehnsw" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">useHnsw</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>v2.13.0 — build an in-memory HNSW vector index on serve start.
|
|
69
69
|
Off by default; rebuild cost ~25s for 50K chunks. Sub-10ms top-K
|
|
70
70
|
per query thereafter, vs O(n) brute-force without it. Defers
|
|
71
71
|
persistence to v3.0.</p>
|
|
72
|
-
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/oomkapwn/enquire-mcp/blob/
|
|
73
|
-
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/oomkapwn/enquire-mcp/blob/
|
|
74
|
-
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/oomkapwn/enquire-mcp/blob/
|
|
72
|
+
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/oomkapwn/enquire-mcp/blob/1c21b3947f7b17ade859756cea350afa1104c8a3/src/server.ts#L78">server.ts:78</a></li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="vault"><span>vault</span><a href="#vault" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">vault</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>Absolute path to the vault root directory. Required.</p>
|
|
73
|
+
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/oomkapwn/enquire-mcp/blob/1c21b3947f7b17ade859756cea350afa1104c8a3/src/server.ts#L33">server.ts:33</a></li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="watch"><code class="tsd-tag">Optional</code><span>watch</span><a href="#watch" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">watch</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>Enable the filesystem watcher (auto-reindex on change).</p>
|
|
74
|
+
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/oomkapwn/enquire-mcp/blob/1c21b3947f7b17ade859756cea350afa1104c8a3/src/server.ts#L56">server.ts:56</a></li></ul></aside></section></section></details></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>On This Page</h3></summary><div class="tsd-accordion-details"><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Properties</summary><div><a href="#cachefile"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>cache<wbr/>File</span></a><a href="#cachesize"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>cache<wbr/>Size</span></a><a href="#diagnosticsearchtools"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>diagnostic<wbr/>Search<wbr/>Tools</span></a><a href="#disabledtools"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>disabled<wbr/>Tools</span></a><a href="#enabledtools"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>enabled<wbr/>Tools</span></a><a href="#enablereranker"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>enable<wbr/>Reranker</span></a><a href="#enablewrite"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>enable<wbr/>Write</span></a><a href="#excludeglob"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>exclude<wbr/>Glob</span></a><a href="#hnswef"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>hnsw<wbr/>Ef</span></a><a href="#hnswpersist"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>hnsw<wbr/>Persist</span></a><a href="#includepdfs"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>include<wbr/>Pdfs</span></a><a href="#indexfile"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>index<wbr/>File</span></a><a href="#latechunkcontext"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>late<wbr/>Chunk<wbr/>Context</span></a><a href="#maxfilebytes"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>max<wbr/>File<wbr/>Bytes</span></a><a href="#persistentcache"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>persistent<wbr/>Cache</span></a><a href="#persistentindex"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>persistent<wbr/>Index</span></a><a href="#quantizeembeddings"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>quantize<wbr/>Embeddings</span></a><a href="#readpaths"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>read<wbr/>Paths</span></a><a href="#rerankermodel"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>reranker<wbr/>Model</span></a><a href="#rerankertopn"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>reranker<wbr/>Top<wbr/>N</span></a><a href="#tokenize"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>tokenize</span></a><a href="#usehnsw"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>use<wbr/>Hnsw</span></a><a href="#vault"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>vault</span></a><a href="#watch"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>watch</span></a></div></details></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html">enquire-mcp API reference - v3.7.12</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
|