JinDaGe - obsidian-mcp-server-r3c MCP Details

article

README

🚀 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
}

📚 详细文档

错误代码

| 错误代码 | 错误描述 | | ---- | ---- | | -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"
    }
}

确保：

/path/to/venv/bin/python 是运行 MCP 服务器的 Python 可执行文件路径。
/path/to/main.py 是 MCP 服务器主脚本的路径。

📄 许可证

[此处插入许可证内容]

obsidian-mcp-server-r3c