MCP server for Obsidian (TypeScript + Bun)
A Model-Context-Protocol (MCP) server that lets Claude (or any MCP-compatible LLM) interact with your Obsidian vault through the Local REST API community plugin – written in TypeScript and runnable with bunx.
✨ Components
See Obsidian's Local REST API specifications for more details.
Example prompts
# Summarize the latest “architecture call” note
# (Claude will transparently call list_files_in_vault → get_file_contents)
Get the contents of the last “architecture call” note and summarize them.
# Find all mentions of Cosmos DB
Search for all files where “Azure CosmosDb” is mentioned and explain the context briefly.
# Create a summary note
Summarize yesterday’s meeting and save it as “summaries/2025-04-24-meeting.md”. Add a short intro suitable for e-mail.
⚙️ Configuration
Obsidian REST API key
There are two ways to pass the Obsidian API key to the server:
- Server config (recommended) – pass it via the
env field in your Claude (or other client) MCP-server declaration:
// claude_desktop_config.json
{
"mcpServers": {
"@fazer-ai/mcp-obsidian": {
"command": "bunx",
"args": ["@fazer-ai/mcp-obsidian@latest"],
"env": {
"OBSIDIAN_API_KEY": "your-obsidian-api-key"
}
}
}
}
[!NOTE]
Use @fazer-ai/mcp-obsidian@latest to ensure you always run the most up to date version of the server.
- Alternatively, you can use an
.env file. Place the key in the .env you created above. Note it must be placed in the working directory where the MCP server is running.
Environment variables
You can use the .env.example file as reference to create your own .env file.
OBSIDIAN_API_KEY= # Obtain this from the plugin settings in Obsidian
OBSIDIAN_PROTOCOL=http
OBSIDIAN_HOST=localhost
OBSIDIAN_PORT=27123 # Port the Local REST API plugin is bound to
🛠 Development
Running local version on Claude Desktop
After cloning this repo, you can update Claude's config to run your local version of the server instead of pulling from npm.
This is useful for quickly testing changes before publishing.
[!NOTE]
Keep in mind any changes you make on the code will only take effect after restarting the Claude Desktop app.
- Clone this repo and run
bun install to install dependencies.
- Update your
claude_desktop_config.json to point to your local version of the server:
// claude_desktop_config.json
{
"mcpServers": {
"@fazer-ai/mcp-obsidian": {
"command": "bun",
"args": ["/path/to/repo/src/index.ts"],
"env": {
"OBSIDIAN_API_KEY": "your-obsidian-api-key"
}
}
}
}
[!IMPORTANT]
Note we use bun instead of bunx here.
Debugging
MCP servers talk over stdio, so normal debuggers aren’t helpful.
Use the MCP Inspector:
npx @modelcontextprotocol/inspector bun /path/to/repo/src/index.ts
Open the URL it prints to step through requests (usually http://localhost:6274), inspect tool calls, and watch logs in real time.
📦 Publishing
- Update the version in
package.json.
- Create GitHub release.
- Run
bun publish.
License
MIT – see LICENSE.
