Obsidian

Provides read/write MCP access to an Obsidian vault, enabling file discovery, reading, and updating of markdown notes.

typescript

24

GitHub Stars

typescript

Language

6 months ago

First Indexed

2 months ago

Catalog Refreshed

Documentation & install

Readme and setup notes from the catalogue, plus a client-ready config you can copy for your MCP host.

Installation

Add the following to your MCP client configuration file.

Configuration

View docs

{
  "mcpServers": {
    "marcelmarais-obsidian-mcp-server": {
      "command": "node",
      "args": [
        "obsidian-mcp-server/build/index.js",
        "/path/to/your/vault"
      ]
    }
  }
}

Obsidian MCP Server is a lightweight MCP endpoint that lets AI assistants read from and write to your Obsidian vault. It enables practical workflows by exposing file discovery, content retrieval, and write capabilities directly through the MCP protocol, so your favorite AI assistants can interact with your notes and TODOs without opening Obsidian.

How to use

You run the Obsidian MCP Server locally and connect your MCP client to it. The server exposes a small set of capabilities, including discovering files, fetching file contents, listing open TODOs, and updating file content. You can combine these actions to guide AI assistants to read what you have and modify notes or create new content in your vault.

Key capabilities you can use through the MCP client include: reading a list of all filenames, reading contents of multiple files, retrieving open todos, and updating a file with new markdown content. When you request a read, the server returns the relevant markdown content with clear file markers to identify where each piece of content came from. When you request updates, the server creates any missing directories and files as needed.

How to install

Prerequisites you need installed on your system: Node.js and npm.

Install dependencies and build the MCP server.

npm install obsidian-mcp-server
npm run build

Additional notes

To run the server locally, you will execute a Node command that starts the MCP server and points it at your Obsidian vault path. The final start command is shown below in the run example.

node obsidian-mcp-server/build/index.js /path/to/your/vault

Available tools

getAllFilenames

Gets a list of all filenames in the Obsidian vault to discover available files.

readMultipleFiles

Retrieves the contents of specified files, supporting exact, partial, or case-insensitive matches. Each file content is prepended with a header indicating the filename.

getOpenTodos

Retrieves all open TODO items from markdown files by locating unchecked checkboxes and reporting their locations.

updateFileContent

Updates the content of a specified file with new markdown content, creating directories and the file if needed.