OBSIDIAN-MCP-SERVER

基本能力

产品定位

OBSIDIAN-MCP-SERVER 是一个用于与 LLM Agent 集成的 Obsidian 功能支持服务器，提供 Vault 和文件管理功能。

核心功能

• Vault 管理：
• Vault 创建
• Vault 删除
• Vault 列表查询
• Vault 信息查询
• Vault 设置查询
• Vault 设置修改
• 文件管理：
• Vault 文件列表查询
• Vault 文件创建/修改
• Vault 文件删除

适用场景

• 需要与 LLM Agent 集成以自动化管理 Obsidian Vault 和文件的场景。
• 需要批量操作 Obsidian Vault 和文件的开发或管理任务。

工具列表

• Vault 管理工具：提供 Vault 的创建、删除、查询和设置功能。
• 文件管理工具：提供文件的列表查询、创建/修改和删除功能。

常见问题解答

• 错误代码：
• -32000: 一般错误
• -32001: Vault 未找到
• -32002: Vault 已存在
• -32003: 文件未找到
• -32004: 路径未找到
• -32005: 配置文件未找到
• -32006: 无效配置
• -32007: 文件操作错误
• -32008: 无效请求
• -32009: 环境变量设置错误
• -32010: Obsidian 目录错误

使用教程

使用依赖

1. 克隆存储库：

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

1. 创建并激活虚拟环境：

python -m venv venv
source venv/bin/activate  # Linux/Mac
# 或
.\venv\Scripts\activate  # Windows

1. 安装依赖：

pip install -r requirements.txt

1. 设置环境变量： 在 .env 文件中添加：

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

安装教程

1. 完成上述依赖安装后，直接运行主程序：

python main.py

调试方式

1. 确保环境变量正确设置。
2. 运行主程序并检查日志输出。
3. 使用 API 示例进行功能测试。

API 使用示例

Vault 创建

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

Vault 列表查询

{
    "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
}

许可证

该项目遵循 MIT 开源许可条款。