Easy Obsidian Mcp
What is Easy Obsidian Mcp
Easy Obsidian MCP is a simple server designed to facilitate interaction with the Obsidian application through its Local REST API plugin. It aims to provide a user-friendly experience even for non-technical users by allowing them to set up the server quickly and efficiently.
Use cases
The server enables users to perform a variety of tasks within their Obsidian vault. Primarily, it can be used for searching notes and utilizing Dataview query language (DQL) to execute more complex queries on the vault’s content.
How to use
To use Easy Obsidian MCP, first ensure you have Node.js, npm, and Obsidian with the Local REST API plugin installed. After setting up the plugin and obtaining the API Key, you can install the server by running ‘npx create-easy-obsidian-mcp’ in your terminal and follow the setup instructions provided.
Key features
Key features include the ability to search for notes in the vault and to execute queries using Dataview query language. Additionally, it offers easy installation and setup, along with debugging support through the MCP Inspector for troubleshooting.
Where to use
This tool is particularly useful for individuals who utilize Obsidian for note-taking and knowledge management, especially those wanting to automate searches or conduct queries efficiently within their notes.
Clients Supporting MCP
The following are the main client software that supports the Model Context Protocol. Click the link to visit the official website for more information.
Overview
What is Easy Obsidian Mcp
Easy Obsidian MCP is a simple server designed to facilitate interaction with the Obsidian application through its Local REST API plugin. It aims to provide a user-friendly experience even for non-technical users by allowing them to set up the server quickly and efficiently.
Use cases
The server enables users to perform a variety of tasks within their Obsidian vault. Primarily, it can be used for searching notes and utilizing Dataview query language (DQL) to execute more complex queries on the vault’s content.
How to use
To use Easy Obsidian MCP, first ensure you have Node.js, npm, and Obsidian with the Local REST API plugin installed. After setting up the plugin and obtaining the API Key, you can install the server by running ‘npx create-easy-obsidian-mcp’ in your terminal and follow the setup instructions provided.
Key features
Key features include the ability to search for notes in the vault and to execute queries using Dataview query language. Additionally, it offers easy installation and setup, along with debugging support through the MCP Inspector for troubleshooting.
Where to use
This tool is particularly useful for individuals who utilize Obsidian for note-taking and knowledge management, especially those wanting to automate searches or conduct queries efficiently within their notes.
Clients Supporting MCP
The following are the main client software that supports the Model Context Protocol. Click the link to visit the official website for more information.
Content
easy-obsidian-mcp
https://github.com/user-attachments/assets/99b16c89-24bf-4991-af65-68d21554b438
A simple MCP server to interact with Obsidian via its Local REST API plugin.
and can be installed in one line, even for non technical users.
Features
Provides tools to interact with your Obsidian vault, allowing you to:
- Search notes
- Search notes using Dataview query language (DQL)
Installation & Setup
Prerequisites
- Node.js and npm: Make sure you have Node.js (which includes npm) installed. You can download it from nodejs.org.
- Obsidian: You need the Obsidian app installed.
- Obsidian Local REST API Plugin:
- Open Obsidian.
- Go to
Settings->Community plugins. - Make sure
Restricted modeis off. - Click
Browseand search forLocal REST API. - Install and enable the plugin.
- Go to the plugin’s settings (Obsidian Settings -> Local REST API).
- Copy the
API Keyshown there. You’ll need it soon.
Setting up the Server
npx create-easy-obsidian-mcp
Follow the instructions to setup the server.
Example Prompts
Try prompts like:
- “list the files in my obsidian vault”
- “search my obsidian notes for ‘artificial intelligence’”
- find my last 5 notes
Debugging
Use the MCP Inspector for easier debugging:
npx @modelcontextprotocol/inspector node ./dist/index.js --apiKey <your-api-key>
Dev Tools Supporting MCP
The following are the main code editors that support the Model Context Protocol. Click the link to visit the official website for more information.
