Obsidian MCP REST 서버

로컬 REST API를 통해 Obsidian 볼트에 대한 액세스를 제공하는 MCP(Model Context Protocol) 서버 구현입니다. 이 서버를 통해 AI 어시스턴트는 표준화된 인터페이스를 통해 Obsidian 노트와 상호 작용하고 볼트 콘텐츠를 관리할 수 있습니다.

특징

• MCP를 통해 Obsidian 보관소 콘텐츠에 액세스하세요

• 노트 읽기 및 쓰기

• 볼트 내용 나열

• 검색 기능

• 안전한 로컬 REST API 통합

• Claude Desktop 및 기타 AI 어시스턴트와 호환 가능

Related MCP server: Obsidian MCP Server

필수 조건

• Node.js 16 이상

• 로컬 REST API 플러그인이 설치 및 구성된 Obsidian

• 로컬 REST API가 활성화된 Obsidian 볼트

설치

패키지를 전역으로 설치합니다.

지엑스피1

또는 특정 버전/브랜치를 사용하는 것을 선호하는 경우:

npm install -g PublikPrinciple/obsidian-mcp-rest#main

구성

1. 먼저 Obsidian Local REST API 플러그인을 구성합니다.

   • Obsidian에 로컬 REST API 플러그인 설치

   • API 포트를 구성합니다(기본값: 27123)

   • API 키 생성 및 저장

2. config.json 구성 파일을 만듭니다.

{
  "obsidian": {
    "apiKey": "your-api-key-here",
    "port": 27123,
    "host": "localhost"
  },
  "server": {
    "name": "obsidian-mcp",
    "version": "1.0.0"
  }
}

용법

1. 서버를 시작합니다:

obsidian-mcp-rest --config path/to/config.json

2. 서버가 시작되어 stdin/stdout을 통해 MCP 요청을 수신합니다.

Claude Desktop과 함께 사용

1. 이 MCP 서버를 사용하도록 Claude Desktop을 구성하세요.

   • Claude Desktop 설정 열기

   • MCP 섹션으로 이동

   • 새로운 서버 구성을 추가합니다.

     {
       "name": "obsidian-mcp",
       "command": "obsidian-mcp-rest",
       "args": ["--config", "path/to/config.json"]
     }

2. 이제 Claude는 다음과 같은 명령을 통해 Obsidian 보관소에 액세스할 수 있습니다.

   Read note "Projects/MyProject.md"
   List all notes in "Projects" folder
   Search for notes containing "typescript"

사용 가능한 도구

• listNotes : 보관소 또는 특정 폴더에 있는 모든 노트를 나열합니다.

• readNote : 특정 노트의 내용을 읽습니다.

• writeNote : 메모를 생성하거나 업데이트합니다.

• searchNotes : 쿼리 문자열을 사용하여 노트 검색

• getMetadata : 특정 노트에 대한 메타데이터를 가져옵니다.

보안

• 서버는 로컬에서만 실행되며 stdin/stdout을 통해 통신합니다.

• Obsidian REST API에 대한 모든 요청은 API 키로 인증됩니다.

• 외부 네트워크 접속이 필요하지 않습니다

• 데이터는 귀하의 컴퓨터에 로컬로 유지됩니다.

개발

1. 저장소를 복제합니다.

git clone https://github.com/PublikPrinciple/obsidian-mcp-rest.git
cd obsidian-mcp-rest

2. 종속성 설치:

npm install

3. 프로젝트를 빌드하세요:

npm run build

4. 테스트 실행:

npm test

문제 해결

설치 문제

설치 문제가 발생하면 다음 대안을 시도해 보세요.

1. 로컬로 복제하고 설치:

git clone https://github.com/PublikPrinciple/obsidian-mcp-rest.git
cd obsidian-mcp-rest
npm install
npm run build
npm install -g .

2. TypeScript 관련 오류가 표시되면 TypeScript가 전역적으로 설치되어 있는지 확인하세요.

npm install -g typescript

기여하다

기여를 환영합니다! 풀 리퀘스트를 제출해 주세요. 주요 변경 사항의 경우, 먼저 이슈를 열어 변경 사항을 논의해 주세요.

특허

MIT 라이센스 - 자세한 내용은 라이센스 파일을 참조하세요.