About ObsiMCP
ObsiMCP is a lightweight, extensible MCP server for automating operations on Obsidian vaults. It is for people managing notes or building personal knowledge bases, and creates backups before overwriting or deleting notes.
Key features
- 01Read Markdown notes
- 02Search notes by file name
- 03Append or overwrite note content
- 04Create, delete, and move notes
- 05Manage frontmatter and tags
- 06List folder contents
Use cases
- 01Build agents that read and modify notes
- 02Access Obsidian from external apps
- 03Automate note maintenance and updates
- 04Keep backups before deleting or overwriting notes
MCP support
It exposes Obsidian vault operations as tools to MCP clients, including note reading and writing, search, folder management, and frontmatter operations.
Configuration
Local server config is the same for every client. Copy it into your client’s MCP config file.
We haven’t collected a package or remote endpoint for this server. Follow the instructions in the project README.
Tools
Local servers expose tools only once running on your machine, and the maintainer has not provided a tool list.
Details
From the project READMEObsiMCP
A lightweight, extendable MCP server for automating operations on Obsidian vaults, powered by mcp-go. ObsiMCP helps you efficiently manage your Obsidian notes and build your own personal knowledge base.
✨ Features
- 📖 Read a Markdown note
- 🔍 Search all notes with the same file name across the entire vault.
- ✍️ Write content to an existing note, supporting both:
appendmode (adds to the end)overwritemode (replaces the file content)
- 🆕 Create a new note
- 🗑️ Delete a note
- 📁 List files and subfolders within a given folder (non-recursive).
- 🏷 Modify, add, and get the frontmatter in Note
- ...
📦 Requirements
- Go 1.20+ (The lower version may work, but I haven't tried it yet.)
- An initialized Obsidian vault directory
🚀 Getting Started
git clone https://github.com/IAMLEIzZ/ObsiMCP.git
cd ObsiMCP
go build -o main main.go
Configure your vault path via the config/config.yaml file or environment variable as needed.
vault:
path: "your osbidian vault path"
⚠️ The BackUpDir Config
To protect your files, you must set up a backup folder. When you use mcp-server to overwrite or delete, a backup file will be automatically generated to prevent your AI assistant from unstable operation. (You can manually delete outdated backup files regularly, and we will consider adding an automatic deletion function later.)
backup:
path: "your backup dir"
🧠 Use Cases
- Build agents or copilots that understand and modify your notes.
- Integrate with Obsidian from external apps or LLMs.
- Automate note maintenance, renaming, or content updates.
For example, in deepchat you can start it like this (Please open the file read and write permissions at the same time)
{
"mcpServers": {
"ObsiMCP": {
"command": "Your The absolute path to your main executable",
"args": [],
"shell": false,
"env": {}
}
}
}
🛠 Example Tool Definitions
Each tool in the MCP server corresponds to an operation:
| Tool Name | Description |
|---|---|
ReadNote | Reads content from a given Markdown file. |
GetNote | Finds all notes in the vault with a matching name. |
WriteNote | Appends or overwrites content in an existing note. |
CreateANote | Creates a new note without initial content. |
DeleteNote | Deletes a note by its name and backup it. |
GetNoteList | Lists files and subfolders in a given folder. |
MoveOneNote | Move a note to another folder. |
GetNoteList | Lists files and subfolders in a given folder. |
FindAllFolderByName | Find all folders with the same name in the vault according to the folder name. |
CreateFolder | Delete a folder with folder name. |
GetNoteFrontmatter | Get a note frontmatter information |
AddFrontmatter | Add frontmatter information to a note |
GetNotetags | Add tags to a note |
| ... | ... |
🔗 References
📄 License
MIT License. Feel free to use, modify, and contribute!
Comments
New to MCP?
From what the protocol is to installing your first server, these answers cover most first questions.
An open protocol that defines how AI applications connect to external tools and data in a uniform way. Clients talk to the model; MCP servers provide tools, resources and prompt templates. They exchange standard messages, so one server can be reused by many clients.