Obsidian MCP Module

by cconstable

223 downloads Not rated yet MIT license

GitHub

Knowledge Base

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

License: MIT license

Explore

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

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:

Download and install Highlight from highlightai.com/download
Navigate to the plugins tab and select "Add Custom Plugin"
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.
Enable "Start Automatically" if you want the plugin to start when Highlight launches

Setting up with Cursor

Open Cursor's settings
Navigate to the MCP section
Click "Add new Global MCP server"
Copy and paste the configuration below based on your operating system

JSON

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

JSON

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

JSON

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

Setting up with Claude Desktop

Open Claude Desktop's settings
Go to the Integrations tab
Click "Add MCP Server"
Use the configuration below based on your operating system

Note: Make sure Claude Desktop is running before attempting to connect.

JSON

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

JSON

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

JSON

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

Setting up with Windsurf

Open Windsurf's preferences
Go to the Integrations section
Click "Add MCP Integration"
Use the configuration below based on your operating system

JSON

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

JSON

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

JSON

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

Setting up with Cline

Open Cline's settings
Navigate to the Integrations section
Click "Add MCP Server"
Copy and paste the configuration below based on your operating system

Note: Make sure to restart Cline after adding the configuration.

JSON

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

JSON

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

JSON

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

Setting up with Goose

Open Goose's preferences
Go to the Integrations tab
Select "MCP Servers"
Click "Add New Server"
Use the configuration below based on your operating system

JSON

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

JSON

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

JSON

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

From the repository

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

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"
        ]
    }
}

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

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

Email sign in

No reviews posted yet.

About

Details

Explore

Setting up with Highlight

From the repository

Claude Desktop / Cursor

McpServers

Features

Installation

VS Code

Claude Desktop

License

More like this

Aws Kb Retrieval Server

Memory

Context 7

MaxKB