Obsidian Mcp

by orvice

389 downloads Not rated yet
GitHub

About

# obsidian-mcp A Model Context Protocol (MCP) server for Obsidian, written in Go. ## Features - Interact with Obsidian through the MCP protocol - Support for Obsidian REST API - Provides tools and prompts functionality - Supports both stdio and SSE server modes ## Prerequisites This MCP server requires the [Obsidian…

Explore

- Interact with Obsidian through the MCP protocol
- Support for Obsidian REST API
- Provides tools and prompts functionality
- Supports both stdio and SSE server modes

Setting up with Highlight

This MCP is not yet compatible with Highlight’s one-click setup. However, you can still use it with Highlight by following these steps:

  1. Download and install Highlight from highlightai.com/download
  2. Navigate to the plugins tab and select "Add Custom Plugin"
  3. Configure the plugin with the settings below
    Plugin Name Obsidian Mcp
    Command (node, npx, python, etc.)

    Please refer to the README for specific instructions on how to obtain API keys or other required environment variables.

  4. Enable "Start Automatically" if you want the plugin to start when Highlight launches

From the repository

This MCP server requires the Obsidian Local REST API plugin to be installed and enabled in Obsidian. This plugin provides a secure HTTPS interface that allows external tools to interact with your Obsidian notes through a REST API.

go install github.com/orvice/obsidian-mcp/cmd/obsidian-mcp@latest

- OBSIDIAN_BASE_URL: Base URL for Obsidian REST API
- OBSIDIAN_API_KEY: API key for Obsidian REST API
- SSE_SERVER: Set to "true" to enable SSE server mode (optional)

Add to ~/Library/Application Support/Claude/claude_desktop_config.json:

{
  "mcpServers": {
    "obsidian-mcp": {
      "command": "obsidian-mcp",
      "env": {
        "OBSIDIAN_BASE_URL": "http://localhost:27123",
        "OBSIDIAN_API_KEY": "your-obsidian-api-key"
      }
    }
  }
}

Add to ~/.continue/config.json:

{
  "experimental": {
    "modelContextProtocol": true
  },
  "mcpServers": {
    "obsidian-mcp": {
      "command": "obsidian-mcp",
      "args": [],
      "env": {
        "OBSIDIAN_BASE_URL": "http://localhost:27123",
        "OBSIDIAN_API_KEY": "your-obsidian-api-key"
      }
    }
  }
}

Claude Desktop / Cursor

Paste into your MCP client config file to install this server.

{
    "mcpServers": {
        "obsidian mcp": {
            "modelContextProtocol": true
        }
    }
}

Experimental

{
    "modelContextProtocol": true
}

McpServers

{
    "obsidian-mcp": {
        "command": "obsidian-mcp",
        "args": [],
        "env": {
            "OBSIDIAN_BASE_URL": "http://localhost:27123",
            "OBSIDIAN_API_KEY": "your-obsidian-api-key"
        }
    }
}

A Model Context Protocol (MCP) server for Obsidian, written in Go.

Features

- Interact with Obsidian through the MCP protocol
- Support for Obsidian REST API
- Provides tools and prompts functionality
- Supports both stdio and SSE server modes

Prerequisites

This MCP server requires the Obsidian Local REST API plugin to be installed and enabled in Obsidian. This plugin provides a secure HTTPS interface that allows external tools to interact with your Obsidian notes through a REST API.

Installation

Using go install

go install github.com/orvice/obsidian-mcp/cmd/obsidian-mcp@latest

Build from source

git clone https://github.com/orvice/obsidian-mcp.git
cd obsidian-mcp
go build -o obsidian-mcp ./cmd/obsidian-mcp

Configuration

Environment Variables

- OBSIDIAN_BASE_URL: Base URL for Obsidian REST API
- OBSIDIAN_API_KEY: API key for Obsidian REST API
- SSE_SERVER: Set to "true" to enable SSE server mode (optional)

MCP Configuration Examples

Claude Desktop Configuration

Add to ~/Library/Application Support/Claude/claude_desktop_config.json:

{
  "mcpServers": {
    "obsidian-mcp": {
      "command": "obsidian-mcp",
      "env": {
        "OBSIDIAN_BASE_URL": "http://localhost:27123",
        "OBSIDIAN_API_KEY": "your-obsidian-api-key"
      }
    }
  }
}
Continue Configuration

Add to ~/.continue/config.json:

{
  "experimental": {
    "modelContextProtocol": true
  },
  "mcpServers": {
    "obsidian-mcp": {
      "command": "obsidian-mcp",
      "args": [],
      "env": {
        "OBSIDIAN_BASE_URL": "http://localhost:27123",
        "OBSIDIAN_API_KEY": "your-obsidian-api-key"
      }
    }
  }
}

Usage

1. Ensure Obsidian is installed with the REST API plugin enabled
2. Obtain an API key and configure environment variables
3. Start the MCP server
4. Use in MCP-compatible clients (such as Claude Desktop)

Development

```bash

No reviews yet — be the first

Sign in to leave a review

Use Google, GitHub, or an email account so ratings stay tied to real people.

Email sign in

No reviews posted yet.