Obsidian MCP REST サーバー

ローカルREST APIを介してObsidian Vaultへのアクセスを提供するMCP（Model Context Protocol）サーバー実装。このサーバーにより、AIアシスタントは標準化されたインターフェースを介してObsidianノートを操作し、Vaultのコンテンツを管理できるようになります。

特徴

• MCP を通じて Obsidian Vault のコンテンツにアクセスします

• メモを読んだり書いたりする

• 保管庫の内容を一覧表示する

• 検索機能

• 安全なローカルREST API統合

• Claude Desktopやその他のAIアシスタントと互換性があります

Related MCP server: MCP Obsidian

前提条件

• Node.js 16以上

• ローカル REST API プラグインがインストールおよび構成された Obsidian

• ローカルREST APIが有効になっているObsidian Vault

インストール

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

npm install -g PublikPrinciple/obsidian-mcp-rest

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

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

構成

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

   • Obsidianにローカル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デスクトップの設定を開く

   • MCPセクションに移動する

   • 新しいサーバー構成を追加します:

     {
       "name": "obsidian-mcp",
       "command": "obsidian-mcp-rest",
       "args": ["--config", "path/to/config.json"]
     }

2. Claude は次のようなコマンドを使用して Obsidian Vault にアクセスできるようになりました。

   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

貢献

貢献を歓迎します！お気軽にプルリクエストを送信してください。大きな変更については、まずIssueを開いて、変更したい点について議論してください。

ライセンス

MITライセンス - 詳細はLICENSEファイルを参照