Provides seamless integration with Obsidian vaults via direct filesystem access, enabling creation, retrieval, modification, and deletion of notes and folders, as well as advanced search capabilities within the knowledge base.
Click on "Install Server".
Wait a few minutes for the server to deploy. Once ready, it will show a "Started" state.
In the chat, type
@followed by the MCP server name and your instructions, e.g., "@Obsidian MCP ServerFind notes tagged with #research and summarize the most recent one"
That's it! The server will respond to your query, and you can continue using it as needed.
Here is a step-by-step guide with screenshots.
Obsidian MCP Server
A Model Context Protocol (MCP) server that provides seamless integration with Obsidian vaults via direct filesystem access, enabling AI assistants to interact with your notes and knowledge base.
Features
Note Management: Create, read, update, and delete notes
Folder Operations: Create, rename, move, and delete folders
Vault Search: Search with glob patterns, regex, tags, frontmatter, and relevance scoring
Intelligent Caching: Multi-layer caching with optional LMDB persistence
Real-Time Monitoring: File watching for automatic cache invalidation
Quick Start
Installation
npm install
npm run buildConfiguration
Add to your MCP client configuration:
{
"mcpServers": {
"obsidian": {
"command": "node",
"args": ["/path/to/obsidian-mcp/build/index.js"],
"env": {
"OBSIDIAN_VAULT_PATH": "/path/to/your/vault"
}
}
}
}See Configuration Reference for all options.
Available Tools
Tool | Description |
List all notes in the vault | |
Read the content of a note | |
Create a new note | |
Update an existing note | |
Delete a note | |
Get frontmatter and tags | |
Search with required query | |
Advanced search with all options | |
Streaming search for large vaults | |
Create, rename, move, or delete folders | |
Get cache performance statistics |
See Tools Reference for detailed documentation.
Architecture
flowchart TB
subgraph tools [MCP Tools]
T1[search_vault]
T2[read_note]
T3[list_notes]
end
subgraph caching [Caching Layer]
FC[FileListCache]
CC[ContentCache]
SC[SearchResultCache]
PC[PersistentCache]
end
subgraph optimization [Search Optimization]
II[InvertedIndex]
PT[PathTrie]
end
subgraph fs [Filesystem]
V[(Obsidian Vault)]
FW[FileWatcher]
end
T1 --> SC
T1 --> II
T1 --> PT
T2 --> CC
T3 --> FC
CC --> PC
FC --> PC
SC --> PC
FW --> FC
FW --> CC
FW --> II
V --> FWSee Features Reference for detailed architecture documentation.
Performance Features
Feature | Description | Default |
Cache folder listings | 60s TTL | |
LRU cache for file contents | 100 entries | |
Cache search query results | 50 entries | |
LMDB-backed persistence | Enabled | |
Fast word-to-files lookup | Enabled | |
Efficient glob pattern matching | Enabled | |
Real-time cache invalidation | Enabled | |
Pre-load cache on startup | Disabled |
Configuration Quick Reference
Variable | Default | Description |
| Required | Path to your Obsidian vault |
|
| Enable LMDB persistence |
|
| Enable fast text search index |
|
| Enable fast glob matching |
|
| Pre-load cache on startup |
See Configuration Reference for all environment variables.
Development
# Build
npm run build
# Development mode
npm run dev
# Run tests
npm testProject Structure
src/
├── config/ # Configuration management
├── handlers/ # MCP request handlers
├── services/
│ ├── cache/ # Caching services
│ ├── search/ # Search optimization services
│ ├── fileSystem.ts # Core filesystem operations
│ ├── FileWatcher.ts # File change monitoring
│ └── FrontmatterParser.ts # YAML frontmatter parsing
├── types/ # TypeScript type definitions
├── index.ts # Entry point
└── server.ts # Main server classDocumentation
Tools Reference - All available MCP tools
Features Reference - Internal features and architecture
Configuration Reference - All environment variables
Security
Operations are restricted to the configured vault path
Path traversal protection is implemented
Consider running in a sandboxed environment for production use
Contributing
Fork the repository
Create a feature branch
Make your changes
Add tests if applicable
Submit a pull request
This server cannot be installed
Resources
Unclaimed servers have limited discoverability.
Looking for Admin?
If you are the server author, to access and configure the admin panel.