MCP Obsidian

by gregkonush
Verified
MIT License
1,801
1

Integrations

  • Allows AI assistants to read, create, and manipulate notes in Obsidian vaults, with capabilities for reading active files, deleting files, inserting content at specific positions, appending content, opening files, listing vault files, and searching through notes.

MCP 옵시디언

Obsidian 과 통합하기 위한 모델 컨텍스트 프로토콜(MCP) 의 서버 구현입니다. 이를 통해 AI 비서가 Obsidian 저장소의 노트를 읽고, 생성하고, 조작할 수 있습니다.

특징

  • Obsidian에서 활성 파일 읽기
  • 활성 파일 삭제
  • 특정 위치(제목, 블록 참조, 프런트매터)에 콘텐츠 삽입
  • 파일에 내용 추가
  • 특정 파일 열기
  • 보관소에 있는 파일 나열
  • 노트를 검색하세요

필수 조건

  • 런타임
  • Obsidian 데스크톱 애플리케이션
  • MCP 호환 AI 어시스턴트

커서에 추가

.env 파일에 비밀을 입력하세요.

MCP 명령을 선택한 후 이 명령을 입력하세요.

지엑스피1

설치

  1. 이 저장소를 복제하세요:
    git clone https://github.com/gregkonush/mcp-obsidian.git cd mcp-obsidian
  2. 종속성 설치:
    bun install
  3. 예제 환경 파일을 복사하여 구성합니다.
    cp .env.example .env

구성

특정 구성으로 .env 파일을 편집합니다.

OBSIDIAN_BASE_URL=http://localhost:27123 OBSIDIAN_TOKEN=your_token_here DEBUG=false

용법

MCP 서버를 시작합니다.

bun run src/index.ts

서버는 표준 I/O를 통해 MCP 호환 AI 어시스턴트와 시작 및 통신합니다.

사용 가능한 도구

이 구현은 AI 어시스턴트에게 다음과 같은 도구를 제공합니다.

  • get_active_file - 현재 활성화된 파일의 내용을 반환합니다.
  • delete_active_file - 현재 활성화된 파일을 삭제합니다.
  • insert_active_file - 제목, 블록 참조 또는 프런트매터 필드를 기준으로 콘텐츠를 수정합니다.
  • append_active_file - 활성 파일의 끝에 내용을 추가합니다.
  • open_file - Obsidian에서 특정 파일을 엽니다.
  • search_simple - 텍스트 쿼리와 일치하는 문서를 검색합니다.
  • list_files - 볼트의 루트 디렉토리에 있는 파일을 나열합니다.
  • list_directory_files - 볼트의 특정 디렉토리에 있는 파일을 나열합니다.

개발

프로젝트 구조

mcp-obsidian/ ├── src/ │ ├── index.ts # Main server implementation │ └── tools/ # Individual tool implementations │ ├── get-active-file.ts │ ├── delete-active-file.ts │ └── ... ├── .env # Environment configuration ├── package.json # Project dependencies └── tsconfig.json # TypeScript configuration

새로운 도구 추가

새로운 도구를 추가하려면:

  1. src/tools/ 디렉토리에 새 파일을 만듭니다.
  2. MCP SDK를 사용하여 도구 구현
  3. src/index.ts 에 도구를 가져와 등록합니다.

특허

이 프로젝트는 MIT 라이선스에 따라 라이선스가 부여되었습니다. 자세한 내용은 LICENSE.md 파일을 참조하세요.

기여하다

기여를 환영합니다! 풀 리퀘스트를 제출해 주세요.

-
security - not tested
A
license - permissive license
-
quality - not tested

모델 컨텍스트 프로토콜을 통해 AI 어시스턴트가 Obsidian 볼트에서 메모를 읽고, 만들고, 조작할 수 있도록 하는 서버 구현입니다.

  1. Features
    1. Prerequisites
      1. Add to cursor
        1. Installation
          1. Configuration
            1. Usage
              1. Available Tools
                1. Development
                  1. Project Structure
                  2. Adding New Tools
                2. License
                  1. Contributing
                    ID: 4jgajfksuj