Obsidian MCP Server R3c

🚀 OBSIDIAN-MCP-SERVER

Model Context Protocol (MCP) Stdio サーバーで、LLM Agent と接続します。このサーバーは、Python ベースの Obsidian 関連機能を LLM Agent に提供し、Obsidian の機能を活用できるようにします。

🚀 クイックスタート

このサーバーは、LLM Agent と接続し、Obsidian の関連機能を提供します。以下に、サーバーのインストールと使用方法を説明します。

✨ 主な機能

知識ベース管理

• 知識ベースの作成
• 知識ベースの削除
• 知識ベースのリスト照会
• 知識ベースの情報照会
• 知識ベースの設定照会
• 知識ベースの設定変更

ファイル管理

• 知識ベースのファイルリスト照会
• 知識ベースのファイル作成（新規作成/編集）
• 知識ベースのファイル削除

📦 インストール

1. リポジトリのクローン

git clone https://github.com/your-username/obsidian-mcp-server.git
cd obsidian-mcp-server

2. 仮想環境の作成とアクティブ化

python -m venv venv
source venv/bin/activate  # Linux/Mac システム
# または
.\venv\Scripts\activate  # Windows システム

3. 依存関係のインストール

pip install -r requirements.txt

4. 環境変数の設定

.env ファイルを作成し、以下の内容を追加します。

OBSIDIAN_VAULT_PATH=/path/to/your/obsidian/vault

💻 使用例

サーバーの起動

python main.py

API の使用例

知識ベースの作成

{
    "jsonrpc": "2.0",
    "method": "create_vault",
    "params": {
        "vault_name": "my_vault",
        "path": "/optional/custom/path"
    },
    "id": 1
}

知識ベースのリスト照会

{
    "jsonrpc": "2.0",
    "method": "list_vaults",
    "params": {},
    "id": 2
}

ファイルの作成

{
    "jsonrpc": "2.0",
    "method": "write_vault_file",
    "params": {
        "vault_name": "my_vault",
        "file_path": "notes/example.md",
        "content": "# Example Note\n\nThis is a test note."
    },
    "id": 3
}

📚 ドキュメント

エラーコード

• -32000: 一般的なエラー
• -32001: 知識ベースが見つからない
• -32002: 知識ベースが既に存在する
• -32003: ファイルが見つからない
• -32004: パスが見つからない
• -32005: 設定ファイルが見つからない
• -32006: 設定エラー
• -32007: ファイル操作エラー
• -32008: リクエストエラー
• -32009: 環境変数の設定エラー
• -32010: Obsidian ディレクトリエラー

応答形式

成功応答

{
    "jsonrpc": "2.0",
    "id": 1,
    "result": {
        "status": "success",
        "message": "Vault created successfully"
    }
}

失敗応答

{
    "jsonrpc": "2.0",
    "id": 1,
    "error": {
        "code": -32001,
        "message": "Vault not found"
    }
}

Cursor のインストール手順

このサーバーを Cursor と一緒に使用するには、config.json に以下の設定を追加してください。

{
    "mcp_server": {
        "command": "/path/to/venv/bin/python",
        "script_path": "/path/to/main.py"
    }
}

以下を確認してください。

1. /path/to/venv/bin/python は、MCP サーバーを実行する Python 実行ファイルのパスです。
2. /path/to/main.py は、MCP サーバーのメインスクリプトのパスです。

📄 ライセンス

[ここにライセンスの内容を挿入]