Obsidian MCP REST Server

Obsidian MCP REST Server

ローカル REST API を通じて Obsidian の保管庫にアクセスできる MCP（Model Context Protocol）サーバーの実装です。このサーバーを使用すると、AI アシスタントが標準化されたインターフェースを通じて Obsidian のノートを操作し、保管庫のコンテンツを管理できます。

機能

• MCP を通じて Obsidian の保管庫のコンテンツにアクセス
• ノートの読み取りと書き込み
• 保管庫のコンテンツを一覧表示
• 検索機能
• セキュアなローカル REST API 連携
• Claude Desktop およびその他の AI アシスタントに対応

前提条件

• Node.js 16 以降
• Local REST API プラグインをインストールして設定した Obsidian
• Local REST API が有効になっている Obsidian の保管庫

インストール

パッケージをグローバルにインストールします。

npm install -g PublikPrinciple/obsidian-mcp-rest

特定のバージョン／ブランチを使用する場合は、次のようにします。

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

設定

1. まず、Obsidian Local REST API プラグインを設定します。

   • Obsidian に Local 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 License — 詳細は LICENSE ファイルをご覧ください。