Which integrations are available for this server?

Integrates with the Obsidian Local REST API to read, create, and edit notes, perform file and directory operations within a vault, and execute advanced searches using Dataview DQL or JsonLogic.

How do I use Obsidian MCP Server?

1. Click on "Install Server". 2. Wait a few minutes for the server to deploy. Once ready, it will show a "Started" state. 3. In the chat, type @ followed by the MCP server name and your instructions, e.g., "@Obsidian MCP Server Find my notes about 'Project Mars' and summarize the main points." 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 modern Model Context Protocol (MCP) server that integrates with the Obsidian Local REST API to read, create, and edit notes effectively within Obsidian.

Features

This MCP server provides the following tools:

Vault File Operations

Tool	Description
`vault_get_file`	Get file content (raw markdown, JSON with metadata, or document map)
`vault_create_file`	Create or completely replace a file
`vault_append_to_file`	Append content to an existing or new file
`vault_patch_file`	Partially update a file (heading/block/frontmatter operations)
`vault_delete_file`	Delete a file from the vault

Directory Operations

Tool	Description
`vault_list`	List files and directories in the vault

Search Operations

Tool	Description
`search_simple`	Simple text search with context
`search_advanced`	Advanced search using Dataview DQL or JsonLogic

Prerequisites

Obsidian with the Local REST API plugin installed and enabled
Node.js v18 or higher
API Key from Obsidian's Local REST API settings

Quick Start

npm install npm run build npm run setup

The interactive setup wizard will guide you through:

Entering your Obsidian API Key
Selecting transport mode (stdio for Claude Desktop, HTTP for Open WebUI)
Configuring optional settings

After setup, start the server:

# For Open WebUI (HTTP mode) npm run start:http # For Claude Desktop (stdio mode) npm start

Installation

npm install npm run build

Configuration

Setup Wizard (Recommended)

Run the interactive setup wizard:

npm run setup

This creates a .env file with your configuration.

Manual Configuration

Alternatively, copy .env.example to .env and edit manually:

cp .env.example .env

Environment Variables

Variable	Description	Default
`OBSIDIAN_API_URL`	Obsidian REST API URL	`http://127.0.0.1:27123`
`OBSIDIAN_API_KEY`	API Key	(required)
`MCP_TRANSPORT`	`stdio` or `http`	`stdio`
`MCP_PORT`	Port for HTTP mode	`3000`
`DEBUG`	Enable debug logging	`false`

Usage with MCP Clients

Claude Desktop (stdio mode)

Add to your Claude Desktop configuration (claude_desktop_config.json):

{ "mcpServers": { "obsidian": { "command": "node", "args": ["/path/to/Obsidian_MCP/dist/index.js"], "env": { "OBSIDIAN_API_URL": "http://127.0.0.1:27123", "OBSIDIAN_API_KEY": "your-api-key-here" } } } }

Open WebUI (HTTP mode)

Start the server in HTTP mode:
npm run start:http
In Open WebUI, go to Admin Settings → Tools → MCP Servers
Add a new MCP server:
- Type: MCP Streamable HTTP
- URL: http://localhost:3000/mcp
- Auth: None (the server handles Obsidian auth internally)
Click Save

Startup Health Check

When the server starts, it automatically verifies the connection to Obsidian:

======================================== Obsidian MCP Server - Startup Check ======================================== API URL: http://127.0.0.1:27123 Debug Mode: disabled Checking connection to Obsidian REST API... ✓ Connected to Obsidian REST API ✓ Authenticated successfully Plugin Version: 3.4.2 Obsidian Version: 1.11.7

If there are connection issues, troubleshooting steps are displayed.

Debug Mode

Enable debug logging for verbose output:

DEBUG=true npm start

Shows detailed logs for API requests, tool calls, and HTTP connections.

Troubleshooting

Open WebUI Connection Failed

Verify server is running:
curl http://localhost:3000/health
Check configuration:
- URL: http://localhost:3000/mcp
- Auth: None (not Bearer)
- Type: MCP Streamable HTTP
Test the endpoint: The /mcp endpoint accepts POST requests with MCP protocol messages.

General Issues

Ensure Obsidian is running with Local REST API plugin enabled
Verify API key is correct
Try DEBUG=true npm start for detailed logs
Re-run setup: npm run setup

Tool Details

vault_get_file

Get file content with optional format:

markdown (default): Raw markdown content
json: Parsed note with metadata
document-map: Shows headings, blocks, frontmatter fields

vault_patch_file

Partial updates without rewriting entire file:

Operations: append, prepend, replace
Targets: headings, block references, frontmatter fields

search_advanced

Dataview DQL: TABLE FROM #tag WHERE field = value
JsonLogic: {"in": ["myTag", {"var": "tags"}]}

Development

# Build npm run build # Development with auto-rebuild npm run dev # stdio mode npm run dev:http # HTTP mode # Setup wizard npm run setup # Clean build artifacts npm run clean

License

MIT

Install Server

A

security – no known vulnerabilities

F

license - not found

A

quality - confirmed to work

How are these scores calculated?

Resources

Need Help?

Report Issue

Related Servers

Obsidian MCP Server

Obsidian MCP Server

Features

Vault File Operations

Directory Operations

Search Operations

Prerequisites

Quick Start

Installation

Configuration

Setup Wizard (Recommended)

Manual Configuration

Environment Variables

Usage with MCP Clients

Claude Desktop (stdio mode)

Open WebUI (HTTP mode)

Startup Health Check

Debug Mode

Troubleshooting

Open WebUI Connection Failed

General Issues

Tool Details

vault_get_file

vault_patch_file

search_advanced

Development

License

Resources

Tools

Latest Blog Posts

MCP directory API