MCP HubMCP Hub
StevenStavrakis

obsidian-mcp

by: StevenStavrakis

A simple MCP server for Obsidian

221created 22/12/2024
Visit
Obsidian

📌Overview

Purpose: To provide a server that allows AI assistants to interact seamlessly with Obsidian vaults for effective note management.

Overview: The Obsidian MCP Server is built on the Model Context Protocol (MCP), enabling functionalities for reading, creating, editing, and managing notes and tags within Obsidian vaults. It streamlines the integration of AI capabilities into users' note-taking workflows.

Key Features:

  • Read and Search Notes: Efficiently locate and access any notes within the vault, enhancing productivity.

  • Create and Edit Notes: Allows users to create new notes and modify existing ones, facilitating dynamic content management.

  • Tag Management: Users can add, remove, and rename tags, aiding in organized note categorization.

  • Move and Delete Notes: Provides flexibility in managing the organization of notes by moving or deleting as needed.

  • Manage Multiple Vaults: Features tools to list available vaults, supporting users with multiple Obsidian setups.


Obsidian MCP Server

An MCP (Model Context Protocol) server that enables AI assistants to interact with Obsidian vaults, providing tools for reading, creating, editing, and managing notes and tags.

Warning

This MCP has read and write access (if you allow it). Please backup your Obsidian vault prior to using obsidian-mcp to manage your notes. It is recommended to use git or any backup method of your choice.

Features

  • Read and search notes
  • Create, edit, move, and delete notes
  • Manage tags (add, remove, rename)
  • Search vault contents

Requirements

  • Node.js 20 or higher
  • An Obsidian vault

Installation

Manual Installation

Add to your Claude Desktop configuration:

  • macOS: ~/Library/Application Support/Claude/claude_desktop_config.json
  • Windows: %APPDATA%\Claude\claude_desktop_config.json

Example configuration:

{
    "mcpServers": {
        "obsidian": {
            "command": "npx",
            "args": ["-y", "obsidian-mcp", "/path/to/your/vault", "/path/to/your/vault2"]
        }
    }
}

Replace /path/to/your/vault with the absolute path to your Obsidian vault. Restart Claude for Desktop after saving the configuration to establish the connection.

Installation via Smithery

To install using Smithery:

npx -y @smithery/cli install obsidian-mcp --client claude

Development

To develop the server, clone the repository and install dependencies:

git clone https://github.com/StevenStavrakis/obsidian-mcp
cd obsidian-mcp
npm install
npm run build

Then add to your Claude Desktop configuration:

{
    "mcpServers": {
        "obsidian": {
            "command": "node",
            "args": ["<absolute-path-to-obsidian-mcp>/build/main.js", "/path/to/your/vault", "/path/to/your/vault2"]
        }
    }
}

Available Tools

  • read-note
  • create-note
  • edit-note
  • delete-note
  • move-note
  • create-directory
  • search-vault
  • add-tags
  • remove-tags
  • rename-tag
  • manage-tags
  • list-available-vaults

Documentation

Additional documentation can be found in the docs directory.

Security

Ensure you:

  • Provide access only to your intended vault directory
  • Review tool actions before approving them

Troubleshooting

Common issues include:

  1. Server not showing up in Claude Desktop:

    • Verify configuration file syntax
    • Ensure the vault path is absolute and exists
  2. Permission errors:

    • Ensure the vault path is readable/writable
  3. Tool execution failures:

    • Check Claude Desktop logs

License

MIT