README file from
GithubDocSanctum for Obsidian
An Obsidian plugin that connects to a self-hosted DocSanctum backend over MCP, so you can search and read your DocSanctum-indexed documents from inside Obsidian.
DocSanctum (github.com/DocSanctum/doc-sanctum) exposes its document tools (list_documents, search_documents, semantic_search_documents, read_document) as a standard MCP server over streamable HTTP (mounted at /mcp on the backend). This plugin is just an MCP client wired into Obsidian's UI.
This plugin is a client only. It doesn't run any indexing or search itself — it calls into a DocSanctum backend you already have running. If you don't have DocSanctum yet, set it up first: https://github.com/DocSanctum/doc-sanctum.
Features
- Search command / ribbon icon — keyword search across your DocSanctum sources.
- Semantic search command / ribbon icon — natural-language search over indexed content.
- Selecting a result fetches the full document and renders it in a read-only preview.
- Settings tab to configure the backend's MCP server URL, restrict search to a single source, and test the connection.
- Surfaces backend warnings (e.g. a source falling back to stale cached data) as in-app notices and, when reading a document, as a banner above the preview.
Setup
- Have a DocSanctum backend running and reachable (default
http://localhost:8000/mcp). - Add the vault's folder (or whichever folder you want searchable) as a source in the DocSanctum frontend, and let it finish indexing. This plugin only queries sources that already exist in DocSanctum — it can't register or index a folder on its own. Search will simply return nothing until this step is done.
- Install this plugin (see below) and set the Server URL in the plugin settings if it differs from the default.
- Run the DocSanctum: Search or DocSanctum: Semantic search command (or use the ribbon icon).
Development
npm ito install dependencies.npm run devto buildsrc/main.tsintomain.jsin watch mode.npm run buildto type-check and produce a production build.- For local testing, symlink or copy
main.js,manifest.json,styles.cssintoVaultFolder/.obsidian/plugins/doc-sanctum/.
License
MIT — see LICENSE.