local-only server

The server can only run on the client’s local machine because it depends on local resources.

Integrations

Allows interaction with Obsidian via the Local REST API community plugin. Capabilities include listing files in vault, retrieving file contents, searching across vault files, patching content into existing notes, and appending content to new or existing files.

Obsidian용 MCP 서버

로컬 REST API 커뮤니티 플러그인을 통해 Obsidian과 상호작용하는 MCP 서버입니다.

구성 요소

도구

서버는 Obsidian과 상호 작용하기 위해 여러 도구를 구현합니다.

list_files_in_vault: Obsidian 볼트의 루트 디렉토리에 있는 모든 파일과 디렉토리를 나열합니다.
list_files_in_dir: 특정 Obsidian 디렉토리에 있는 모든 파일과 디렉토리를 나열합니다.
get_file_contents: 보관소에 있는 단일 파일의 내용을 반환합니다.
검색: 볼트에 있는 모든 파일에서 지정된 텍스트 쿼리와 일치하는 문서를 검색합니다.
patch_content: 제목, 블록 참조 또는 프런트매터 필드를 기준으로 기존 노트에 콘텐츠를 삽입합니다.
append_content: 볼트에 있는 새 파일이나 기존 파일에 내용을 추가합니다.
delete_file: 보관소에서 파일이나 디렉토리를 삭제합니다.

예시 프롬프트

먼저 Claude에게 Obsidian을 사용하도록 지시하는 것이 좋습니다. 그러면 Claude가 항상 해당 도구를 호출하게 됩니다.

다음과 같은 프롬프트가 사용됩니다.

마지막 아키텍처 콜 노트의 내용을 가져와 요약하세요.
Azure CosmosDb가 언급된 모든 파일을 검색하고 해당 파일이 언급된 맥락을 간략하게 설명해 주세요.
지난 회의록을 요약해서 'summary meeting.md'라는 새 메모로 만들어 주세요. 이메일로 보낼 수 있도록 소개글을 추가해 주세요.

구성

Obsidian REST API 키

Obsidian REST API 키를 사용하여 환경을 구성하는 방법에는 두 가지가 있습니다.

서버 구성에 추가(권장)

지엑스피1

작업 디렉토리에 다음의 필수 변수가 포함된 .env 파일을 만듭니다.

OBSIDIAN_API_KEY=your_api_key_here
OBSIDIAN_HOST=your_obsidian_host

참고: Obsidian 플러그인 구성에서 키를 찾을 수 있습니다.

빠른 시작

설치하다

옵시디언 REST API

Obsidian REST API 커뮤니티 플러그인을 실행해야 합니다: https://github.com/coddingtonbear/obsidian-local-rest-api

설정에서 설치하고 활성화한 후 API 키를 복사하세요.

클로드 데스크탑

MacOS의 경우: ~/Library/Application\ Support/Claude/claude_desktop_config.json

Windows의 경우: %APPDATA%/Claude/claude_desktop_config.json

{
  "mcpServers": {
    "mcp-obsidian": {
      "command": "uv",
      "args": [
        "--directory",
        "<dir_to>/mcp-obsidian",
        "run",
        "mcp-obsidian"
      ]
    }
  }
}

{
  "mcpServers": {
    "mcp-obsidian": {
      "command": "uvx",
      "args": [
        "mcp-obsidian"
      ],
      "env": {
        "OBSIDIAN_API_KEY" : "<YOUR_OBSIDIAN_API_KEY>"
      }
    }
  }
}

개발

건물

배포를 위해 패키지를 준비하려면:

종속성 동기화 및 잠금 파일 업데이트:

uv sync

디버깅

MCP 서버는 stdio를 통해 실행되므로 디버깅이 어려울 수 있습니다. 최상의 디버깅 환경을 위해서는 MCP Inspector 사용을 강력히 권장합니다.

다음 명령을 사용하여 npm 통해 MCP Inspector를 시작할 수 있습니다.

npx @modelcontextprotocol/inspector uv --directory /path/to/mcp-obsidian run mcp-obsidian

Inspector를 실행하면 브라우저에서 접근하여 디버깅을 시작할 수 있는 URL이 표시됩니다.

다음 명령을 사용하여 서버 로그를 볼 수도 있습니다.

tail -n 20 -f ~/Library/Logs/Claude/mcp-server-mcp-obsidian.log

You must be authenticated.

A

security – no known vulnerabilities

A

license - permissive license

A

quality - confirmed to work