Obsidian Map Lite
What is Obsidian Map Lite
Obsidian-map-lite is a TypeScript-based MCP server designed for Obsidian, offering a straightforward interface to interact with Obsidian vaults.
Use cases
Use cases include automating note management, integrating Obsidian with other applications, and enhancing productivity by allowing programmatic access to notes and files.
How to use
To use obsidian-map-lite, install the necessary dependencies using ‘pnpm install’, build the server with ‘pnpm run build’, configure your API key and host in the .env file, and set it up in your application configuration.
Key features
Key features include listing files in the vault and directory, retrieving file contents, searching for specific texts within files, patching and appending content, and deleting files.
Where to use
Obsidian-map-lite can be used in personal knowledge management, note-taking applications, and any project that requires interaction with Obsidian vaults.
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 Obsidian Map Lite
Obsidian-map-lite is a TypeScript-based MCP server designed for Obsidian, offering a straightforward interface to interact with Obsidian vaults.
Use cases
Use cases include automating note management, integrating Obsidian with other applications, and enhancing productivity by allowing programmatic access to notes and files.
How to use
To use obsidian-map-lite, install the necessary dependencies using ‘pnpm install’, build the server with ‘pnpm run build’, configure your API key and host in the .env file, and set it up in your application configuration.
Key features
Key features include listing files in the vault and directory, retrieving file contents, searching for specific texts within files, patching and appending content, and deleting files.
Where to use
Obsidian-map-lite can be used in personal knowledge management, note-taking applications, and any project that requires interaction with Obsidian vaults.
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
Obsidian MCP Lite
A TypeScript-based MCP server for Obsidian, providing a simple interface to interact with Obsidian vaults.
Features
- List files in vault
- List files in directory
- Get file contents
- Search specific texts from files
- Patch content
- Append content
- Delete files
Prerequisites
- Node.js >= 18.16.0
- Obsidian with Local REST API plugin installed
- Obsidian API key
Setup
# Install dependencies
pnpm install
# Build server
pnpm run build
Configuration
-
Copy
.env.exampleto.env:cp .env.example .env -
Edit
.envand set your Obsidian API key and host:OBSIDIAN_API_KEY=your-api-key-here OBSIDIAN_HOST=http://localhost:27123
Installation
To use with Cursor, add the following config:
{
"mcpServers": {
"obsidian-mcp-lite": {
"command": "node",
"args": [
"/path/to/obsidian-mcp-lite/dist/index.js"
],
"env": {
"OBSIDIAN_API_KEY": "your-api-key-here"
}
}
}
}Debugging
Use the MCP Inspector:
npx @modelcontextprotocol/inspector -e OBSIDIAN_API_KEY=your-api-key-here node dist/index.js"
You will find a URL provided in the terminal. Open it and access to the debugging tool in the browser.
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.
