No description
Find a file
jsmorabito c19300955b docs: add MCP Server entry to CLAUDE.md and .claude/rules
Documents the McpPermissionModal vs. in-chat permission gate
distinction, the stateless transport design, and the mcp-remote bridge
workaround for clients that only accept command/args config entries.
2026-07-08 13:15:02 -04:00
.claude docs: add MCP Server entry to CLAUDE.md and .claude/rules 2026-07-08 13:15:02 -04:00
.github chore: tighten contributor guardrails (Node 24, lint CI gate, doc fixes) 2026-07-02 13:06:20 -05:00
docs ci: add CI gate for no-!important CSS policy and tsc, document styling reasoning 2026-07-02 12:46:13 -05:00
README_images updating README to include assistant instructions 2024-07-24 16:39:25 -04:00
scripts ci: add CI gate for no-!important CSS policy and tsc, document styling reasoning 2026-07-02 12:46:13 -05:00
specs fix: plugin review issues, SDK install UX, and manifest linter (#300) 2026-06-19 15:43:39 -04:00
src feat: add built-in MCP server for external vault access 2026-07-08 12:49:36 -04:00
test Add local E2E suite driving real sandboxed Obsidian (wdio-obsidian-service) 2026-06-06 14:16:18 -05:00
.editorconfig initial plugin push 2024-01-16 16:30:04 -06:00
.gitignore feat: ONNX local embeddings working in-process (0.24.9) 2026-06-07 11:46:51 -04:00
.npmrc initial plugin push 2024-01-16 16:30:04 -06:00
.nvmrc chore: tighten contributor guardrails (Node 24, lint CI gate, doc fixes) 2026-07-02 13:06:20 -05:00
bash.exe.stackdump rm console logs 2025-06-04 18:09:18 -04:00
CLAUDE.md docs: add MCP Server entry to CLAUDE.md and .claude/rules 2026-07-08 13:15:02 -04:00
esbuild.config.mjs fix: build main.js at repo root so CI's release attestation can find it 2026-07-08 13:09:29 -04:00
eslint.config.mjs chore: ratchet lint enforcement to --max-warnings=0 (U10) 2026-07-01 22:59:25 -05:00
LICENSE Update copyright 2025-04-08 07:45:28 +03:00
manifest.json release: 0.24.24 2026-07-01 22:59:48 -05:00
package-lock.json feat: add built-in MCP server for external vault access 2026-07-08 12:49:36 -04:00
package.json feat: add built-in MCP server for external vault access 2026-07-08 12:49:36 -04:00
README.md feat: add built-in MCP server for external vault access 2026-07-08 12:49:36 -04:00
SECURITY.md Create SECURITY.md 2025-06-22 23:16:45 -05:00
SKILLS.md skills update 2026-05-10 11:02:17 -04:00
styles.css feat: add built-in MCP server for external vault access 2026-07-08 12:49:36 -04:00
tsconfig.json fix: enable tsconfig strict and eliminate catch-clause anys (U2) 2026-07-01 21:59:25 -05:00
version-bump.mjs fix: copy manifest.json and styles.css to live plugin folder on build 2026-06-07 11:41:45 -04:00
versions.json release: 0.24.24 2026-07-01 22:59:48 -05:00
wdio.conf.mts Add local E2E suite driving real sandboxed Obsidian (wdio-obsidian-service) 2026-06-06 14:16:18 -05:00
whisper-server.py speech to text mvp 2026-05-14 18:29:25 -04:00

Shows project promo image in light and dark mode

Large Language Models

The Large Language Models (LLMs) Plugin gives Obsidian users access to LLMs through cloud providers (OpenAI, Anthropic, Google, and Mistral) and locally via GPT4All and Ollama. Models can be interacted with in the sidebar, main window, and a newly added, floating action button popup window.

Shows project promo image in light and dark mode

Instructions

Installation: Download the plugin via the community plugin browser.

Using models from cloud-based providers:

  1. In the plugin settings menu, enter an API key from one of the supported model providers
  2. To interact with models, open one of the chat views using the newly added commands (see Commands section below)

Using models locally (GPT4All):

  1. Download GPT4All
  2. Download a model through GPT4All's model browser
  3. In the setting menu of GPT4All, toggle on the "Enable Local Server" setting
  4. Models downloaded via GPT4All will be selectable via the model switcher in each chat view

Using models locally (Ollama):

  1. Install Ollama and pull the models you want to use
  2. In the plugin settings, configure the Ollama host (default: http://localhost:11434)
  3. Click "Discover Models" to detect your locally available models
  4. Select an Ollama model from the model switcher in any chat view

Commands

Command Description
Open modal Opens the chat modal
Toggle FAB Toggles the visibility of the Floating Action Button (FAB) used to open and close the chat popup window
Open chat in tab Opens the chat window in a tab
Open chat in sidebar Opens the chat window in the Sidebar

Models

Cloud-based:

Model provider Status
OpenAI Supported
Anthropic Supported
Google Supported
Mistral Supported

Local:

Model provider Status
GPT4All Supported
Ollama Supported

MCP Server

The plugin can run a built-in MCP (Model Context Protocol) server so Claude Desktop, or any other MCP-compatible client, can read and write this vault directly — no separate companion plugin required.

Setup:

  1. In plugin settings, go to General → Features and enable MCP Server. A bearer token is generated automatically.
  2. Open the new MCP Server tab to see the port, bearer token, and a ready-to-copy claude_desktop_config.json snippet.
  3. Add that snippet to your Claude Desktop config file, then restart Claude Desktop:
{
  "mcpServers": {
    "obsidian-vault": {
      "url": "http://127.0.0.1:27125/mcp",
      "headers": {
        "Authorization": "Bearer <your-token>"
      }
    }
  }
}

Notes:

  • The server binds to 127.0.0.1 only and requires the bearer token on every request — it is not reachable from other devices on your network.
  • Available tools: list_files, read_file, search_vault (read-only, run immediately) and create_file, edit_file, move_file, delete_file (each pops a confirmation dialog in Obsidian before running, the same as in-app agent actions).
  • Desktop only. Disabled by default — enabling it opens a local port only for as long as the toggle stays on.
  • Regenerating the bearer token immediately invalidates the old one; update any connected MCP clients afterward.

Credits

  • Johnny
  • Ryan Mahoney
  • Evan Harris
Shows project promo image in light and dark mode