Obsidian MCP Module

by cconstable

223 downloads
Not rated
GitHub

About

Obsidian MCP Module is an MCP server for reading Obsidian vaults. It provides both MCP tools and resources for accessing notes, since some clients only support one or the other.

Details

Author
cconstable
Downloads
223
Categories
Knowledge Base

- search-notes: Search notes by topic
- get-note: Retrieve note contents
- Supports both MCP tools and resources
- Works with VS Code and Claude Desktop
- Read-only access to vault files

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 Module
    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

Enable the Obsidian Metadata Extractor plugin to create the required metadata.json file. Configure the server in your MCP client (VS Code or Claude Desktop) using the deno runtime, pointing to your vault path.

Claude Desktop / Cursor

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

{
    "mcpServers": {
        "obsidian mcp module": {
            "filesystem": {
                "command": "/path/to/deno",
                "args": [
                    "run",
                    "--allow-read",
                    "/path/to/main.ts",
                    "--vaultPath=/path/to/vault"
                ]
            }
        }
    }
}

McpServers

{
    "filesystem": {
        "command": "/path/to/deno",
        "args": [
            "run",
            "--allow-read",
            "/path/to/main.ts",
            "--vaultPath=/path/to/vault"
        ]
    }
}

Obsidian MCP Module

This module provides an MCP server for reading Obsidian vaults.

Currently both MCP tools and resources exist for accessing notes since some clients only support one or the other (VS Code only support tools).

Features

- search-notes: Search notes by topic - get-note: Retrieve note contents

Installation

The Obsidian Metadata Extractor plugin needs to be enabled in order to create the metadata.json file this MCP server uses.

VS Code

You'll need to add a .vscode/mcp.json file to your workspace. Or you can set it up so all workspaces have access: https://code.visualstudio.com/docs/copilot/chat/mcp-servers.

{
    "servers": {
        "obsidian-mcp": {
            "type": "stdio",
            "command": "deno",
            "args": [
                "run",
                "--allow-read",
                "${workspaceFolder}/main.ts",
                "--vaultPath=/path/to/vault"
            ]
        }
    }
}

Claude Desktop

{
    "mcpServers": {
      "filesystem": {
        "command": "/path/to/deno",
        "args": [
            "run",
            "--allow-read",
            "/path/to/main.ts",
            "--vaultPath=/path/to/vault"
        ]
      }
    }
  }

License

This project is licensed under the MIT License. See the LICENSE file for details.

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.