Obsidian Omnisearch MCP Server

local-only server

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

Integrations

  • Provides searchable access to Obsidian vault notes through the Omnisearch plugin, returning absolute file paths to matching notes based on search queries

MCP 서버 Obsidian Omnisearch

REST API 인터페이스를 통해 Obsidian 볼트 검색 기능을 제공하는 FastMCP 기반 서버입니다.

개요

이 프로젝트는 Obsidian 볼트 노트를 프로그래밍 방식으로 검색할 수 있는 검색 서비스를 구현합니다. FastMCP를 사용하여 검색 기능을 다른 서비스와 통합 가능한 도구로 제공합니다.

특징

  • 흑요석 보관소 노트 검색
  • REST API 통합
  • 일치하는 노트에 대한 절대 경로를 반환합니다.
  • FastMCP 도구와의 쉬운 통합

필수 조건

  • 파이썬 3.x
  • Omnisearch 플러그인이 설치되고 실행 중인 Obsidian
  • FastMCP 라이브러리
  • 활성 흑요석 금고

설치

Smithery를 통해 설치

Smithery를 통해 Claude Desktop용 MCP Server Obsidian Omnisearch를 자동으로 설치하려면:

지엑스피1

수동 설치

  1. 저장소를 복제합니다.
git clone https://github.com/anpigon/mcp-server-obsidian-omnisearch.git cd mcp-server-obsidian-omnisearch
  1. 종속성 설치:
uv install

구성

이제 서버를 실행할 때 Obsidian 볼트 경로가 명령줄 인수로 제공됩니다.

python server.py /path/to/your/obsidian/vault

용법

Obsidian Omnisearch API

Obsidian Omnisearch 커뮤니티 플러그인을 실행해야 합니다: https://publish.obsidian.md/omnisearch/Inject+Omnisearch+results+into+your+search+engine

클로드 데스크탑

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

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

{ "mcpServers": { "obsidian-omnisearch": { "command": "uv", "args": [ "--directory", "<dir_to>/mcp-server-obsidian-omnisearch", "run", "mcp-server-obsidian-omnisearch", "/path/to/your/obsidian/vault" ] } } }
{ "mcpServers": { "obsidian-omnisearch": { "command": "uvx", "args": [ "mcp-server-obsidian-omnisearch", "/path/to/your/obsidian/vault" ] } } }

API 참조

검색 노트

  • 함수: obsidian_notes_search(query: str)
  • 설명: Obsidian 노트를 검색하고 일치하는 노트의 절대 경로를 반환합니다.
  • 매개변수:
    • query : 검색 쿼리 문자열
  • 반환: 일치하는 노트에 대한 절대 경로 목록

개발

건축 및 출판

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

  1. 종속성 동기화 및 잠금 파일 업데이트:
uv sync
  1. 패키지 배포 빌드:
uv build

이렇게 하면 dist/ 디렉토리에 소스와 휠 배포판이 생성됩니다.

  1. PyPI에 게시:
uv publish

참고: 환경 변수나 명령 플래그를 통해 PyPI 자격 증명을 설정해야 합니다.

  • 토큰: --token 또는 UV_PUBLISH_TOKEN
  • 또는 사용자 이름/비밀번호: --username / UV_PUBLISH_USERNAME--password / UV_PUBLISH_PASSWORD

디버깅

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

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

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

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

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

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

종속성

  • 패스트MCP
  • 요청
  • URL 라이브러리

특허

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

기여하다

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

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

REST API 인터페이스를 통해 Obsidian 볼트에 대한 프로그래밍 방식 검색 기능을 제공하여 외부 애플리케이션이 메모를 검색하고 일치하는 문서의 절대 경로를 검색할 수 있도록 합니다.

  1. Overview
    1. Features
      1. Prerequisites
        1. Installation
          1. Installing via Smithery
          2. Manual Installation
        2. Configuration
          1. Usage
            1. Obsidian Omnisearch API
            2. Claude Desktop
          2. API Reference
            1. Search Notes
          3. Development
            1. Building and Publishing
            2. Debugging
          4. Dependencies
            1. License
              1. Contributing
                ID: cg8qcv2k9c