Obsidian MCP Local Server

🚀 Obsidian MCP (モデルコンテキストプロトコル) サーバー

このプロジェクトは、AIモデルとObsidianの知識ベースを接続するためのModel Context Protocol (MCP) サーバーを実装しています。このサーバーを通じて、AIモデルはノートの読み取り、作成、更新、削除、フォルダの管理、および全文検索を行うことができます。

🚀 クイックスタート

このサーバーを使用することで、AIモデルとObsidianの知識ベースをシームレスに接続できます。以下の手順に従って、サーバーをセットアップしてください。

✨ 主な機能

• AIモデルがObsidianのノートを読み取り、作成、更新、削除できます。
• フォルダの管理と全文検索が可能です。

📦 インストール

前提条件

• Node.js v16以上
• Obsidianデスクトップアプリケーションがインストールされていること
• Obsidian Local REST APIプラグインがインストールされ、設定されていること

インストール手順

1. リポジトリをクローンする

   git clone https://github.com/yourusername/obsidian-mcp-server.git
   

2. 依存関係をインストールする

   npm install
   

3. プロジェクトをビルドする

   npm run build
   

📚 ドキュメント

設定

プロジェクトの設定は環境変数を通じて行います。以下の重要な環境変数を設定する必要があります。

• VAULT_PATH：Obsidianの知識ベースの保存パス。
• API_KEY：Obsidian Local REST APIのアクセストークン。
• PORT：サーバーが動作するポート番号。デフォルトは3000です。

.envファイルの例：

VAULT_PATH=/path/to/obsidian-vault
API_KEY=your_api_key_here
PORT=3000

注意：機密情報を含む.envファイルをバージョン管理システムにコミットしないでください。

使用方法

1. 直接実行 プロジェクトのルートディレクトリで以下のコマンドを実行してサーバーを起動します。

   npm start
   

2. Dockerでデプロイする Dockerイメージをビルドした場合は、以下のコマンドでコンテナを起動できます。

   docker run -it --env-file .env yourusername/obsidian-mcp-server
   

サポートされるツール

MCPサーバーは以下の機能モジュールを提供します。

• list_notes：知識ベース内のすべてのノートをリストします。
• read_note：指定されたノートの内容を読み取ります。
• create_note：新しいノートを作成します。
• update_note：既存のノートの内容を更新します。
• search_vault：知識ベース内で内容を検索します。
• delete_note：指定されたノートを削除します。
• manage_folder：フォルダの管理（作成、名前変更、移動、削除）を行います。

開発

1. 開発モード 以下のコマンドを使用して、開発モードでサーバーを実行します。

   npm run dev
   

2. ソースコードの構造 ソースコードはsrcディレクトリにあります。主なファイルは以下の通りです。
   • server.js：メインのサーバーエントリーファイル。
   • notes.js と folders.js：ノートとフォルダの操作を処理するビジネスロジックファイル。

テスト

プロジェクトには、サーバーの機能を検証するためのテストスクリプトが用意されています。

node test-mcp.js

📄 ライセンス

ISC

貢献

Pull RequestsとIssuesの投稿を歓迎します！皆さんの貢献を心から感謝しています。

関連プロジェクト

• Model Context Protocol：モデルコンテキストプロトコルの公式実装。
• Obsidian Local REST API：Obsidianの知識ベースとやり取りするためのローカルREST APIプラグイン。