Obsidian

Ruby-based MCP server that interfaces with Obsidian vaults to search, read, list, and analyze notes along with vault statistics and tag analytics.

other

5

GitHub Stars

other

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": {
    "ihoka-obsidian-mcp-server": {
      "command": "ruby",
      "args": [
        "/path/to/obsidian-mcp-server/obsidian_server.rb"
      ],
      "env": {
        "OBSIDIAN_VAULT_PATH": "/path/to/your/obsidian/vault"
      }
    }
  }
}

You run a Ruby-based MCP server that lets you search, read, and analyze your Obsidian vault notes. It exposes practical tools to browse notes, filter by tags, and view vault-wide statistics, making it easy for AI models or CLIs to interact with your notes.

How to use

Start the MCP server as described by the provided runtime example. Once the server is running, connect your MCP client to the local process to issue tool calls such as searching notes, reading a note, listing all notes, or filtering by tags. You can also request vault statistics and tag cloud insights to gain a deeper understanding of your vault.

Key capabilities you can use through an MCP client include: searching notes by content, title, or tags; reading full note content including frontmatter and links; listing all notes with metadata; filtering notes by tags; retrieving vault statistics; and generating a tag cloud for usage patterns.

How to install

Prerequisites: you need Ruby and Bundler installed, plus a vault ready for Obsidian.

git clone <repository-url>
cd obsidian-mcp-server
bundle install

export OBSIDIAN_VAULT_PATH="/path/to/your/obsidian/vault"

Additional setup notes

You can test the server with the MCP inspector and run the server through a local Ruby command. The inspector can connect to the server by pointing it at the server executable.

# Inspector test
npx @modelcontextprotocol/inspector ./obsidian_server.rb

Available tools

Search Notes

Search for notes by query text in titles, tags, or content across the vault.

Read Note

Read the full content of a specific note by filename or title, including frontmatter and links.

List Notes

List all notes in the vault with basic metadata for quick browsing.

Find by Tags

Filter notes by specific tags with flexible matching options.

Vault Statistics

Compute and return comprehensive metrics about your vault, such as total notes, word counts, and tag usage.