ObsiMCP

ObsiMCP

一个轻量、可扩展的 MCP 服务，用于自动执行 Obsidian 知识库中的操作，由 mcp-go 提供支持。 ObsiMCP 可帮助你高效管理 Obsidian 笔记并构建自己的个人知识库。

✨ 功能

• 📖 读取 Markdown 笔记
• 🔍 在整个知识库中搜索所有同名文件。
• ✍️ 向现有笔记写入内容，支持以下两种模式：
  • append 模式（添加到末尾）
  • overwrite 模式（替换文件内容）
• 🆕 创建新笔记
• 🗑️ 删除笔记
• 📁 列出指定文件夹中的文件和子文件夹（非递归）。
• 🏷 修改、添加和获取笔记中的 frontmatter
• ...

📦 要求

• Go 1.20+（较低版本可能也能运行，但我还没有尝试过。）
• 已初始化的 Obsidian 知识库目录

🚀 快速开始

git clone https://github.com/IAMLEIzZ/ObsiMCP.git
cd ObsiMCP
go build -o main main.go

根据需要，通过 config/config.yaml 文件或环境变量配置 vault 路径。

vault:
  path: "your osbidian vault path"

⚠️ BackUpDir 配置

为保护你的文件，必须设置备份文件夹。使用 mcp-server 覆盖或删除文件时，系统会自动生成备份文件，以防 AI 助手操作不稳定。（你可以定期手动删除过期的备份文件，我们之后会考虑添加自动删除功能。）

backup:
  path: "your backup dir"

🧠 使用场景

• 构建能够理解和修改笔记的 Agent 或副驾驶。
• 将 Obsidian 与外部应用或大模型集成。
• 自动执行笔记维护、重命名或内容更新。

例如，在 deepchat 中可以这样启动（请同时开启文件的读写权限）

{
  "mcpServers": {
    "ObsiMCP": {
      "command": "Your The absolute path to your main executable", 
      "args": [],
      "shell": false,
      "env": {}
    }
  }
}

🛠 工具定义示例

MCP 服务中的每个工具都对应一项操作：

工具名称	描述
ReadNote	从指定的 Markdown 文件中读取内容。
GetNote	查找知识库中所有名称匹配的笔记。
WriteNote	向现有笔记追加或覆盖内容。
CreateANote	创建不含初始内容的新笔记。
DeleteNote	按名称删除笔记并进行备份。
GetNoteList	列出指定文件夹中的文件和子文件夹。
MoveOneNote	将笔记移动到另一个文件夹。
GetNoteList	列出指定文件夹中的文件和子文件夹。
FindAllFolderByName	根据文件夹名称查找知识库中所有同名文件夹。
CreateFolder	删除指定名称的文件夹。
GetNoteFrontmatter	获取笔记的 frontmatter 信息
AddFrontmatter	向笔记添加 frontmatter 信息
GetNotetags	向笔记添加标签
...	...

🔗 参考

• mcp-go

📄 许可证

MIT License. Feel free to use, modify, and contribute!