What is Obsidian MCP Module?
The Obsidian MCP Module is a server designed to facilitate the reading and management of Obsidian vaults, allowing users to access their notes efficiently.
How to use Obsidian MCP Module?
To use the module, you need to set up a configuration file in your development environment (like VS Code or Claude Desktop) that specifies the MCP server settings and the path to your Obsidian vault.
Key features of Obsidian MCP Module?
search-notes: Enables searching notes by topic.get-note: Allows retrieval of note contents from the vault.
Use cases of Obsidian MCP Module?
- Searching for specific topics within a large collection of notes.
- Retrieving detailed content from notes for further processing or analysis.
- Integrating Obsidian notes with other development tools for enhanced productivity.
FAQ from Obsidian MCP Module?
- Can I use this module with any text editor?
The module is primarily designed for use with VS Code and Claude Desktop, which support MCP servers.
- Is there a license for this project?
Yes, the Obsidian MCP Module is licensed under the MIT License.
- What programming language is used in this project?
The project is developed using TypeScript.
Obsidian MCP Module
This module provides an MCP server for reading Obsidian vaults.
Currently both MCP tools and resources exist for accessing notes since some clients only support one or the other (VS Code only support tools).
Features
search-notes: Search notes by topicget-note: Retrieve note contents
Installation
The Obsidian Metadata Extractor plugin needs to be enabled in order to create the metadata.json file this MCP server uses.
VS Code
You'll need to add a .vscode/mcp.json file to your workspace. Or you can set it up so all workspaces have access: https://code.visualstudio.com/docs/copilot/chat/mcp-servers.
{
"servers": {
"obsidian-mcp": {
"type": "stdio",
"command": "deno",
"args": [
"run",
"--allow-read",
"${workspaceFolder}/main.ts",
"--vaultPath=/path/to/vault"
]
}
}
}
Claude Desktop
{
"mcpServers": {
"filesystem": {
"command": "/path/to/deno",
"args": [
"run",
"--allow-read",
"/path/to/main.ts",
"--vaultPath=/path/to/vault"
]
}
}
}
License
This project is licensed under the MIT License. See the LICENSE file for details.