Obsidian MCP Module

🚀 Obsidian MCP Module

This module provides an MCP server for reading Obsidian knowledge bases. It currently supports accessing notes through two different MCP tools and resources, as some clients only support one of them (e.g., VS Code only supports the tool).

🚀 Quick Start

The Obsidian MCP Module offers an MCP server to access your Obsidian knowledge base. It supports two different MCP tools and resources for note access.

✨ Features

• search-notes: Search for notes by topic.
• get-note: Retrieve the content of a note.

📦 Installation

To generate the metadata.json file used by this MCP server, you need to enable the Obsidian Metadata Extractor plugin.

VS Code

You need to add a .vscode/mcp.json file to your workspace. Alternatively, you can configure it to be accessible across all workspaces: 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. For more details, please refer to the LICENSE file.