Obsidian MCP Server R3c

🚀 OBSIDIAN-MCP-SERVER

OBSIDIAN-MCP-SERVER 是一個與 LLM Agent 對接的 Model Context Protocol (MCP) Stdio 服務器。它基於 Python 為 LLM Agent 提供 Obsidian 相關功能，讓其能夠充分利用 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
}

📚 詳細文檔

錯誤代碼

響應格式

成功響應

{
    "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 服務器主腳本的路徑。

📄 許可證

[此處插入許可證內容]