Obsidian MCP Server
by newtype-01
This project implements a Model Context Protocol (MCP) server for connecting AI models with Obsidian knowledge bases. It allows AI models to directly access and manipulate Obsidian notes, including reading, creating, updating, and deleting notes, as well as managing the folder structure.
Last updated: N/A
What is Obsidian MCP Server?
The Obsidian MCP Server is a bridge between AI models and Obsidian, enabling AI to interact with and manage your Obsidian vault using the Model Context Protocol.
How to use Obsidian MCP Server?
To use the server, you need to install Node.js, Obsidian, and the Obsidian Local REST API plugin. After cloning the repository and installing dependencies, configure the server with your vault path and API token via environment variables. Then, start the server using npm start or deploy it using Docker. Configure your MCP client to connect to the server.
Key features of Obsidian MCP Server
Seamless integration with Obsidian knowledge bases
Support for reading, creating, updating, and deleting notes
Support for creating, renaming, moving, and deleting folders
Full-text search functionality
Use cases of Obsidian MCP Server
Automated note-taking and summarization
AI-powered knowledge retrieval and question answering
Intelligent content generation and organization
Integration with AI assistants and chatbots
FAQ from Obsidian MCP Server
What is the Model Context Protocol (MCP)?
What is the Model Context Protocol (MCP)?
MCP is a standard protocol for AI models to interact with external data sources and tools.
What is the Obsidian Local REST API plugin?
What is the Obsidian Local REST API plugin?
This plugin exposes Obsidian's functionality through a REST API, allowing external applications to interact with your vault.
How do I find my Obsidian API token?
How do I find my Obsidian API token?
The API token is generated by the Obsidian Local REST API plugin. Refer to the plugin's documentation for instructions on how to generate and retrieve it.
What are the environment variables required to run the server?
What are the environment variables required to run the server?
The server requires OBSIDIAN_VAULT_PATH (the path to your Obsidian vault), OBSIDIAN_API_TOKEN (the API token from the Local REST API plugin), and OBSIDIAN_API_PORT (the port the Local REST API plugin is running on, defaults to 27123).
How do I deploy the server using Docker?
How do I deploy the server using Docker?
The README provides instructions for deploying the server using both Docker Compose and Docker commands. Make sure to configure the environment variables correctly and ensure the Docker container can access your Obsidian instance and vault.