Obsidian MCP Rest

🚀 Obsidian MCP REST サーバー

このサーバーは、Model Context Protocol (MCP) を実装し、ローカルの REST API を通じて Obsidian ノートのボールトへのアクセスを提供します。これにより、AI アシスタントは標準化されたインターフェースを介して Obsidian ノートとやり取りし、ボールトの内容を管理することができます。

✨ 主な機能

• MCP を通じた Obsidian ボールト内容のアクセス
• ノートの読み取りと書き込み
• ボールト内容の一覧表示
• 検索機能
• 安全なローカル REST API の統合
• Claude Desktop やその他の AI アシスタントとの互換性

📦 インストール

グローバルインストール

npm install -g PublikPrinciple/obsidian-mcp-rest

特定のバージョン/ブランチを使用する場合

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

🔧 設定

Obsidian Local REST API プラグインの設定

1. Obsidian で Local REST API プラグインをインストールします。
2. API ポートを設定します（デフォルト: 27123）。
3. API キーを生成し、保存します。

設定ファイル config.json の作成

{
  "obsidian": {
    "apiKey": "your-api-key-here",
    "port": 27123,
    "host": "localhost"
  },
  "server": {
    "name": "obsidian-mcp",
    "version": "1.0.0"
  }
}

💻 使用例

サーバーの起動

obsidian-mcp-rest --config path/to/config.json

サーバーが起動し、stdin/stdout を介した MCP リクエストを待機します。

Claude Desktop との統合

Claude Desktop の設定

1. Claude Desktop の設定を開きます。
2. MCP セクションに移動します。
3. 新しいサーバー設定を追加します。

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

Claude からのアクセス例

読み取りノート "Projects/MyProject.md"
"Projects" フォルダ内のすべてのノートを一覧表示
"typescript" を含むノートを検索

利用可能なツール

⚠️ セキュリティに関する注意事項

• すべての API リクエストは生成された API キーを使用して認証されます。
• サーバーはローカルネットワークからのアクセスのみを許可し、外部からのアクセスを防止します。
• データはローカルデバイスに保存され、いかなるサーバーにもアップロードされません。

🔨 開発

リポジトリのクローン

git clone https://github.com/PublikPrinciple/obsidian-mcp-rest.git

依存関係のインストール

cd obsidian-mcp-rest
npm install

プロジェクトのビルド

npm run build

テストの実行

npm test

🐞 トラブルシューティング

インストールが失敗した場合は、手動でリポジトリをクローンし、その中でインストールとビルドコマンドを実行してみてください。また、Node.js やその他の依存関係が正しくインストールされていることを確認してください。

🤝 コントリビューション

Pull Request の送信を歓迎します！重大な変更については、まず問題を通じてフィードバックを得るために議論してください。

📄 ライセンス

このプロジェクトは MIT ライセンスの下で提供されています。詳細については LICENSE ファイルを参照してください。