coddingtonbear/obsidian-local-rest-api
A secure REST API and Model Context Protocol (MCP) server for your vault.
무엇인가요
obsidian-local-rest-api 는 데스크톱 앱 내부에 작고 안전한 HTTPS 서버를 실행하는 Obsidian 플러그인입니다. 이 서버는 외부 프로그램(스크립트, 브라우저 확장 프로그램, AI 에이전트 등)이 백업 파일 내의 노트를 읽고, 쓰고, 검색하고, 조작할 수 있도록 REST API(및 내장된 Model Context Protocol – MCP 서버)를 제공합니다.
핵심 기능
| 기능 | 작동 방식 |
|---|---|
| 파일 CRUD | /vault/{path} 에 대해 GET/PUT/POST/PATCH/DELETE 를 사용하면, 마크다운 또는 바이너리 파일을 가져오거나, 생성하거나, 대체하거나, 부분 수정하거나, 삭제할 수 있습니다. |
| 정밀 편집 | PATCH (JSON 본문 또는 헤더 기반의 "raw-content" 모드)를 사용하면, 전체 파일을 다시 쓰지 않고도 단일 헤딩, 블록 참조, 또는 프론트마터 키를 추가, 앞에 추가, 대체, 삭제, 이동할 수 있습니다. |
| 활성 파일 | /active/ 는 현재 Obsidian UI 에서 열려 있는 노트를 미러하므로, 에이전트가 작업 중인 파일을 읽거나 업데이트할 수 있습니다. |
| 검색 | /search/simple/ 는 Obsidian의 퍼지 검색을 실행합니다. /search/ 는 JsonLogic 식을 받아 메타데이터(태그, 프론트마터, 경로, 콘텐츠) 기반으로 필터링합니다. |
| 명령어 및 UI | /commands/ 는 모든 Obsidian 명령어를 목록으로 보여줍니다. /commands/{id}/ 에 POST 하면 하나의 명령어를 실행합니다. /open/{path} 는 UI 에 노트를 열도록 지시합니다. |
| 태그 개요 | /tags/ 는 백업 내 모든 태그와 사용 횟수를 반환합니다. |
| MCP 서버 | 동일한 기능은 Model Context Protocol (/mcp/) 를 통해도 접근 가능하며, Claude Code, Claude Desktop (mcp-remote 를 통해), Cursor 등의 AI 도구에서 사용됩니다. |
| 확장성 | 다른 플러그인은 제공된 확장 API 를 통해 추가 경로나 MCP 도구를 등록할 수 있습니다. |
어떻게 연결하나요
- 서버는
https://127.0.0.1:27124/(자체 서명 인증서 포함 HTTPS) 에서 작동하며, 필요 시http://127.0.0.1:27123/(HTTP) 에서도 작동 가능합니다. - 인증은 Bearer 토큰 으로, Obsidian의 설정 → 로컬 REST API 에 표시됩니다.
- 백업 루트를 목록으로 보여주는 curl 예시:
curl -k -H "Authorization: Bearer <key>" https://127.0.0.1:27124/vault/
- MCP 호환 클라이언트의 경우,
https://127.0.0.1:27124/mcp/를 엔드포인트로 지정하고 동일한 베어러 토큰을 제공합니다.
AI 에게 왜 중요한가요
AI 에이전트는 종종 지식 기반에 실시간 접근이 필요합니다. 표준 HTTP API 를 통해 백업을 노출함으로써, LLM 기반 보조 도구(Claude, Cursor, 커스텀 봇 등)는 수동 복사/붙여넣기 없이 컨텍스트 읽기, 노트 업데이트, 검색 실행, Obsidian 명령어 실행 이 가능해집니다. MCP 계층은 스트리밍 및 세션 인식 프로토콜을 제공하며, 현재의 Model Context Protocol 사양과 일치하여, 이미 MCP 를 이해하는 도구들과의 통합을 더 원활하게 만듭니다.
시작하기
- Obsidian 커뮤니티 플러그인 스토어에서 플러그인을 설치합니다.
- 활성화하고 생성된 API 키를 기록하며, 자체 서명 인증서를 다운로드합니다.
- https://coddingtonbear.github.io/obsidian-local-rest-api/ 에서 인터랙티브한 Swagger 유사 문서를 사용해 요청 예제를 확인합니다.
- README 에 나와 있는 대로 AI 클라이언트(Claude Code, Claude Desktop (
mcp-remote를 통해), Cursor 등)를 엔드포인트와 토큰으로 설정합니다.
누구에게 유용한가요
- 자신의 노트를 읽고 쓸 수 있는 개인용 AI 보조 도구를 개발하는 개발자.
- 외부 데이터 소스와 백업을 동기화하고 싶은 자동화 스크립트.
- LLM 기반 노트 작성 또는 지식 그래프 구축을 실험하는 연구자.
TL;DR: 안전하고 인증된 HTTP 인터페이스(REST + MCP)를 제공하는 Obsidian 플러그인으로, 스크립트와 AI 에이전트가 백업을 원격 파일 시스템처럼 다룰 수 있으며, 세밀한 패치, 검색, 명령어 실행, 확장성 기능을 갖추고 있습니다.
관련
- 프로젝트
- 프로젝트
- 프로젝트
- 프로젝트
- 프로젝트