Obsidian MCP
Integrations
Uses environment variables for configuration, supporting .env files to store connection settings like vault path, API token, and port for the Obsidian Local REST API.
Supports installation via Git clone and includes configuration for version control with .gitignore to protect sensitive configuration files.
Hosts the project repository with links to related projects and installation instructions for cloning from GitHub.
Obsidian MCP (Model Context Protocol) 服务器
English | 中文
这个项目实现了一个 Model Context Protocol (MCP) 服务器，用于连接 AI 模型与 Obsidian 知识库。通过这个服务器，AI 模型可以直接访问和操作 Obsidian 笔记，包括读取、创建、更新和删除笔记，以及管理文件夹结构。
功能特点
- 与 Obsidian 知识库的无缝集成
- 支持笔记的读取、创建、更新和删除
- 支持文件夹的创建、重命名、移动和删除
- 支持全文搜索功能
- 符合 Model Context Protocol 规范
前提条件
- Node.js (v16 或更高版本)
- Obsidian 桌面应用
- Obsidian Local REST API 插件 (需要在 Obsidian 中安装)
安装
- 克隆此仓库：
- 安装依赖：
- 构建项目：
配置
服务器通过环境变量进行配置：
OBSIDIAN_VAULT_PATH: Obsidian 知识库的路径OBSIDIAN_API_TOKEN: Obsidian Local REST API 插件的 API 令牌OBSIDIAN_API_PORT: Obsidian Local REST API 插件的端口号 (默认为 27123)
您可以通过以下方式设置环境变量：
- 复制
.env.example文件为.env并编辑其中的值：
- 编辑
.env文件，填入您的实际配置：
注意： .env 文件包含敏感信息，已被添加到 .gitignore 中，不会被提交到版本控制系统。
使用方法
- 确保 Obsidian 正在运行，并且已安装和配置了 Local REST API 插件
- 启动 MCP 服务器：
- 服务器将通过标准输入/输出与 AI 模型通信
测试
项目包含一个测试脚本，用于验证服务器功能：
支持的工具
MCP 服务器提供以下工具：
list_notes: 列出知识库中的所有笔记read_note: 读取指定笔记的内容create_note: 创建新笔记update_note: 更新现有笔记search_vault: 在知识库中搜索内容delete_note: 删除笔记manage_folder: 管理文件夹 (创建、重命名、移动、删除)
开发
- 使用
npm run dev在开发模式下运行服务器 - 源代码位于
src目录中
许可证
ISC
贡献
欢迎提交 Pull Requests 和 Issues！
相关项目
This server cannot be installed
This project implements a Model Context Protocol (MCP) server for connecting AI models with Obsidian knowledge bases. Through this server, AI models can directly access and manipulate Obsidian notes, including reading, creating, updating, and deleting notes, as well as managing folder structures.