EO

ebullient/obsidian-vault-mcp

Developer tools

이 페이지는 AI로 자동 번역되었습니다. 기술적인 세부 사항은 원문을 확인하세요. 원문 보기

43 stars 7 forks 품질 76 트렌드 32MIT

MCP 도구는 WebUI 또는 Claude Desktop을 사용하여 Vault에서 파일을 검색 할 수 있습니다

개요

이 Obsidian 플러그인은 MCP (모델 Context Protocol) 서버를 Obsidian 내부에 직접 실행하여 외부 LLM 도구를 vault에 액세스합니다. 기본적으로 HTTP 전송 지원 (WebUI, 원격 LLM). 옵션 브리지 스크립트는 HTTP에서 stdio (Claude Desktop)에 브리지를 제공합니다. - : 이 플러그인은 inbound MCP 연결을 허용하기 위해 기계에 로컬 HTTP 서버를 실행합니다. 외부 LLM 서비스에 vault 데이터를 보내지 않습니다. - : 이 플러그인은 외부 도구 직접 파일 시스템 액세스를 제공 대신 Obsidian API 및 경로 ACL을 통해 vault 액세스를 제어 할 수 있습니다. - : 이 플러그인은 데스크톱 환경을 필요로하며 모바일 장치에서 작동하지 않습니다.

개요(AI 번역)

이 Obsidian 플러그인은 MCP (모델 Context Protocol) 서버를 Obsidian 내부에 직접 실행하여 외부 LLM 도구를 vault에 액세스합니다. 기본적으로 HTTP 전송 지원 (WebUI, 원격 LLM). 옵션 bridge 스크립트는 HTTP에서 stdio (Claude Desktop)에 브리지를 제공합니다.

** 중요 메모 ** ·

  • 네트워크 사용: 이 플러그인은 inbound MCP 연결을 허용하기 위해 기계에 로컬 HTTP 서버를 실행합니다. 외부 LLM 서비스에 vault 데이터를 보내지 않습니다.
  • 개인: 이 플러그인은 외부 도구 직접 파일 시스템 액세스를 제공 대신 Obsidian API 및 경로 ACL을 통해 vault 액세스를 제어 할 수 있습니다.
  • **Desktop 만 **: 이 플러그인은 데스크톱 환경을 필요로하며 모바일 장치에서 작동하지 않습니다.

특징

  • **HTTP 기반 MCP 서버 **: MCP 프로토콜을 구현하는 빠른 서버 실행 -Status Bar Indicator: click-toggle 기능으로 서버 상태(stopped/running/error) 표시
  • Configurable Settings: 서버 포트, 자동 시작 동작, 로깅 및 경로 ACL을 조정하여 vault의 영역에 액세스
  • CORS 지원: 원격 기계에서 Tailscale 또는 로컬 네트워크를 통해 액세스 가능

이 페이지는 AI로 자동 번역되었습니다. 기술적인 세부 사항은 원문을 확인하세요.

README

원문 README의 일부입니다. 원문 보기.

Vault as MCP

This Obsidian plugin runs an MCP (Model Context Protocol) server directly inside Obsidian, letting external LLM tools access your vault. Supports HTTP transport natively (Open WebUI, remote LLMs). An optional bridge script provides a bridge from HTTP to stdio (Claude Desktop).

Important Notes

  • Network Use: This plugin runs a local HTTP server on your machine to accept inbound MCP connections. It does not send your vault data to external LLM services by itself.
  • Privacy: This plugin lets you control vault access through Obsidian APIs and path ACLs instead of giving external tools direct filesystem access.
  • Desktop Only: This plugin requires a desktop environment and will not work on mobile devices.

Features

  • HTTP-based MCP server: Runs a Fastify server implementing the MCP protocol
  • Status Bar Indicator: Shows server status (stopped/running/error) with click-to-toggle functionality
  • Configurable Settings: Adjust server port, auto-start behavior, logging, and path ACLs to control access to areas of your vault
  • CORS Support: Enables access from remote machines via Tailscale or local network
  • MCP Tools: Read, search, list, create, edit, rename, and delete notes; templates and periodic notes — see MCP Tools Reference

Installation

Community Plugins

  1. Open Settings → Community Plugins
  2. Click “Browse” and search for “Vault as MCP”
  3. Install and enable the plugin

Manual Installation

  1. Download the latest release from GitHub
  2. Extract the files to your vault’s .obsidian/plugins/vault-as-mcp/ directory
  3. Reload Obsidian
  4. Enable “Vault as MCP” in Settings → Community Plugins

Install with BRAT

Assuming you have the BRAT plugin installed and enabled:

  1. Open BRAT plugin settings
  2. Click ‘Add beta plugin’
  3. Use https://github.com/ebullient/obsidian-vault-mcp as the URL, select the latest version and install
  4. Enable “Vault as MCP”, either as part of installing via BRAT, or in Settings → Community Plugins

Usage

Starting the Server

The plugin provides three ways to control the server:

  1. Status Bar: Click the status indicator in the bottom-right to toggle the server on/off
  2. Commands: Use the command palette to:
    • Start MCP server
    • Stop MCP server
    • Restart MCP server
  3. Auto-start: Enable in settings to automatically start the server when Obsidian loads

Configuration

Open Settings → Vault as MCP:

  • Server Port: Port number for the MCP server (default: 8765)
  • Bearer Token: Optional authentication token for secure access
  • Auto-start Server: Automatically start when Obsidian loads
  • Debug: Enable debug messages

Authentication

GitHub에서 전체 README 보기

설치

This server does not publish a one-line install command.

Open the repository installation guide MCP 초보자라면? mcpskill.org 가이드부터 시작하세요 →

설정

{ "mcpServers": { "obsidian-vault": { "command": "node", "args": ["/absolute/path/to/mcp-bridge.js"], "env": { "VAULT_MCP_URL": "http://localhost:8765/mcp" } } } }