Obsidian MCP REST Server
by PublikPrinciple
An MCP server implementation that provides access to Obsidian vaults through a local REST API. This server allows AI assistants to interact with Obsidian notes and manage vault content through a standardized interface.
Last updated: N/A
What is Obsidian MCP REST Server?
The Obsidian MCP REST Server is a local server that enables AI assistants to interact with your Obsidian vault through a REST API using the Model Context Protocol (MCP). It provides a standardized interface for reading, writing, and managing notes within your Obsidian vault.
How to use Obsidian MCP REST Server?
- Install Node.js and Obsidian with the Local REST API plugin. 2. Configure the Obsidian Local REST API plugin with an API key and port. 3. Create a
config.jsonfile with your API key, port, and host. 4. Install the server globally usingnpm install -g PublikPrinciple/obsidian-mcp-rest. 5. Start the server usingobsidian-mcp-rest --config path/to/config.json. 6. Configure your AI assistant (e.g., Claude Desktop) to use the server by providing the command and arguments.
Key features of Obsidian MCP REST Server
Access Obsidian vault contents through MCP
Read and write notes
List vault contents
Search functionality
Secure local REST API integration
Compatible with Claude Desktop and other AI assistants
Use cases of Obsidian MCP REST Server
Connecting Obsidian vaults to AI assistants like Claude Desktop
Automating note management tasks within Obsidian
Building custom integrations with Obsidian notes
Enabling AI-powered search and analysis of Obsidian content
FAQ from Obsidian MCP REST Server
What is MCP?
What is MCP?
MCP stands for Model Context Protocol. It's a protocol that allows AI models to interact with external data sources, in this case, an Obsidian vault.
Do I need to expose my Obsidian vault to the internet?
Do I need to expose my Obsidian vault to the internet?
No, the server runs locally and communicates through stdin/stdout, ensuring your data remains on your machine.
What security measures are in place?
What security measures are in place?
The server only runs locally, uses an API key for authentication with the Obsidian REST API, and doesn't require external network access.
What if I encounter installation issues?
What if I encounter installation issues?
Try cloning the repository and installing locally, or ensure TypeScript is installed globally.
How do I contribute to the project?
How do I contribute to the project?
Contributions are welcome! Please feel free to submit a Pull Request. For major changes, please open an issue first to discuss what you would like to change.