IAMLEIzZ/ObsiMCP
If you are the rightful owner of ObsiMCP and would like to certify it and/or have it hosted online, please leave a comment on the right or send an email to henry@mcphub.com.
ObsiMCP is a lightweight, extendable MCP server designed to automate operations on Obsidian vaults, enhancing the management of personal knowledge bases.
ObsiMCP
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!
