MCP Obsidian

by gregkonush
Verified
MIT License
1,801
1

Integrations

  • Allows AI assistants to read, create, and manipulate notes in Obsidian vaults, with capabilities for reading active files, deleting files, inserting content at specific positions, appending content, opening files, listing vault files, and searching through notes.

MCP オブシディアン

Obsidianとの統合のためのモデルコンテキストプロトコル(MCP)のサーバー実装。これにより、AIアシスタントがObsidian Vault内のメモを読み取り、作成、操作できるようになります。

特徴

  • Obsidianでアクティブファイルを読む
  • アクティブなファイルを削除する
  • 特定の位置にコンテンツを挿入する(見出し、ブロック参照、前付)
  • ファイルにコンテンツを追加する
  • 特定のファイルを開く
  • 保管庫内のファイルを一覧表示する
  • メモを検索する

前提条件

  • Bunランタイム
  • Obsidianデスクトップ アプリケーション
  • MCP対応AIアシスタント

カーソルに追加

秘密を.envファイルに置く

コマンドMCPを選択し、このコマンドを入力します

bun __REPO_PATH__/src/index.ts

インストール

  1. このリポジトリをクローンします:
    git clone https://github.com/gregkonush/mcp-obsidian.git cd mcp-obsidian
  2. 依存関係をインストールします:
    bun install
  3. サンプル環境ファイルをコピーして設定します。
    cp .env.example .env

構成

特定の構成で.envファイルを編集します。

OBSIDIAN_BASE_URL=http://localhost:27123 OBSIDIAN_TOKEN=your_token_here DEBUG=false

使用法

MCP サーバーを起動します。

bun run src/index.ts

サーバーが起動し、標準 I/O を介して MCP 互換の AI アシスタントと通信します。

利用可能なツール

この実装では、AI アシスタントに次のツールが提供されます。

  • get_active_file - 現在アクティブなファイルの内容を返します
  • delete_active_file - 現在アクティブなファイルを削除します
  • insert_active_file - 見出し、ブロック参照、またはfrontmatterフィールドを基準にしてコンテンツを変更します
  • append_active_file - アクティブファイルの末尾にコンテンツを追加します
  • open_file - Obsidianで特定のファイルを開く
  • search_simple - テキストクエリに一致するドキュメントを検索します
  • list_files - ボールトのルートディレクトリ内のファイルを一覧表示します
  • list_directory_files - ボールト内の特定のディレクトリにあるファイルを一覧表示します

発達

プロジェクト構造

mcp-obsidian/ ├── src/ │ ├── index.ts # Main server implementation │ └── tools/ # Individual tool implementations │ ├── get-active-file.ts │ ├── delete-active-file.ts │ └── ... ├── .env # Environment configuration ├── package.json # Project dependencies └── tsconfig.json # TypeScript configuration

新しいツールの追加

新しいツールを追加するには:

  1. src/tools/ディレクトリに新しいファイルを作成する
  2. MCP SDKを使用してツールを実装する
  3. src/index.tsにツールをインポートして登録します。

ライセンス

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

貢献

貢献を歓迎します!お気軽にプルリクエストを送信してください。

-
security - not tested
A
license - permissive license
-
quality - not tested

AI アシスタントがモデル コンテキスト プロトコルを通じて Obsidian ボールト内のメモを読み取り、作成、操作できるようにするサーバー実装。

  1. Features
    1. Prerequisites
      1. Add to cursor
        1. Installation
          1. Configuration
            1. Usage
              1. Available Tools
                1. Development
                  1. Project Structure
                  2. Adding New Tools
                2. License
                  1. Contributing
                    ID: 4jgajfksuj