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 Vault 検索機能を提供する FastMCP ベースのサーバー。
概要
このプロジェクトは、Obsidian Vault のノートをプログラムで検索できる検索サービスを実装します。FastMCP を使用することで、検索機能を他のサービスと統合できるツールとして公開できます。
特徴
- Obsidian Vaultのノートを検索する
- REST API統合
- 一致するノートへの絶対パスを返します
- FastMCPツールとの簡単な統合
前提条件
- Python 3.x
- Omnisearchプラグインがインストールされ実行されているObsidian
- FastMCPライブラリ
- 現役の黒曜石保管庫
インストール
Smithery経由でインストール
Smithery経由で Claude Desktop 用の MCP Server Obsidian Omnisearch を自動的にインストールするには:
手動インストール
- リポジトリをクローンします。
- 依存関係をインストールします:
構成
サーバー実行時に、Obsidian の金庫パスがコマンド ライン引数として提供されるようになりました。
使用法
Obsidian オムニサーチ 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
APIリファレンス
検索ノート
- 関数:
obsidian_notes_search(query: str)
- 説明: Obsidian ノートを検索し、一致するノートへの絶対パスを返します
- パラメータ:
query
: 検索クエリ文字列
- 戻り値: 一致するノートへの絶対パスのリスト
発達
建築と出版
配布用のパッケージを準備するには:
- 依存関係を同期し、ロックファイルを更新します。
- パッケージディストリビューションをビルドします。
これにより、 dist/
ディレクトリにソースとホイールのディストリビューションが作成されます。
- PyPI に公開:
注: 環境変数またはコマンド フラグを使用して PyPI 資格情報を設定する必要があります。
- トークン:
--token
またはUV_PUBLISH_TOKEN
- またはユーザー名/パスワード:
--username
/UV_PUBLISH_USERNAME
および--password
/UV_PUBLISH_PASSWORD
デバッグ
MCPサーバーはstdio経由で実行されるため、デバッグが困難になる場合があります。最適なデバッグ環境を実現するには、 MCP Inspectorの使用を強くお勧めします。
次のコマンドを使用して、 npm
経由で MCP Inspector を起動できます。
起動すると、ブラウザでアクセスしてデバッグを開始できる URL がインスペクタに表示されます。
次のコマンドでサーバー ログを監視することもできます。
依存関係
- ファストMCP
- リクエスト
- urllib
ライセンス
このプロジェクトは MIT ライセンスに基づいてライセンスされています - 詳細についてはLICENSEファイルを参照してください。
貢献
貢献を歓迎します!お気軽にプルリクエストを送信してください。
This server cannot be installed
REST API インターフェースを通じて Obsidian Vault のプログラムによる検索機能を提供し、外部アプリケーションがメモを検索し、一致するドキュメントへの絶対パスを取得できるようにします。
- Overview
- Features
- Prerequisites
- Installation
- Configuration
- Usage
- API Reference
- Development
- Dependencies
- License
- Contributing