https://github.com/markuspfundstein/mcp-obsidian
MCP server that interacts with Obsidian via the Obsidian rest API community plugin
https://github.com/markuspfundstein/mcp-obsidian
Last synced: 6 months ago
JSON representation
MCP server that interacts with Obsidian via the Obsidian rest API community plugin
- Host: GitHub
- URL: https://github.com/markuspfundstein/mcp-obsidian
- Owner: MarkusPfundstein
- License: mit
- Created: 2024-11-29T11:07:12.000Z (11 months ago)
- Default Branch: main
- Last Pushed: 2025-04-01T19:32:22.000Z (6 months ago)
- Last Synced: 2025-04-02T04:05:33.232Z (6 months ago)
- Language: Python
- Size: 66.4 KB
- Stars: 485
- Watchers: 8
- Forks: 41
- Open Issues: 13
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# MCP server for Obsidian
MCP server to interact with Obsidian via the Local REST API community plugin.
## Components
### Tools
The server implements multiple tools to interact with Obsidian:
- list_files_in_vault: Lists all files and directories in the root directory of your Obsidian vault
- list_files_in_dir: Lists all files and directories in a specific Obsidian directory
- get_file_contents: Return the content of a single file in your vault.
- search: Search for documents matching a specified text query across all files in the vault
- patch_content: Insert content into an existing note relative to a heading, block reference, or frontmatter field.
- append_content: Append content to a new or existing file in the vault.
- delete_file: Delete a file or directory from your vault.
### Example prompts
Its good to first instruct Claude to use Obsidian. Then it will always call the tool.
The use prompts like this:
- Get the contents of the last architecture call note and summarize them
- Search for all files where Azure CosmosDb is mentioned and quickly explain to me the context in which it is mentioned
- Summarize the last meeting notes and put them into a new note 'summary meeting.md'. Add an introduction so that I can send it via email.
## Configuration
### Obsidian REST API Key
There are two ways to configure the environment with the Obsidian REST API Key.
1. Add to server config (preferred)
```json
{
"mcp-obsidian": {
"command": "uvx",
"args": [
"mcp-obsidian"
],
"env": {
"OBSIDIAN_API_KEY":""
}
}
}
```
2. Create a `.env` file in the working directory with the following required variable:
```
OBSIDIAN_API_KEY=your_api_key_here
```
Note: You can find the key in the Obsidian plugin config.
## Quickstart
### Install
#### Obsidian REST API
You need the Obsidian REST API community plugin running: https://github.com/coddingtonbear/obsidian-local-rest-api
Install and enable it in the settings and copy the api key.
#### Claude Desktop
On MacOS: `~/Library/Application\ Support/Claude/claude_desktop_config.json`
On Windows: `%APPDATA%/Claude/claude_desktop_config.json`
Development/Unpublished Servers Configuration
```json
{
"mcpServers": {
"mcp-obsidian": {
"command": "uv",
"args": [
"--directory",
"/mcp-obsidian",
"run",
"mcp-obsidian"
]
}
}
}
```
Published Servers Configuration
```json
{
"mcpServers": {
"mcp-obsidian": {
"command": "uvx",
"args": [
"mcp-obsidian"
],
"env": {
"OBSIDIAN_API_KEY" : ""
}
}
}
}
```
## Development
### Building
To prepare the package for distribution:
1. Sync dependencies and update lockfile:
```bash
uv sync
```
### Debugging
Since MCP servers run over stdio, debugging can be challenging. For the best debugging
experience, we strongly recommend using the [MCP Inspector](https://github.com/modelcontextprotocol/inspector).
You can launch the MCP Inspector via [`npm`](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm) with this command:
```bash
npx @modelcontextprotocol/inspector uv --directory /path/to/mcp-obsidian run mcp-obsidian
```
Upon launching, the Inspector will display a URL that you can access in your browser to begin debugging.
You can also watch the server logs with this command:
```bash
tail -n 20 -f ~/Library/Logs/Claude/mcp-server-mcp-obsidian.log
```